From 7200384f183d5ca489eae24b1aa7d8be4ddc3a3c Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Tue, 21 Jun 2016 11:04:34 +0100
Subject: [PATCH] Corrected documentation for Doxygen

---
 src/OpenFOAM/db/Time/Time.H                   |  2 +-
 .../functionObject/functionObject.H           | 42 +++++++++----------
 .../fixedTemperatureConstraint.H              | 13 ++++--
 .../FixedValueConstraint.H                    |  1 +
 4 files changed, 33 insertions(+), 25 deletions(-)

diff --git a/src/OpenFOAM/db/Time/Time.H b/src/OpenFOAM/db/Time/Time.H
index 2d1fefe6dd..cbb186b631 100644
--- a/src/OpenFOAM/db/Time/Time.H
+++ b/src/OpenFOAM/db/Time/Time.H
@@ -372,7 +372,7 @@ public:
                 const word& constantName = "constant"
             );
 
-            //- Write time dictionary to the <time>/uniform directory
+            //- Write time dictionary to the \<time\>/uniform directory
             virtual bool writeTimeDict() const;
 
             //- Write using given format, version and compression
diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
index 2405cac9da..cfe7e3a544 100644
--- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
+++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
@@ -40,51 +40,51 @@ Description
     functionObject the following entry would be specified:
 
     \verbatim
-        functions
+    functions
+    {
+        <functionObjectName>
         {
-            <functionObjectName>
-            {
-                type                functionObjectType;
-                libs                ("libMyFunctionObjectlib.so");
-                region              defaultRegion;
-                enabled             yes;
-                timeStart           0;
-                timeEnd             10;
-                writeControl        writeTime;
-                writeInterval       1;
-                ...
-            }
+            type                functionObjectType;
+            libs                ("libMyFunctionObjectlib.so");
+            region              defaultRegion;
+            enabled             yes;
+            timeStart           0;
+            timeEnd             10;
+            writeControl        writeTime;
+            writeInterval       1;
+            ...
         }
+    }
     \endverbatim
 
     Where:
     \table
         Property | Description                       | Required | Default value
         type     | Type of function object               | yes      |
-        libs | Libraries containing implementation | yes |
+        libs     | Libraries containing implementation   | yes      |
         region   | Name of region for multi-region cases | no       |
         enabled  | On/off switch                         | no       | yes
         timeStart| Start time                            | no       |
         timeEnd  | End time                              | no       |
-        evaluateControl | See time controls below        | no       | timeStep
-        evaluateInterval   | Steps between output           | no       |
-        writeControl   | See time controls below        | no       | timeStep
-        writeInterval   | Steps between output           | no       |
+        evaluateControl  | See time controls below       | no       | timeStep
+        evaluateInterval | Steps between output          | no       |
+        writeControl     | See time controls below       | no       | timeStep
+        writeInterval    | Steps between output          | no       |
     \endtable
 
     Time controls:
     \table
         Option            | Description
         timeStep          | Execute/write every 'writeInterval' time-steps
-        writeTime        | Execute/write every 'writeInterval' output times
+        writeTime         | Execute/write every 'writeInterval' output times
         adjustableRunTime | Execute/write every 'writeInterval' run time period
         runTime           | Execute/write every 'writeInterval' run time period
-        clockTime       | Execute/write every 'writeInterval' clock time period
+        clockTime        | Execute/write every 'writeInterval' clock time period
         cpuTime           | Execute/write every 'writeInterval' CPU time period
         none              | Execute/write every time-step
     \endtable
 
-    The sub-dictionary name \c <functionObjectName> is chosen by the user, and
+    The sub-dictionary name \c \<functionObjectName\> is chosen by the user, and
     is typically used as the name of the output directory for any data written
     by the functionObject.  The \c type entry defines the type of function
     object properties that follow.  FunctionObjects are packaged into separate
diff --git a/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H b/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H
index 64b9f5cd6b..afab78ad52 100644
--- a/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H
+++ b/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H
@@ -27,18 +27,25 @@ Class
 Description
     Fixed temperature equation constraint
 
-    Sources described by:
+Usage
+    \verbatim
+    fixedTemperature
+    {
+        type            fixedTemperatureConstraint;
+        active          yes;
 
         fixedTemperatureConstraintCoeffs
         {
-            mode            uniform;    // uniform or lookup
+            mode            uniform;      // uniform or lookup
 
             // For uniform option
             temperature     constant 500; // fixed temperature with time [K]
 
             // For lookup option
-            // T            <Tname>;     // optional temperature field name
+            // T            <Tname>;      // optional temperature field name
         }
+    }
+    \endverbatim
 
 Note:
     The 'uniform' option allows the use of a time-varying uniform temperature
diff --git a/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H b/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H
index 72ed262638..dcd557f624 100644
--- a/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H
+++ b/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H
@@ -27,6 +27,7 @@ Class
 Description
     Constrain the field values within a specified region.
 
+Usage
     For example to set the turbulence properties within a porous region:
     \verbatim
     porosityTurbulence