DOC: header documentation updates/corrections

src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H

@@ -36,7 +36,7 @@ Description
     \verbatim
     a 1.0;
     b 3;
-    c #calc "$a/$b";
+    c \#calc "$a/$b";
     \endverbatim
 
     Note the explicit trailing 0 ('1.0') to force a to be read (and written)
@@ -44,7 +44,7 @@ Description
 
 Note
     Internally this is just a wrapper around codeStream functionality - the
-    #calc string gets used to construct a dictionary for codeStream.
+    \#calc string gets used to construct a dictionary for codeStream.
 
 SourceFiles
     calcEntry.C

src/OpenFOAM/db/functionObjects/functionObject/functionObject.H

@@ -131,7 +131,7 @@ Description
         onEnd             | Trigger on end of simulation run
     \endtable
 
-    The sub-dictionary name \c <userDefinedSubDictName> is chosen by the user,
+    The sub-dictionary name \c \<userDefinedSubDictName\> is chosen by the user,
     and is typically used as the name of the output directory for any data
     written by the function object.
 

src/OpenFOAM/expressions/Function1/Function1Expression.H

@@ -32,7 +32,7 @@ Description
 Usage
     Example:
     \verbatim
-    <patchName>
+    \<patchName\>
     {
         type            uniformFixedValue;
         uniformValue
@@ -55,7 +55,7 @@ Usage
     }
     \endverbatim
 
-Very much like '#eval' but runtime
+Very much like '\#eval' but runtime
 
 See also
     Foam::exprFixedValueFvPatchField

src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutUWallFunction/atmNutUWallFunctionFvPatchScalarField.H

