Doxygen documentation: Use the standard 'Usage' rather than the '\heading....'

2025-12-08 06:57:46 +00:00 · 2016-06-17 17:22:24 +01:00
parent 2b7ee7354c
commit 2ca0a6f362
179 changed files with 234 additions and 239 deletions
--- a/src/functionObjects/field/fieldAverage/fieldAverage.H
+++ b/src/functionObjects/field/fieldAverage/fieldAverage.H
@ -93,7 +93,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property        | Description           | Required    | Default value
        type            | type name: fieldAverage | yes |
--- a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
+++ b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
@ -54,7 +54,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: fieldCoordinateSystemTransform | yes |
--- a/src/functionObjects/field/fieldMinMax/fieldMinMax.H
+++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.H
@ -53,7 +53,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: fieldMinMax  | yes         |
--- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
+++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
@ -50,7 +50,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: fieldValueDelta   | yes    |
--- a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H
+++ b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H
@ -59,7 +59,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: surfaceRegion   | yes         |
--- a/src/functionObjects/field/fieldValues/volRegion/volRegion.H
+++ b/src/functionObjects/field/fieldValues/volRegion/volRegion.H
@ -55,7 +55,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | Type name: volRegion   | yes         |
--- a/src/functionObjects/field/histogram/histogram.H
+++ b/src/functionObjects/field/histogram/histogram.H
@ -46,7 +46,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: histogram    | yes         |
--- a/src/functionObjects/field/nearWallFields/nearWallFields.H
+++ b/src/functionObjects/field/nearWallFields/nearWallFields.H
@ -51,7 +51,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property | Description               | Required    | Default value
        type     | type name: nearWallFields | yes         |
--- a/src/functionObjects/field/pressure/pressure.H
+++ b/src/functionObjects/field/pressure/pressure.H
@ -88,7 +88,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description                 | Required   | Default value
        type         | type name: pressure    | yes        |
--- a/src/functionObjects/field/processorField/processorField.H
+++ b/src/functionObjects/field/processorField/processorField.H
@ -41,7 +41,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: processorField | yes       |
--- a/src/functionObjects/field/readFields/readFields.H
+++ b/src/functionObjects/field/readFields/readFields.H
@ -46,7 +46,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: readFields   | yes         |
--- a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
+++ b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
@ -79,7 +79,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: regionSizeDistribution |yes|
--- a/src/functionObjects/field/streamLine/streamLine.H
+++ b/src/functionObjects/field/streamLine/streamLine.H
@ -62,7 +62,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | Type name: streamLine   | yes         |
--- a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
+++ b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
@ -49,7 +49,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property | Description               | Required    | Default value
        type     | type name: nearWallFields | yes         |
--- a/src/functionObjects/field/turbulenceFields/turbulenceFields.H
+++ b/src/functionObjects/field/turbulenceFields/turbulenceFields.H
@ -53,7 +53,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description                 | Required | Default value
        type         | type name: processorField   | yes      |
--- a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
+++ b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
@ -62,7 +62,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | Type name: wallBoundedStreamLine| yes |
--- a/src/functionObjects/field/wallShearStress/wallShearStress.H
+++ b/src/functionObjects/field/wallShearStress/wallShearStress.H
@ -57,7 +57,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property | Description               | Required    | Default value
        type     | type name: wallShearStress | yes        |
--- a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H
+++ b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H
@ -57,7 +57,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: forces       | yes         |
--- a/src/functionObjects/forces/forces/forces.H
+++ b/src/functionObjects/forces/forces/forces.H
@ -54,7 +54,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | Type name: forces       | yes         |
--- a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
+++ b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
@ -49,7 +49,7 @@ Description
    \endverbatim


-    \heading Function object usage
+Usage

    \table
        Property     | Description             | Required    | Default value
--- a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
+++ b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
@ -52,7 +52,7 @@ Description
        }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property | Description                     | Required   | Default value
        type     | Type name: icoUncoupledKinematicCloud | yes  |
--- a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
+++ b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
@ -41,7 +41,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: removeRegisteredObject | yes |
--- a/src/functionObjects/utilities/systemCall/systemCall.H
+++ b/src/functionObjects/utilities/systemCall/systemCall.H
@ -59,7 +59,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: systemCall   | yes         |
--- a/src/functionObjects/utilities/writeObjects/writeObjects.H
+++ b/src/functionObjects/utilities/writeObjects/writeObjects.H
@ -52,7 +52,7 @@ Description
    }
    \endverbatim

-    \heading Function object usage
+Usage
    \table
        Property     | Description             | Required    | Default value
        type         | type name: writeObjects | yes |