Rationalized Doxygen documentation of command-line options

2016-06-17 09:11:58 +01:00
parent 0b333a4249
commit 7b75d81269
28 changed files with 389 additions and 360 deletions
--- a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
+++ b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
@ -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

 \*---------------------------------------------------------------------------*/