zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: more consistent formatting for deprecated items

Browse Source 
- Start brief descriptions with 'Deprecated(YYYY-MM)' so that it is
  readily visible in the short method description. Consistent date
  format (YYYY-MM), placed immediately after the \deprecated tag.
This commit is contained in:
Mark Olesen
2018-11-11 17:17:33 +01:00
parent 91cfe4c271
commit ffec4c6fa7
27 changed files with 139 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H
View File

@ -198,16 +198,16 @@ public:
// Housekeeping
//- Same as findObject
// \deprecated use findObject (OCT-2018)
//- Deprecated(2018-10)
// \deprecated(2018-10) - use findObject() method
template<class ObjectType>
const ObjectType* lookupObjectPtr(const word& fieldName) const
{
return this->cfindObject<ObjectType>(fieldName);
}
//- Same as getObjectPtr
// \deprecated use getObjectPtr (OCT-2018)
//- Deprecated(2018-10)
// \deprecated(2018-10) - use getObjectPtr() method
template<class ObjectType>
ObjectType* lookupObjectRefPtr(const word& fieldName) const
{