Rationalized Doxygen documentation of command-line options

This commit is contained in:
Henry Weller
2016-06-17 09:11:58 +01:00
parent b33932e1f6
commit 1319df48d9
28 changed files with 389 additions and 360 deletions

View File

@ -1,3 +1,3 @@
blockMeshApp.C
blockMesh.C
EXE = $(FOAM_APPBIN)/blockMesh

View File

@ -28,23 +28,23 @@ Description
A multi-block mesh generator.
Uses the block mesh description found in
\a system/blockMeshDict
or \a system/\<region\>/blockMeshDict
or \a constant/polyMesh/blockMeshDict
or \a constant/\<region\>/polyMesh/blockMeshDict
- \c system/blockMeshDict
- \c system/\<region\>/blockMeshDict
- \c constant/polyMesh/blockMeshDict
- \c constant/\<region\>/polyMesh/blockMeshDict
Usage
\b blockMesh [OPTION]
- blockMesh [OPTION]
Options:
- \par -blockTopology
Write the topology as a set of edges in OBJ format.
\param -blockTopology \n
Write the topology as a set of edges in OBJ format.
- \par -region \<name\>
Specify an alternative mesh region.
\param -region \<name\> \n
Specify an alternative mesh region.
\param -dict \<filename\> \n
Specify alternative dictionary for the block mesh description.
- \par -dict \<filename\>
Specify alternative dictionary for the block mesh description.
\*---------------------------------------------------------------------------*/