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

@ -29,28 +29,28 @@ Description
An Ensight part is created for each cellZone and patch.
Usage
- foamToEnsightParts [OPTION] \n
Translates OpenFOAM data to Ensight format
\b foamToEnsightParts [OPTION]
\param -ascii \n
Write Ensight data in ASCII format instead of "C Binary"
Options:
- \par -ascii
Write Ensight data in ASCII format instead of "C Binary"
\param -name \<subdir\>\n
define sub-directory name to use for Ensight data (default: "Ensight")
- \par -name \<subdir\>
Define sub-directory name to use for Ensight data (default: "Ensight")
\param -noZero \n
Exclude the often incomplete initial conditions.
- \par -noZero
Exclude the often incomplete initial conditions.
\param -index \<start\>\n
Ignore the time index contained in the time file and use a
simple indexing when creating the \c Ensight/data/######## files.
- \par -index \<start\>
Ignore the time index contained in the time file and use a
simple indexing when creating the \c Ensight/data/######## files.
\param -noMesh \n
Suppress writing the geometry. Can be useful for converting partial
results for a static geometry.
- \par -noMesh
Suppress writing the geometry. Can be useful for converting partial
results for a static geometry.
\param -width \<n\>\n
width of Ensight data subdir
- \par -width \<n\>
Width of Ensight data subdir
Note
- no parallel data.