STYLE: Documentation updates

src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H

@@ -41,6 +41,7 @@ Description
         codeWrite   : c++; upon functionObject::write()
         codeEnd     : c++; upon functionObject::end();
 
+Usage
     Example of function object specification:
     \verbatim
     difference

src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H

@@ -30,6 +30,7 @@ Group
 Description
     Removes registered objects if present in the database.
 
+Usage
     Example of function object specification:
     \verbatim
     removeRegisteredObject1
@@ -41,7 +42,7 @@ Description
     }
     \endverbatim
 
-Usage
+    Where the entries comprise:
     \table
         Property     | Description             | Required    | Default value
         type         | type name: removeRegisteredObject | yes |

src/functionObjects/utilities/residuals/residuals.H

@@ -30,18 +30,15 @@ Group
 Description
     Writes out the initial residual for specified fields.
 
+Usage
     Example of function object specification:
     \verbatim
     residuals
     {
         type            residuals;
-        writeControl   timeStep;
-        writeInterval  1;
-        fields
-        (
-            U
-            p
-        );
+        libs            ("libutilityFunctionObjects.so");
+        ...
+        fields          (U p);
     }
     \endverbatim
 

src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H

@@ -34,7 +34,7 @@ Description
     functionObjects. Supports 'enabled' flag but none of the other options
     'timeStart', 'timeEnd', 'writeControl' etc.
 
-
+Usage
     Example of function object specification to manipulate the time step:
     \verbatim
     setTimeStep1
@@ -45,7 +45,7 @@ Description
     }
     \endverbatim
 
-    \heading Function object usage
+    Where the entries comprise:
     \table
         Property     | Description             | Required    | Default value
         type         | Type name: setTimeStep  | yes         |

src/functionObjects/utilities/systemCall/systemCall.H

@@ -35,6 +35,7 @@ Description
     - every output time
     - end of the calculation
 
+Usage
     Example of function object specification:
     \verbatim
     systemCall1
@@ -59,7 +60,7 @@ Description
     }
     \endverbatim
 
-Usage
+    Where the entries comprise:
     \table
         Property     | Description              | Required    | Default value
         type         | type name: systemCall    | yes         |

src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H

@@ -36,11 +36,15 @@ Description
         Nu = 2.0 + \left(0.4 Re^{0.5} + 0.06 Re^{2/3}\right)*Pr^{0.4}
     \f]
 
+Usage
     Example of function object specification:
     \verbatim
     probes
     {
         type            thermoCoupleProbes;
+        libs            ("libutilityFunctionObjects.so");
+        writeControl    timeStep;
+        writeInterval   1;
 
         solver          rodas23;
         absTol          1e-12;
@@ -56,9 +60,6 @@ Description
 
         radiationField  G;
 
-        libs            ("libutilityFunctionObjects.so");
-        writeControl    timeStep;
-        writeInterval   1;
         probeLocations
         (
             (0.5 0.5 0.5)

src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H

@@ -30,6 +30,7 @@ Group
 Description
     Performs a file copy/replacement once a specified time has been reached.
 
+Usage
     Example usage to update the fvSolution dictionary at various times
     throughout the calculation:
     \verbatim
@@ -51,7 +52,7 @@ Description
     }
     \endverbatim
 
-    \heading Function object usage
+    Where the entries comprise:
     \table
         Property     | Description             | Required    | Default value
         type         | Type name: timeActivatedFileUpdate | yes |

src/functionObjects/utilities/writeObjects/writeObjects.H

@@ -48,6 +48,7 @@ Description
         anyWrite  | any option of the previous two
     \endvartable
 
+Usage
     Example of function object specification:
     \verbatim
     writeObjects1
@@ -60,7 +61,7 @@ Description
     }
     \endverbatim
 
-Usage
+    Where the entries comprise:
     \table
         Property     | Description             | Required     | Default value
         type         | type name: writeObjects | yes          |