ENH: Updated header file documentation

2025-12-28 03:37:59 +00:00 · 2017-03-21 09:40:35 +00:00
parent e9355df198
commit cbf793fca2
14 changed files with 21 additions and 18 deletions
--- 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