STYLE: trailing whitespace, doxygen, error messages from fileOperation

bin/tools/git-find-trailingspace

@@ -1,16 +1,13 @@
-#!/bin/bash
+#!/bin/sh
 #------------------------------------------------------------------------------
 # Script
-#     find-trailingspace
+#     git-find-trailingspace
 #
 # Description
-#     Search for files with trailing whitesapce
+#     Use git grep to search for files with trailing whitespace
 #
 #------------------------------------------------------------------------------
-cd $WM_PROJECT_DIR || exit 1
 
-tab=$'\t'
-
-git grep -c -E "[ $tab]+"'$' -- $@
+git grep -c -P '\s+$' -- $@
 
 #------------------------------------------------------------------------------

doc/tools/README

@@ -1,15 +0,0 @@
-Misc. tools for finding and/or repairing common documentation problems
-See the comments in the scripts.
-
-1.  find-suspiciousTags
-2.  fix-Class
-3.  find-tinyDescription
-4.  find-placeholderDescription
-5.  find-retagged
-
-Misc Tools
-1.  find-templateInComments
-2.  find-its
-3.  find-junkFiles
-4.  find-longlines
-

src/OpenFOAM/global/fileOperations/collatedFileOperation/collatedFileOperation.C

@@ -227,12 +227,6 @@ Foam::fileOperations::collatedFileOperation::collatedFileOperation
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::fileOperations::collatedFileOperation::~collatedFileOperation()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 Foam::fileName Foam::fileOperations::collatedFileOperation::objectPath

src/OpenFOAM/global/fileOperations/collatedFileOperation/collatedFileOperation.H

@@ -99,7 +99,7 @@ public:
 
 
     //- Destructor
-    virtual ~collatedFileOperation();
+    virtual ~collatedFileOperation() = default;
 
 
     // Member Functions

src/OpenFOAM/global/fileOperations/fileOperation/fileOperation.C

@@ -54,10 +54,10 @@ namespace Foam
             false
         )
     );
-
-    word fileOperation::processorsDir = "processors";
 }
 
+Foam::word Foam::fileOperation::processorsDir = "processors";
+
 
 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
 
@@ -143,30 +143,25 @@ bool Foam::fileOperation::isFileOrDir(const bool isFile, const fileName& f)
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
-Foam::fileOperation::fileOperation()
-{}
-
-
 Foam::autoPtr<Foam::fileOperation> Foam::fileOperation::New
 (
-    const word& type,
+    const word& handlerType,
     const bool verbose
 )
 {
     if (debug)
     {
-        InfoInFunction << "Constructing fileOperation" << endl;
+        InfoInFunction << "Constructing fileHandler" << endl;
     }
 
-    wordConstructorTable::iterator cstrIter =
-        wordConstructorTablePtr_->find(type);
+    auto cstrIter = wordConstructorTablePtr_->cfind(handlerType);
 
-    if (cstrIter == wordConstructorTablePtr_->end())
+    if (!cstrIter.found())
     {
         FatalErrorInFunction
-            << "Unknown fileOperation type "
-            << type << nl << nl
-            << "Valid fileOperation types are" << endl
+            << "Unknown fileHandler type "
+            << handlerType << nl << nl
+            << "Valid fileHandler types :" << endl
             << wordConstructorTablePtr_->sortedToc()
             << abort(FatalError);
     }
@@ -175,12 +170,6 @@ Foam::autoPtr<Foam::fileOperation> Foam::fileOperation::New
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::fileOperation::~fileOperation()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 Foam::fileName Foam::fileOperation::objectPath
@@ -278,11 +267,9 @@ Foam::fileName Foam::fileOperation::filePath(const fileName& fName) const
     {
         return fName;
     }
-    else
-    {
+
     return fileName::null;
 }
-}
 
 
 Foam::label Foam::fileOperation::addWatch(const fileName& fName) const

src/OpenFOAM/global/fileOperations/fileOperation/fileOperation.H

@@ -24,6 +24,15 @@ License
 Class
     Foam::fileOperation
 
+Description
+    An encapsulation of filesystem-related operations.
+
+Namespace
+    Foam::fileOperations
+
+Description
+    Namespace for implementations of a fileOperation
+
 \*---------------------------------------------------------------------------*/
 
 #ifndef fileOperation_H
@@ -75,7 +84,7 @@ public:
 
     // Static data
 
-        //- Return the processors directory name (usually "processors")
+        //- The processors directory name (usually "processors")
         static word processorsDir;
 
         //- Default fileHandler
@@ -108,7 +117,7 @@ public:
     // Constructors
 
         //- Construct null
-        fileOperation();
+        fileOperation() = default;
 
 
     // Declare run-time constructor selection table
@@ -127,12 +136,16 @@ public:
 
     // Selectors
 
-        //- Select type
-        static autoPtr<fileOperation> New(const word& type, const bool verbose);
+        //- Select fileHandler-type
+        static autoPtr<fileOperation> New
+        (
+            const word& handlerType,
+            const bool verbose
+        );
 
 
     //- Destructor
-    virtual ~fileOperation();
+    virtual ~fileOperation() = default;
 
 
     // Member Functions

src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.C

@@ -489,13 +489,6 @@ masterUncollatedFileOperation
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::fileOperations::masterUncollatedFileOperation::
-~masterUncollatedFileOperation()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::fileOperations::masterUncollatedFileOperation::mkDir

src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.H

@@ -427,7 +427,7 @@ public:
 
 
     //- Destructor
-    virtual ~masterUncollatedFileOperation();
+    virtual ~masterUncollatedFileOperation() = default;
 
 
     // Member Functions

src/OpenFOAM/global/fileOperations/uncollatedFileOperation/uncollatedFileOperation.C

@@ -161,12 +161,6 @@ Foam::fileOperations::uncollatedFileOperation::uncollatedFileOperation
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::fileOperations::uncollatedFileOperation::~uncollatedFileOperation()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::fileOperations::uncollatedFileOperation::mkDir

src/OpenFOAM/global/fileOperations/uncollatedFileOperation/uncollatedFileOperation.H

@@ -77,7 +77,7 @@ public:
 
 
     //- Destructor
-    virtual ~uncollatedFileOperation();
+    virtual ~uncollatedFileOperation() = default;
 
 
     // Member Functions