Rationalized Doxygen documentation of command-line options

applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C

@@ -30,24 +30,24 @@ Description
     An Ensight part is created for the internalMesh and for each patch.
 
 Usage
-    - foamToEnsight [OPTION] \n
-    Translates OpenFOAM data to Ensight format
+    \b foamToEnsight [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 -patches patchList \n
-    Specify particular patches to write.
-    Specifying an empty list suppresses writing the internalMesh.
+      - \par -patches patchList
+        Specify particular patches to write.
+        Specifying an empty list suppresses writing the internalMesh.
 
-    \param -noPatches \n
-    Suppress writing any patches.
+      - \par -noPatches
+        Suppress writing any patches.
 
-    \param -faceZones zoneList \n
-    Specify faceZones to write, with wildcards
+      - \par -faceZones zoneList
+        Specify faceZones to write, with wildcards
 
-    \param -cellZone zoneName \n
-    Specify single cellZone to write (not lagrangian)
+      - \par -cellZone zoneName
+        Specify single cellZone to write (not lagrangian)
 
 Note
     Parallel support for cloud data is not supported

applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C

@@ -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.

applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C

@@ -28,44 +28,45 @@ Description
     Tecplot binary file format writer.
 
 Usage
+    \b foamToTecplot360 [OPTION]
 
-    - foamToTecplot360 [OPTION]
+    Options:
+      - \par -fields \<names\>
+        Convert selected fields only. For example,
+        \verbatim
+          -fields '( p T U )'
+        \endverbatim
+        The quoting is required to avoid shell expansions and to pass the
+        information as a single argument.
 
-    \param -fields \<names\>\n
-    Convert selected fields only. For example,
-    \verbatim
-         -fields '( p T U )'
-    \endverbatim
-    The quoting is required to avoid shell expansions and to pass the
-    information as a single argument.
+      - \par -cellSet \<name\>
 
-    \param -cellSet \<name\>\n
-    \param -faceSet \<name\>\n
-    Restrict conversion to the cellSet, faceSet.
+      - \par -faceSet \<name\>
+        Restrict conversion to the cellSet, faceSet.
 
-    \param -nearCellValue \n
-    Output cell value on patches instead of patch value itself
+      - \par -nearCellValue
+        Output cell value on patches instead of patch value itself
 
-    \param -noInternal \n
-    Do not generate file for mesh, only for patches
+      - \par -noInternal
+        Do not generate file for mesh, only for patches
 
-    \param -noPointValues \n
-    No pointFields
+      - \par -noPointValues
+        No pointFields
 
-    \param -noFaceZones \n
-    No faceZones
+      - \par -noFaceZones
+        No faceZones
 
-    \param -excludePatches \<patchNames\>\n
-    Specify patches (wildcards) to exclude. For example,
-    \verbatim
-         -excludePatches '( inlet_1 inlet_2 "proc.*")'
-    \endverbatim
-    The quoting is required to avoid shell expansions and to pass the
-    information as a single argument. The double quotes denote a regular
-    expression.
+      - \par -excludePatches \<patchNames\>
+        Specify patches (wildcards) to exclude. For example,
+        \verbatim
+          -excludePatches '( inlet_1 inlet_2 "proc.*")'
+        \endverbatim
+        The quoting is required to avoid shell expansions and to pass the
+        information as a single argument. The double quotes denote a regular
+        expression.
 
-    \param -useTimeName \n
-    use the time index in the VTK file name instead of the time index
+      - \par -useTimeName
+        use the time index in the VTK file name instead of the time index
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C

@@ -37,63 +37,64 @@ Description
       handled by vtk.
 
 Usage
+    \b foamToVTK [OPTION]
 
-    - foamToVTK [OPTION]
+    Options:
+      - \par -ascii
+        Write VTK data in ASCII format instead of binary.
 
-    \param -ascii \n
-    Write VTK data in ASCII format instead of binary.
+      - \par -mesh \<name\>
+        Use a different mesh name (instead of -region)
 
-    \param -mesh \<name\>\n
-    Use a different mesh name (instead of -region)
+      - \par -fields \<fields\>
+        Convert selected fields only. For example,
+        \verbatim
+          -fields "( p T U )"
+        \endverbatim
+        The quoting is required to avoid shell expansions and to pass the
+        information as a single argument.
 
-    \param -fields \<fields\>\n
-    Convert selected fields only. For example,
-    \verbatim
-         -fields "( p T U )"
-    \endverbatim
-    The quoting is required to avoid shell expansions and to pass the
-    information as a single argument.
+      - \par -surfaceFields
+        Write surfaceScalarFields (e.g., phi)
 
-    \param -surfaceFields \n
-    Write surfaceScalarFields (e.g., phi)
+      - \par -cellSet \<name\>
+      - \par -faceSet \<name\>
 
-    \param -cellSet \<name\>\n
-    \param -faceSet \<name\>\n
-    \param -pointSet \<name\>\n
-    Restrict conversion to the cellSet, faceSet or pointSet.
+      - \par -pointSet \<name\>
+        Restrict conversion to the cellSet, faceSet or pointSet.
 
-    \param -nearCellValue \n
-    Output cell value on patches instead of patch value itself
+      - \par -nearCellValue
+        Output cell value on patches instead of patch value itself
 
-    \param -noInternal \n
-    Do not generate file for mesh, only for patches
+      - \par -noInternal
+        Do not generate file for mesh, only for patches
 
-    \param -noPointValues \n
-    No pointFields
+      - \par -noPointValues
+        No pointFields
 
-    \param -noFaceZones \n
-    No faceZones
+      - \par -noFaceZones
+        No faceZones
 
-    \param -noLinks \n
-    (in parallel) do not link processor files to master
+      - \par -noLinks
+        (in parallel) do not link processor files to master
 
-    \param poly \n
-    write polyhedral cells without tet/pyramid decomposition
+      - \par poly
+        write polyhedral cells without tet/pyramid decomposition
 
-    \param -allPatches \n
-    Combine all patches into a single file
+      - \par -allPatches
+        Combine all patches into a single file
 
-    \param -excludePatches \<patchNames\>\n
-    Specify patches (wildcards) to exclude. For example,
-    \verbatim
-         -excludePatches '( inlet_1 inlet_2 "proc.*")'
-    \endverbatim
-    The quoting is required to avoid shell expansions and to pass the
-    information as a single argument. The double quotes denote a regular
-    expression.
+      - \par -excludePatches \<patchNames\>
+        Specify patches (wildcards) to exclude. For example,
+        \verbatim
+          -excludePatches '( inlet_1 inlet_2 "proc.*")'
+        \endverbatim
+        The quoting is required to avoid shell expansions and to pass the
+        information as a single argument. The double quotes denote a regular
+        expression.
 
-    \param -useTimeName \n
-    use the time index in the VTK file name instead of the time index
+      - \par -useTimeName
+        use the time index in the VTK file name instead of the time index
 
 Note
     mesh subset is handled by vtkMesh. Slight inconsistency in
@@ -105,7 +106,7 @@ Note
     whole-mesh values onto the subset patch.
 
 Note
-    new file format: \n
+    \par new file format:
     no automatic timestep recognition.
     However can have .pvd file format which refers to time simulation
     if XML *.vtu files are available: