STYLE: minor doc and formatting changes

src/OpenFOAM/containers/HashTables/Map/Map.H

@@ -73,7 +73,7 @@ public:
 
     // Constructors
 
-        //- Construct null with default table capacity
+        //- Default construct with default table capacity
         Map()
         :
             parent_type()
@@ -125,8 +125,6 @@ public:
         {
             parent_type::operator=(std::move(rhs));
         }
-
-
 };
 
 

src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H

@@ -65,7 +65,7 @@ public:
 
     // Constructors
 
-        //- Construct null with default table capacity
+        //- Default construct with default table capacity
         PtrMap()
         :
             parent_type()

src/OpenFOAM/db/error/messageStream.H

@@ -369,7 +369,7 @@ extern messageStream SeriousError;
 //- Report an information message using Foam::Pout
 //  for FUNCTION_NAME in file __FILE__ at line __LINE__
 //  if the local debug switch is true
-#define DebugPoutInFunction                                                        \
+#define DebugPoutInFunction                                                    \
     if (debug) PoutInFunction
 
 //- Report a variable name and value

src/OpenFOAM/db/functionObjects/functionObject/functionObject.H

@@ -98,9 +98,9 @@ Description
 
     where the entries mean:
     \table
-        Property | Description                            | Type | Req'd | Dflt
+        Property | Description                            | Type | Reqd | Deflt
         type     | Type name of function object           | word |  yes  | -
-        libs     | Library name containing implementation | word |  yes  | -
+        libs     | Library name(s) for implementation     | words | no  | -
         region   | Name of region for multi-region cases  | word | no | region0
         enabled  | Switch to turn function object on/off  | bool | no | true
         log     | Switch to write log info to standard output | bool | no | true
@@ -199,7 +199,7 @@ SourceFiles
 namespace Foam
 {
 
-// Forward declarations
+// Forward Declarations
 class Time;
 class polyMesh;
 class mapPolyMesh;

src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H

@@ -79,9 +79,8 @@ class functionObjectList
         //- Reference to Time
         const Time& time_;
 
-        //- The parent dictionary containing a "functions" entry
+        //- The parent dictionary containing a "functions" sub-dictionary
-        //  This entry can either be a list or a dictionary of
+        //- of functionObject specifications
-        //  functionObject specifications
         const dictionary& parentDict_;
 
         //- Function object properties - stores state information
@@ -146,12 +145,11 @@ public:
             const bool execution=true
         );
 
-        //- Construct from Time, a dictionary with "functions" entry
+        //- Construct from Time, a dictionary with a "functions" entry
-        //  and the execution setting.
+        //- and the execution setting.
         //  \param[in]  runTime - the other Time instance to construct from
         //  \param[in]  parentDict - the parent dictionary containing
-        //    a "functions" entry, which can either be a list or a dictionary
+        //    a "functions" sub-dictionary of functionObject specifications.
-        //    of functionObject specifications.
         //  \param[in]  execution - whether the function objects should execute
         //    or not. Default: true.
         functionObjectList

src/OpenFOAM/memory/tmpNrc/tmpNrc.H

@@ -5,7 +5,7 @@
     \\  /    A nd           | www.openfoam.com
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
-    Copyright (C) 2002 OpenCFD Ltd.
+    Copyright (C) 2020 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM, distributed under GPL-3.0-or-later.

src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.C

@@ -163,11 +163,11 @@ void Foam::fanPressureFvPatchScalarField::updateCoeffs()
     else
     {
         FatalErrorInFunction
-            << "dimensions of phi are not correct"
+            << "dimensions of phi are not correct\n"
-                << "\n    on patch " << patch().name()
+            << "    on patch " << patch().name()
-                << " of field " << internalField().name()
+            << " of field " << internalField().name()
-                << " in file " << internalField().objectPath() << nl
+            << " in file " << internalField().objectPath() << nl
-                << exit(FatalError);
+            << exit(FatalError);
     }
 
     if (nonDimensional_)