Merge branch 'doxygen-style' into 'merge-foundation'

STYLE: minor adjustments to doxygen comments



See merge request !64

applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C

@@ -31,7 +31,7 @@ Description
     Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format.
 
 Usage
-    \b star4ToFoam [OPTION] ccmMesh
+    \b star4ToFoam [OPTION] prostarMesh
 
     Options:
       - \par -ascii

applications/utilities/parallelProcessing/decomposePar/decomposePar.C

@@ -39,34 +39,34 @@ Usage
         Write the cell distribution as a labelList, for use with 'manual'
         decomposition method or as a volScalarField for post-processing.
 
-      - \par -region \<regionName\> \n
+      - \par -region \<regionName\>
         Decompose named region. Does not check for existence of processor*.
 
-      - \par -allRegions \n
+      - \par -allRegions
         Decompose all regions in regionProperties. Does not check for
         existence of processor*.
 
-      - \par -copyUniform \n
+      - \par -copyUniform
         Copy any \a uniform directories too.
 
       - \par -constant
 
-      - \par -time xxx:yyy \n
+      - \par -time xxx:yyy
         Override controlDict settings and decompose selected times. Does not
         re-decompose the mesh i.e. does not handle moving mesh or changing
         mesh cases.
 
-      - \par -fields \n
+      - \par -fields
         Use existing geometry decomposition and convert fields only.
 
-      - \par -noSets \n
+      - \par -noSets
         Skip decomposing cellSets, faceSets, pointSets.
 
-      - \par -force \n
+      - \par -force
         Remove any existing \a processor subdirectories before decomposing the
         geometry.
 
-      - \par -ifRequired \n
+      - \par -ifRequired
         Only decompose the geometry if the number of domains has changed from a
         previous decomposition. No \a processor subdirectories will be removed
         unless the \a -force option is also specified. This option can be used

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

@@ -34,7 +34,6 @@ Description
 
 Usage
     \b foamToEnsight [OPTION]
-    Translates OpenFOAM data to EnSight format
 
     Options:
       - \par -ascii
@@ -43,29 +42,28 @@ Usage
       - \par -noZero
         Exclude the often incomplete initial conditions.
 
-      - \par -noLagrangian \n
+      - \par -noLagrangian
         Suppress writing lagrangian positions and fields.
 
       - \par -noPatches
         Suppress writing any patches.
 
-      - \par -patches patchList \n
+      - \par -patches patchList
         Specify particular patches to write.
         Specifying an empty list suppresses writing the internalMesh.
 
-      - \par -faceZones zoneList \n
+      - \par -faceZones zoneList
         Specify faceZones to write, with wildcards
 
       - \par -cellZone zoneName
         Specify single cellZone to write (not lagrangian)
 
-      - \par -width \<n\>\n
+      - \par -width \<n\>
         Width of EnSight data subdir (default: 8)
 
 Note
-    Parallel support for cloud data is not supported
+    Writes to \a EnSight directory to avoid collisions with
-    - writes to \a EnSight directory to avoid collisions with
+    foamToEnsightParts
-      foamToEnsightParts
 
 \*---------------------------------------------------------------------------*/
 

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

@@ -48,10 +48,10 @@ Usage
         Ignore the time index contained in the time file and use a
         simple indexing when creating the \c Ensight/data/######## files.
 
-      - \par -noLagrangian \n
+      - \par -noLagrangian
         Suppress writing lagrangian positions and fields.
 
-      - \par -index \<start\>\n
+      - \par -index \<start\>
         Ignore the time index contained in the time file and use a
         simple indexing when creating the \c Ensight/data/######## files.
 

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

@@ -72,10 +72,10 @@ Usage
       - \par -noInternal
         Do not generate file for mesh, only for patches
 
-      - \par -noLagrangian \n
+      - \par -noLagrangian
         Suppress writing lagrangian positions and fields.
 
-      - \par -noPointValues \n
+      - \par -noPointValues
         No pointFields
 
       - \par -noFaceZones

applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C

@@ -36,25 +36,25 @@ Usage
     \b surfaceMeshImport inputFile [OPTION]
 
     Options:
-      - \par -clean \n
+      - \par -clean
         Perform some surface checking/cleanup on the input surface.
 
-      - \par -name \<name\> \n
+      - \par -name \<name\>
         Specify an alternative surface name when writing.
 
-      - \par -scaleIn \<scale\> \n
+      - \par -scaleIn \<scale\>
         Specify a scaling factor when reading files.
 
-      - \par -scaleOut \<scale\> \n
+      - \par -scaleOut \<scale\>
         Specify a scaling factor when writing files.
 
-      - \par -dict \<dictionary\> \n
+      - \par -dict \<dictionary\>
         Specify an alternative dictionary for constant/coordinateSystems.
 
-      - \par -from \<coordinateSystem\> \n
+      - \par -from \<coordinateSystem\>
         Specify a coordinate system when reading files.
 
-      - \par -to \<coordinateSystem\> \n
+      - \par -to \<coordinateSystem\>
         Specify a coordinate system when writing files.
 
 Note