mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: more consistent formatting for deprecated items
- 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:
@ -89,7 +89,7 @@ public:
|
||||
NEW, //!< Create a new set and ADD elemets to it
|
||||
REMOVE, //!< Remove the set (from the file system)
|
||||
LIST, //!< Print contents of the set
|
||||
DELETE = SUBTRACT, //!< \deprecated alias for SUBTRACT (OCT-2018)
|
||||
DELETE = SUBTRACT, //!< \deprecated(2018-10) Alias for SUBTRACT
|
||||
};
|
||||
|
||||
//- The setActions text representations
|
||||
@ -175,8 +175,8 @@ public:
|
||||
|
||||
// Static Functions
|
||||
|
||||
//- Convert string to action
|
||||
// \deprecated use direct access to actionNames (JUL-2018)
|
||||
//- Deprecated(2018-07) convert string to action
|
||||
// \deprecated(2018-07) - use actionNames[] directly
|
||||
static setAction toAction(const word& actionName)
|
||||
{
|
||||
return actionNames[actionName];
|
||||
|
||||
@ -341,10 +341,6 @@ public:
|
||||
//- Subtract elements present in set.
|
||||
virtual void subtractSet(const topoSet& set);
|
||||
|
||||
//- Subtract elements present in set.
|
||||
// \deprecated use subtractSet instead (OCT-2018)
|
||||
virtual void deleteSet(const topoSet& set);
|
||||
|
||||
//- Sync set across coupled patches.
|
||||
virtual void sync(const polyMesh& mesh);
|
||||
|
||||
@ -390,11 +386,17 @@ public:
|
||||
static void removeFiles(const polyMesh&);
|
||||
|
||||
|
||||
// Member operators
|
||||
// Member Operators
|
||||
|
||||
//- Copy labelHashSet part only
|
||||
void operator=(const topoSet&);
|
||||
|
||||
|
||||
// Housekeeping
|
||||
|
||||
//- Deprecated(2018-10) subtract elements present in set.
|
||||
// \deprecated(2018-10) - use subtractSet instead
|
||||
virtual void deleteSet(const topoSet& set);
|
||||
};
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user