DOC: Updated header documentation

This commit is contained in:
Andrew Heather
2018-12-06 23:09:10 +00:00
parent a16fd1fa9e
commit 0b5f681fb9
4 changed files with 20 additions and 21 deletions

View File

@ -28,6 +28,7 @@ Description
A topoSetCellSource to select cells belonging to a topological connected
region (that contains given points)
Usage
In dictionary input:
\verbatim
// optional name of cellSet delimiting search
@ -41,7 +42,7 @@ Description
insidePoints ((1 2 3));
\endverbatim
\heading Dictionary parameters
Dictionary parameters:
\table
Property | Description | Required | Default
insidePoints | Points inside regions | yes |
@ -68,7 +69,7 @@ namespace Foam
class regionSplit;
/*---------------------------------------------------------------------------*\
Class regionToCell Declaration
Class regionToCell Declaration
\*---------------------------------------------------------------------------*/
class regionToCell
@ -151,7 +152,6 @@ public:
const topoSetSource::setAction action,
topoSet& set
) const;
};