Rationalized Doxygen documentation of command-line options

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

View File

@ -52,21 +52,21 @@ Description
Replacement entries starting with '~' will remove the entry.
Usage
\b changeDictionary [OPTION]
changeDictionary [OPTION]
Options:
- \par -subDict
Specify the subDict name of the replacements dictionary.
\param -subDict \n
Specify the subDict name of the replacements dictionary.
- \par -literalRE
Do not interpret regular expressions or patchGroups; treat them as any
other keyword.
\param -literalRE \n
Do not interpret regular expressions or patchGroups; treat them as any
other keyword.
- \par -enableFunctionEntries
Enable function entries (default: disabled)
\param -enableFunctionEntries \n
Enable function entries (default: disabled)
\param -disablePatchGroups \n
Disable the default checking for keys being patchGroups
- \par -disablePatchGroups
Disable the default checking for keys being patchGroups
\*---------------------------------------------------------------------------*/

View File

@ -28,14 +28,14 @@ Description
Tool to upgrade mesh and fields for split cyclics.
Usage
\b foamUpgradeCyclics [OPTION]
- foamUpgradeCyclics [OPTION]
Options:
- \par -test
Suppress writing the updated files with split cyclics
\param -test \n
Suppress writing the updated files with split cyclics
\param -enableFunctionEntries \n
By default all dictionary preprocessing of fields is disabled
- \par -enableFunctionEntries
By default all dictionary preprocessing of fields is disabled
\*---------------------------------------------------------------------------*/