ENH: Updated header file documentation

2017-03-21 09:40:35 +00:00 · 2017-03-21 09:40:35 +00:00 · cbf793fca2
commit cbf793fca2
parent e9355df198
14 changed files with 21 additions and 18 deletions
--- a/applications/solvers/multiphase/reactingEulerFoam/interfacialModels/dragModels/Tenneti/Tenneti.H
+++ b/applications/solvers/multiphase/reactingEulerFoam/interfacialModels/dragModels/Tenneti/Tenneti.H
@ -32,10 +32,10 @@ Description
    Reference:
    \verbatim
        Tenneti, S., Garg, R., & Subramaniam, S. (2011).
-        Drag law for monodisperse gas–solid systems using particle-resolved
+        Drag law for monodisperse gas-solid systems using particle-resolved
        direct numerical simulation of flow past fixed assemblies of spheres.
-        International Journal of Multiphase Flow, 37(9), 1072–1092.
-    \verbatim
+        International Journal of Multiphase Flow, 37(9), 1072-1092.
+    \endverbatim

 SourceFiles
    Tenneti.C
--- a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
+++ b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
@ -55,10 +55,10 @@ Usage
        the resulting dictionary to standard output.

      - \par -includes
-        List the \c #include and \c #includeIfPresent files to standard output
+        List the \c \#include and \c \#includeIfPresent files to standard output

      - \par -disableFunctionEntries
-        Do not expand macros or directives (#include etc)
+        Do not expand macros or directives (\#include etc)

    Example usage:
      - Change simulation to run for one timestep only:
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/ensightOutputCloud.H
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/ensightOutputCloud.H
@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Namespace
-    ensightOutput
+    Foam::ensightOutput

 Description
    A collection of global functions for writing ensight file content.
--- a/src/OpenFOAM/global/foamDoc.dox
+++ b/src/OpenFOAM/global/foamDoc.dox
--- a/src/TurbulenceModels/turbulenceModels/RAS/SSG/SSG.H
+++ b/src/TurbulenceModels/turbulenceModels/RAS/SSG/SSG.H
@ -34,7 +34,7 @@ Description
    Reference:
    \verbatim
        Speziale, C. G., Sarkar, S., & Gatski, T. B. (1991).
-        Modelling the pressure–strain correlation of turbulence:
+        Modelling the pressure-strain correlation of turbulence:
        an invariant dynamical systems approach.
        Journal of Fluid Mechanics, 227, 245-272.
    \endverbatim
--- a/src/conversion/ccm/reader/ccmBoundaryInfo.H
+++ b/src/conversion/ccm/reader/ccmBoundaryInfo.H
@ -95,8 +95,7 @@ public:
        return ccmIndex != rhs.ccmIndex;
    }

-   // IOstream Operators
-
+    //- Ostream Operator
    friend Ostream& operator<<(Ostream& os, const ccmBoundaryInfo& entry)
    {
        os  << "BoundaryFaces-" << entry.ccmIndex;
@ -107,7 +106,6 @@ public:

        return os;
    }
-
 };


--- a/src/finiteVolume/fields/fvPatchFields/derived/pressurePIDControlInletVelocity/pressurePIDControlInletVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/pressurePIDControlInletVelocity/pressurePIDControlInletVelocityFvPatchVectorField.H
@ -85,6 +85,7 @@ Description
        D               0.1;
        value           uniform (0 0 0);
    }
+    \endverbatim

 SeeAlso
    Foam::fixedValueFvPatchField
--- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H
@ -37,8 +37,8 @@ Description

    where
    \vartable
-        p_rgh   | Pressure - \rho g.(h - hRef) [Pa]
-        ph_rgh  | Hydrostatic pressure - \rho g.(h - hRef) [Pa]
+        p_rgh   | Pressure: \f$ \rho g (h - h_{ref}) \f$ [Pa]
+        ph_rgh  | Hydrostatic pressure: \f$ \rho g (h - h_{ref}) \f$ [Pa]
        h       | Height in the opposite direction to gravity
        hRef    | Reference height in the opposite direction to gravity
        \rho    | Density
--- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
@ -37,7 +37,7 @@ Usage
        phi          | Flux field name         | no          | phi
        psi          | Compressibility field name | no       | thermo:psi
        gamma        | ratio of specific heats (Cp/Cv) | yes |
-        T0           | reference temperature   | yes         |
+        T0           | total temperature       | yes         |
    \endtable

    Example of the boundary condition specification:
@ -45,7 +45,8 @@ Usage
    <patchName>
    {
        type            totalTemperature;
-        T0              uniform 300;
+        gamma           1.4;
+        T0              uniform 800;
    }
    \endverbatim

@ -89,7 +90,7 @@ class totalTemperatureFvPatchScalarField
        //- Heat capacity ratio
        scalar gamma_;

-        //- Total pressure
+        //- Total temperature
        scalarField T0_;


--- a/src/functionObjects/field/blendingFactor/blendingFactor.H
+++ b/src/functionObjects/field/blendingFactor/blendingFactor.H
@ -35,7 +35,7 @@ Description
    The weight of a blended scheme is given by a function of the blending
    factor, f:

-    \[f
+    \f[
        weight = f scheme1 + (1 - f) scheme2
    \f]

--- a/src/functionObjects/field/extractEulerianParticles/extractEulerianParticles/extractEulerianParticles.H
+++ b/src/functionObjects/field/extractEulerianParticles/extractEulerianParticles/extractEulerianParticles.H
@ -30,6 +30,7 @@ Description
    Generates particle size information from Eulerian calculations, e.g. VoF.

 Usage
+    \verbatim
    extractEulerianParticles1
    {
        type            extractEulerianParticles;
--- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
+++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
@ -42,11 +42,11 @@ Usage
        libs            ("libfieldFunctionObjects.so");
        operation       subtract;

-        source1
+        region1
        {
            ...
        }
-        source2
+        region2
        {
            ...
        }
--- a/src/functionObjects/field/mapFields/mapFields.H
+++ b/src/functionObjects/field/mapFields/mapFields.H
@ -45,6 +45,7 @@ Usage

        fields          ("U.*" p);
    }
+    \endverbatim

    Where the entries comprise:
    \table
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedNTUHeatTransfer/tabulatedNTUHeatTransfer.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedNTUHeatTransfer/tabulatedNTUHeatTransfer.H
@ -91,6 +91,7 @@ Description
            // coreBlockageRatio 0;
        }
    }
+    \endverbatim

 SourceFiles
    tabulatedNTUHeatTransfer.C