@@ -39,12 +39,12 @@ Description
     The governing equation of the boundary condition:
 
         \f[
-            \u = \frac{\u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
+            u = \frac{u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
         \f]
 
     where
     \vartable
-        \u^*     | Friction velocity
+        u^*      | Friction velocity
         \kappa   | von Kármán constant
         z_0      | Surface roughness length [m]
         z        | Ground-normal coordinate

src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutkWallFunction/atmNutkWallFunctionFvPatchScalarField.H

@@ -40,12 +40,12 @@ Description
     The governing equation of the boundary condition:
 
         \f[
-            \u = \frac{\u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
+            u = \frac{u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
         \f]
 
     where
     \vartable
-      \u^*     | Friction velocity
+      u^*      | Friction velocity
       \kappa   | von Kármán constant
       z_0      | Surface roughness length       [m]
       z        | Ground-normal coordinate

src/atmosphericModels/functionObjects/ObukhovLength/ObukhovLength.H

@@ -39,7 +39,7 @@ Description
     shear in the production and dissipation of turbulent kinetic energy.
 
     \f[
-        u^* = \sqrt{\max (\nu_t \sqrt{2 |\symm{\grad{\u}}|^2}, VSMALL)}
+        u^* = \sqrt{\max (\nu_t \sqrt{2 |\symm{\grad{u}}|^2}, VSMALL)}
     \f]
 
     \f[
@@ -55,7 +55,7 @@ Description
     \vartable
       u^*        | Friction velocity                        [m/s]
       \nu_t      | Turbulent viscosity                      [m2/s]
-      \u         | Velocity                                 [m/s]
+      u          | Velocity                                 [m/s]
       L_o        | Obukhov length                           [m]
       B          | Buoyancy production term                 [m2/s3]
       \alpha_t   | Kinematic turbulent thermal conductivity [m2/s]/[kg/m/s]

src/functionObjects/field/CourantNo/CourantNo.H

@@ -38,7 +38,7 @@ Description
       Operand           | Type           | Location
       input             | -              | -
       output file       | -              | -
-      output field      | volScalarField | $FOAM_CASE/<time>/<outField>
+      output field      | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
     \endtable
 
 Usage

src/functionObjects/field/DESModelRegions/DESModelRegions.H

@@ -69,7 +69,7 @@ Usage
       Property     | Description                        | Type | Req'd | Dflt
       type         | Type name: DESModelRegions         | word |  yes  | -
       libs         | Library name: fieldFunctionObjects | word |  yes  | -
-      result       | Name of DES indicator field        | word |  no   | <FO>
+      result       | Name of DES indicator field        | word |  no   | \<FO\>
     \endtable
 
     The inherited entries are elaborated in:

src/functionObjects/field/LambVector/LambVector.H

@@ -80,7 +80,7 @@ Usage
     \endverbatim
 
 Note
-    To execute \c LambVector function object on an input <field>, a numerical
+    To execute \c LambVector function object on an input \<field\>, a numerical
     scheme should be defined for \c div(LambVector) in
     \c system/fvSchemes.divSchemes.
 

src/functionObjects/field/MachNo/MachNo.H

@@ -36,9 +36,9 @@ Description
     Operands:
     \table
       Operand          | Type           | Location
-      input            | volVectorField | $FOAM_CASE/<time>/<inpField>
+      input            | volVectorField | $FOAM_CASE/\<time\>/\<inpField\>
       output file      | -              | -
-      output field     | volScalarField | $FOAM_CASE/<time>/<outField>
+      output field     | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
     \endtable
 
 Usage

src/functionObjects/field/Q/Q.H

@@ -48,9 +48,9 @@ Description
     Operands:
     \table
       Operand        | Type           | Location
-      input          | volVectorField | $FOAM_CASE/<time>/<inpField>
+      input          | volVectorField | $FOAM_CASE/\<time\>/\<inpField\>
       output file    | -              | -
-      output field   | volScalarField | $FOAM_CASE/<time>/<outField>
+      output field   | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
     \endtable
 
 Usage

src/functionObjects/field/div/div.H

@@ -51,7 +51,7 @@ Usage
         libs            (fieldFunctionObjects);
 
         // Mandatory (inherited) entry (runtime modifiable)
-        field           <field>;
+        field           \<field\>;
 
         // Optional (inherited) entries
         ...
@@ -72,12 +72,12 @@ Usage
 
     Minimal example by using the \c postProcess utility:
     \verbatim
-        postProcess -func "div(<field>)"
+        postProcess -func "div(\<field\>)"
     \endverbatim
 
 Note
-    To execute \c div function object on an input <field>, a numerical scheme
+    To execute \c div function object on an input \<field\>, a numerical scheme
-    should be defined for \c div(<field>) in \c system/fvSchemes.divSchemes.
+    should be defined for \c div(\<field\>) in \c system/fvSchemes.divSchemes.
 
 See also
     - Foam::functionObject

src/functionObjects/field/limitFields/limitFields.H

@@ -35,9 +35,9 @@ Description
     Operands:
     \table
       Operand          | Type             | Location
-      input            | vol<Type>Field | $FOAM_CASE/<time>/<inpField>
+      input            | vol\<Type\>Field | $FOAM_CASE/\<time\>/\<inpField\>
       output file      | -                | -
-      output field     | vol<Type>Field | $FOAM_CASE/<time>/<outField>
+      output field     | vol\<Type\>Field | $FOAM_CASE/\<time\>/\<outField\>
     \endtable
 
     where \c \<Type\>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

src/functionObjects/field/pressure/pressure.H

@@ -78,9 +78,9 @@ Description
     Operands:
     \table
       Operand        | Type           | Location
-      input          | volScalarField | $FOAM_CASE/<time>/<inpField>
+      input          | volScalarField | $FOAM_CASE/\<time\>/\<inpField\>
       output file    | -              | -
-      output field   | volScalarField | $FOAM_CASE/<time>/<outField>
+      output field   | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
     \endtable
 
 Usage
@@ -93,11 +93,11 @@ Usage
         libs            (fieldFunctionObjects);
 
         // Mandatory entries (runtime modifiable)
-        mode            <option>;
+        mode            \<option\>;
 
         // Optional entries (runtime modifiable)
-        p               <pName>;
+        p               \<pName\>;
-        U               <UName>;
+        U               \<UName\>;
         rho             <rhoName>;
         rhoInf          1.0; // enabled if rho=rhoInf
         pRef            0.0;

src/fvOptions/constraints/general/fixedValueConstraint/FixedValueConstraint.H

@@ -37,18 +37,19 @@ Description
 
 Usage
     Minimal example by using \c constant/fvOptions:
-    <Type>FixedValueConstraint1
+    \verbatim
+    \<Type\>FixedValueConstraint1
     {
         // Mandatory entries (unmodifiable)
-        type            <Type>FixedValueConstraint;
+        type            \<Type\>FixedValueConstraint;
 
         // Mandatory entries (runtime modifiable)
         fieldValues
         {
-            <fieldName1>           <value1>;
+            \<fieldName1\>           \<value1\>;
-            <fieldName2>           <value2>;
+            \<fieldName2\>           \<value2\>;
             ...
-            <fieldNameN>           <valueN>;
+            \<fieldNameN\>           \<valueN\>;
         }
 
         // Mandatory/Optional (inherited) entries

src/fvOptions/sources/derived/phaseLimitStabilization/PhaseLimitStabilization.H

@@ -42,12 +42,13 @@ Description
 
 Usage
     Minimal example by using \c constant/fvOptions:
-    <Type>PhaseLimitStabilization1
+    \verbatim
+    \<Type\>PhaseLimitStabilization1
     {
         // Mandatory entries (unmodifiable)
-        type            <Type>PhaseLimitStabilization;
+        type            \<Type\>PhaseLimitStabilization;
-        field           <fieldName>;
+        field           \<fieldName\>;
-        rate            <rateName>;
+        rate            \<rateName\>;
 
         // Mandatory entries (runtime modifiable)
         residualAlpha   1.0;

src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H

@@ -53,7 +53,7 @@ Usage
         type            rotorDiskSource;
 
         // Mandatory entries (runtime modifiable)
-        fields          (<field1> <field2> ... <fieldN>);
+        fields          (\<field1\> \<field2\> ... \<fieldN\>);
         rhoRef          1.0;
         rpm             5.5;
         nBlades         3;

src/meshTools/output/foamVtkPatchMeshWriter.H

@@ -125,7 +125,6 @@ public:
     // Constructors
 
         //- Construct from components (default format INLINE_BASE64)
-        //  \param useNearCellValue to use cell instead of patch values
         patchMeshWriter
         (
             const polyMesh& mesh,

src/surfMesh/writers/abaqus/abaqusSurfaceWriter.H

@@ -52,27 +52,27 @@ Description
     }
     \endverbatim
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- surfaceName0
         `-- geometry
-            `-- surfaceName0_<time>.abq
+            `-- surfaceName0_\<time\>.abq
     \endverbatim
 
-    \subheading Fields
+    \subsection Fields
     \verbatim
     rootdir
     `-- surfaceName0
         `-- field0
-        |   `-- surfaceName0_<time>.{inp}
+        |   `-- surfaceName0_\<time\>.{inp}
         `-- field1
-            `-- surfaceName0_<time>.{inp}
+            `-- surfaceName0_\<time\>.{inp}
     \endverbatim
 
 Note

src/surfMesh/writers/foam/foamSurfaceWriter.H

@@ -54,12 +54,12 @@ Description
         fieldScale | output field scaling (dictionary)      | no  | empty
     \endtable
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- timeName
@@ -69,7 +69,7 @@ Description
             `-- "faces"
     \endverbatim
 
-    \subheading Fields
+    \subsection Fields
     \verbatim
     rootdir
     `-- timeName

src/surfMesh/writers/nastran/nastranSurfaceWriter.H

@@ -64,12 +64,12 @@ Description
     }
     \endverbatim
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- <time>
@@ -77,7 +77,7 @@ Description
         `-- surfaceName1.{nas}
     \endverbatim
 
-    \subheading Fields
+    \subsection Fields
     \verbatim
     rootdir
     `-- <time>

src/surfMesh/writers/proxy/proxySurfaceWriter.H

@@ -31,12 +31,12 @@ Description
     A surfaceWriter that writes the geometry via the MeshedSurfaceProxy,
     but which does not support any fields.
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- timeName

src/surfMesh/writers/raw/rawSurfaceWriter.H

@@ -55,19 +55,19 @@ Description
     }
     \endverbatim
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- timeName
         `-- surfaceName.{raw}
     \endverbatim
 
-    \subheading Fields
+    \subsection Fields
     \verbatim
     rootdir
     `-- timeName

src/surfMesh/writers/starcd/starcdSurfaceWriter.H

@@ -51,19 +51,19 @@ Description
         getuser FILENAME.usr vertex vector free
     \endverbatim
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- timeName
         `-- surfaceName.{cel,vrt,inp}
     \endverbatim
 
-    \subheading Fields
+    \subsection Fields
     \verbatim
     rootdir
     `-- timeName

src/surfMesh/writers/vtk/vtkSurfaceWriter.H

@@ -56,12 +56,12 @@ Description
     }
     \endverbatim
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry and Fields
+    \subsection Geometry and Fields
     \verbatim
     rootdir
     `-- timeName

src/surfMesh/writers/x3d/x3dSurfaceWriter.H

@@ -37,19 +37,19 @@ Description
         colourMap   | The colour map for rendering          | no  | coolToWarm
     \endtable
 
-    \heading Output file locations
+    \section Output file locations
 
     The \c rootdir normally corresponds to something like
     \c postProcessing/\<name\>
 
-    \subheading Geometry
+    \subsection Geometry
     \verbatim
     rootdir
     `-- timeName
         `-- surfaceName.x3d
     \endverbatim
 
-    \subheading Fields
+    \subsection Fields
     \verbatim
     rootdir
     `-- timeName

src/thermophysicalModels/thermophysicalProperties/thermophysicalFunctions/integratedNonUniformTable/integratedNonUniformTableThermophysicalFunction.H

@@ -35,10 +35,10 @@ Description
     the table.
 
 Usage
-    \integratedNonUniformTable
+    \table
         Property    | Description
         values      | List of (temperature property) value pairs
-    \endintegratedNonUniformTable
+    \endTable
 
     Example for the density of water between 280 and 350K
     \verbatim

src/thermophysicalModels/thermophysicalProperties/thermophysicalFunctions/nonUniformTable/nonUniformTableThermophysicalFunction.H

@@ -36,10 +36,10 @@ Description
     the table.
 
 Usage
-    \nonUniformTable
+    \table
         Property    | Description
         values      | List of (temperature property) value pairs
-    \endnonUniformTable
+    \endTable
 
     Example for the density of water between 280 and 350K
     \verbatim