STYLE: Updated header file documentation

applications/solvers/combustion/chemFoam/chemFoam.C

@@ -28,9 +28,10 @@ Group
     grpCombustionSolvers
 
 Description
-    Solver for chemistry problems
+    Solver for chemistry problems designed for use on single cell cases to
-    - designed for use on single cell cases to provide comparison against
+    provide comparison against other chemistry solvers
-      other chemistry solvers
+
+    Note:
     - single cell mesh created on-the-fly
     - fields created on the fly from the initial conditions
 

applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C

@@ -29,11 +29,12 @@ Group
 
 Description
     Combination of heatConductionFoam and buoyantFoam for conjugate heat
-    transfer between solid regions and fluid regions. Both regions include
+    transfer between solid regions and fluid regions.
-    the fvOptions framework.
 
-    It handles secondary fluid or solid circuits which can be coupled
+    Note:
-    thermally with the main fluid region. i.e radiators, etc.
+    - Both regions support the fvOptions framework.
+    - It handles secondary fluid or solid circuits which can be coupled
+      thermally with the main fluid region. i.e radiators, etc.
 
 \*---------------------------------------------------------------------------*/
 

applications/solvers/incompressible/boundaryFoam/boundaryFoam.C

@@ -29,7 +29,7 @@ Group
 
 Description
     Steady-state solver for incompressible, 1D turbulent flow, typically to
-    generate boundary layer conditions at an inlet, for use in a simulation.
+    generate boundary layer conditions at an inlet.
 
     Boundary layer code to calculate the U, k and epsilon distributions.
     Used to create inlet boundary conditions for experimental comparisons

applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C

@@ -28,13 +28,12 @@ Group
     grpLagrangianSolvers
 
 Description
-    Transient solver for:
+    Transient PIMPLE solver for compressible, laminar or turbulent flow with 
-    - compressible,
+    coal and thermodynamic parcels, and combustion.
-    - turbulent flow,
+
-    with
+    Note:
-    - coal and limestone parcel injections,
+    - includes run-time selectable finite volume options, e.g. sources,
-    - energy source, and
+      constraints
-    - combustion.
 
 \*---------------------------------------------------------------------------*/
 

applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C

@@ -29,8 +29,11 @@ Group
 
 Description
     Transient PIMPLE solver for compressible, laminar or turbulent flow with
-    reacting multiphase Lagrangian parcels, including run-time selectable
+    reacting multiphase Lagrangian parcels.
-    finite volume options, e.g. sources, constraints
+
+    Note:
+    - includes run-time selectable finite volume options, e.g. sources,
+      constraints
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C

@@ -27,7 +27,9 @@ Application
 Description
     Generates a VTK file of particle tracks for cases that were computed using
     a steady-state cloud
-    NOTE: case must be re-constructed (if running in parallel) before use
+
+    Note:
+    - Case must be re-constructed (if running in parallel) before use
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C

@@ -25,7 +25,6 @@ Application
     faceAgglomerate
 
 Description
-
     Agglomerate boundary faces using the pairPatchAgglomeration algorithm.
     It writes a map from the fine to coarse grid.
 

applications/utilities/preProcessing/mapFields/mapFields.C

@@ -27,6 +27,7 @@ Application
 Description
     Maps volume fields from one mesh to another, reading and
     interpolating all fields present in the time directory of both cases.
+
     Parallel and non-parallel cases are handled without the need to reconstruct
     them first.
 

applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C

@@ -25,16 +25,15 @@ Application
     surfaceBooleanFeatures
 
 Description
-
     Generates the extendedFeatureEdgeMesh for the interface between a boolean
-    operation on two surfaces.  Assumes that the orientation of the surfaces is
+    operation on two surfaces.
-    correct:
 
-    + if the operation is union or intersection, that both surface's normals
+    Assumes that the orientation of the surfaces iscorrect:
+    - if the operation is union or intersection, that both surface's normals
       (n) have the same orientation with respect to a point, i.e. surfaces and b
       are orientated the same with respect to point x:
 
-    @verbatim
+    \verbatim
        _______
       |       |--> n
       |    ___|___             x
@@ -43,14 +42,14 @@ Description
           |       |
           |_______|
 
-    @endverbatim
+    \endverbatim
 
-    + if the operation is a subtraction, the surfaces should be oppositely
+    - if the operation is a subtraction, the surfaces should be oppositely
     oriented with respect to a point, i.e. for (a - b), then b's orientation
     should be such that x is "inside", and a's orientation such that x is
     "outside"
 
-    @verbatim
+    \verbatim
        _______
       |       |--> n
       |    ___|___             x
@@ -59,7 +58,7 @@ Description
           |  n <--|
           |_______|
 
-    @endverbatim
+    \endverbatim
 
     When the operation is peformed - for union, all of the edges generates where
     one surfaces cuts another are all "internal" for union, and "external" for

applications/utilities/surface/surfaceClean/surfaceClean.C

@@ -25,6 +25,9 @@ Application
     surfaceClean
 
 Description
+    Utility to clean surfaces.
+
+    Current functionality
     - removes baffles
     - collapses small edges, removing triangles.
     - converts sliver triangles into split edges by projecting point onto

applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C

@@ -25,12 +25,15 @@ Application
     surfaceCoarsen
 
 Description
-    Surface coarsening using 'bunnylod':
+    Surface coarsening using `bunnylod'
 
+    Reference:
+    \verbatim
         Polygon Reduction Demo
         By Stan Melax (c) 1998
         mailto:melax@cs.ualberta.ca
         http://www.cs.ualberta.ca/~melax
+    \endverbatim
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/surface/surfaceInertia/surfaceInertia.C

@@ -26,8 +26,9 @@ Application
 
 Description
     Calculates the inertia tensor, principal axes and moments of a
-    command line specified triSurface. Inertia can either be of the
+    command line specified triSurface.
-    solid body or of a thin shell.
+
+    Inertia can either be of the solid body or of a thin shell.
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C

@@ -26,10 +26,16 @@ Application
 
 Description
     Refine by splitting all three edges of triangle ('red' refinement).
+
     Neighbouring triangles (which are not marked for refinement get split
-    in half ('green' refinement). (R. Verfuerth, "A review of a posteriori
+    in half ('green' refinement).
+
+    Reference:
+    \verbatim
+    R. Verfuerth, "A review of a posteriori
     error estimation and adaptive mesh refinement techniques",
     Wiley-Teubner, 1996)
+    \endverbatim
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C

@@ -22,10 +22,10 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Description
+    Strips any baffle parts of a surface.
 
-    Strips any baffle parts of a surface.  A baffle region is one which is
+    A baffle region is one which is reached by walking from an open edge, and
-    reached by walking from an open edge, and stopping when a multiply connected
+    stopping when a multiply connected edge is reached.
-    edge is reached.
 
 \*---------------------------------------------------------------------------*/