From 2e399d34bc48ab3efb0d426700e7cabc5d2230ed Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Sun, 22 May 2016 21:28:24 +0100
Subject: [PATCH] functionObjects: Corrected member function documentation

---
 .../functionObjects/field/CourantNo/CourantNo.H               | 2 +-
 .../fieldCoordinateSystemTransform.H                          | 4 ++--
 .../functionObjects/field/vorticity/vorticity.H               | 2 +-
 src/postProcessing/functionObjects/utilities/yPlus/yPlus.C    | 2 +-
 src/postProcessing/functionObjects/utilities/yPlus/yPlus.H    | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/postProcessing/functionObjects/field/CourantNo/CourantNo.H b/src/postProcessing/functionObjects/field/CourantNo/CourantNo.H
index 1e20c5e58..e1d76c304 100644
--- a/src/postProcessing/functionObjects/field/CourantNo/CourantNo.H
+++ b/src/postProcessing/functionObjects/field/CourantNo/CourantNo.H
@@ -106,7 +106,7 @@ public:
         //- Read the CourantNo data
         virtual bool read(const dictionary&);
 
-        //- Execute, currently does nothing
+        //- Calculate the Courant number
         virtual bool execute(const bool postProcess = false);
 };
 
diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
index d22b461c9..633292f65 100644
--- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
+++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
@@ -148,10 +148,10 @@ public:
         //- Read the input data
         virtual bool read(const dictionary&);
 
-        //- Execute, currently does nothing
+        //- Calculate the transformed fields
         virtual bool execute(const bool postProcess = false);
 
-        //- Write
+        //- Write the transformed fields
         virtual bool write(const bool postProcess = false);
 };
 
diff --git a/src/postProcessing/functionObjects/field/vorticity/vorticity.H b/src/postProcessing/functionObjects/field/vorticity/vorticity.H
index 6d8a360ec..1b93fe7b9 100644
--- a/src/postProcessing/functionObjects/field/vorticity/vorticity.H
+++ b/src/postProcessing/functionObjects/field/vorticity/vorticity.H
@@ -83,7 +83,7 @@ public:
 
     // Member Functions
 
-        //- Execute, currently does nothing
+        //- Calculate the vorticity field
         virtual bool execute(const bool postProcess = false);
 };
 
diff --git a/src/postProcessing/functionObjects/utilities/yPlus/yPlus.C b/src/postProcessing/functionObjects/utilities/yPlus/yPlus.C
index d49d91e50..d02936e1f 100644
--- a/src/postProcessing/functionObjects/utilities/yPlus/yPlus.C
+++ b/src/postProcessing/functionObjects/utilities/yPlus/yPlus.C
@@ -254,7 +254,7 @@ bool Foam::functionObjects::yPlus::write(const bool postProcess)
     const volScalarField& yPlus =
         obr_.lookupObject<volScalarField>(type());
 
-    if (log_) Info<< "    writing field " << yPlus.name() << nl << endl;
+    if (log_) Info<< "    writing field " << yPlus.name() << endl;
 
     yPlus.write();
 
diff --git a/src/postProcessing/functionObjects/utilities/yPlus/yPlus.H b/src/postProcessing/functionObjects/utilities/yPlus/yPlus.H
index c1f72dfbe..b529b99b6 100644
--- a/src/postProcessing/functionObjects/utilities/yPlus/yPlus.H
+++ b/src/postProcessing/functionObjects/utilities/yPlus/yPlus.H
@@ -120,10 +120,10 @@ public:
         //- Read the yPlus data
         virtual bool read(const dictionary&);
 
-        //- Execute, currently does nothing
+        //- Calculate the yPlus field
         virtual bool execute(const bool postProcess = false);
 
-        //- Calculate the yPlus and write
+        //- Write the yPlus field
         virtual bool write(const bool postProcess = false);
 };