ENH: First pass through doxygen info updates for function objects

src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::partialWrite
 
@@ -33,6 +36,7 @@ Description
 SourceFiles
     partialWrite.C
     IOpartialWrite.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::removeRegisteredObject
 
@@ -30,6 +33,7 @@ Description
 SourceFiles
     removeRegisteredObject.C
     IOremoveRegisteredObject.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::writeRegisteredObject
 
@@ -30,6 +33,7 @@ Description
 SourceFiles
     writeRegisteredObject.C
     IOwriteRegisteredObject.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H

@@ -21,19 +21,22 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::cloudInfo
 
 Description
-    Outputs cloud information to file
+    This function object outputs lagrangian cloud information to a file.  The
-
+    current outputs include:
-    Currently outputs:
+    - total current number of parcels
-        - total current number of parcels
+    - total current mass of parcels
-        - total current mass of parcels
 
 SourceFiles
     cloudInfo.C
     IOcloudInfo.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::fieldAverage
 
@@ -79,6 +82,7 @@ Description
 SourceFiles
     fieldAverage.C
     fieldAverageTemplates.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,7 +21,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
+\addtogroup functionObjects
+@{
+
+class
     Foam::fieldCoordinateSystemTransform
 
 Description
@@ -31,6 +34,7 @@ Description
 SourceFiles
     fieldCoordinateSystemTransform.C
     IOfieldCoordinateSystemTransform.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::fieldMinMax
 
@@ -36,6 +39,7 @@ Description
 SourceFiles
     fieldMinMax.C
     IOfieldMinMax.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::fieldValue
 
@@ -29,6 +32,7 @@ Description
 
 SourceFiles
     fieldValue.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::nearWallFields
 
@@ -53,6 +56,7 @@ Description
 SourceFiles
     nearWallFields.C
     IOnearWallFields.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/processorField/processorField.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::processorField
 
@@ -31,6 +34,7 @@ Description
 SourceFiles
     processorField.C
     IOprocessorField.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/readFields/readFields.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::readFields
 
@@ -31,6 +34,7 @@ Description
 SourceFiles
     readFields.C
     IOreadFields.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::regionSizeDistribution
 
@@ -33,6 +36,7 @@ Description
 
 SourceFiles
     regionSizeDistribution.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/streamLine/streamLine.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::streamLine
 
@@ -29,6 +32,7 @@ Description
 
 SourceFiles
     streamLine.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::surfaceInterpolateFields
 
@@ -49,6 +52,7 @@ Description
 SourceFiles
     surfaceInterpolateFields.C
     IOsurfaceInterpolateFields.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::turbulenceFields
 
@@ -34,6 +37,7 @@ Description
 
 SourceFiles
     turbulenceFields.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::wallBoundedStreamLine
 
@@ -29,6 +32,7 @@ Description
 
 SourceFiles
     wallBoundedStreamLine.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::forceCoeffs
 
@@ -31,6 +34,7 @@ Description
 SourceFiles
     forceCoeffs.C
     IOforceCoeffs.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/forces/forces/forces.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::forces
 
@@ -51,6 +54,7 @@ Note
 SourceFiles
     forces.C
     IOforces.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::abortCalculation
 
@@ -36,6 +39,7 @@ Description
 SourceFiles
     abortCalculation.C
     IOabortCalculation.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/systemCall/systemCall.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::systemCall
 
@@ -30,6 +33,7 @@ Description
 SourceFiles
     systemCall.C
     IOsystemCall.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::codedFunctionObject
 
@@ -29,6 +32,7 @@ Description
 
 SourceFiles
     codedFunctionObject.C
+@}
 
 \*---------------------------------------------------------------------------*/
 
@@ -90,6 +94,7 @@ protected:
         // Get the dictionary to initialize the codeContext
         virtual const dictionary& codeDict() const;
 
+
 private:
 
         //- Disallow default bitwise copy construct

src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::dsmcFields
 
@@ -35,6 +38,7 @@ Description
 SourceFiles
     dsmcFields.C
     IOdsmcFields.H
+@}
 
 \*---------------------------------------------------------------------------*/
 
@@ -69,6 +73,7 @@ class dsmcFields
         //- on/off switch
         bool active_;
 
+
     // Private Member Functions
 
         //- Disallow default bitwise copy construct

src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H

@@ -21,13 +21,18 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::pressureCoefficient
 
 Description
-    Calculates pressure coefficient, c_p
+    Calculates pressure coefficient, \f$c_p\f$
 
-        c_p = p/p_dyn,inf
+        \f[
+            c_p = p/p_{dyn,inf}
+        \f]
 
     where:
 
@@ -36,6 +41,7 @@ Description
 SourceFiles
     pressureCoefficient.C
     IOpressureCoefficient.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::staticPressure
 
@@ -33,6 +36,7 @@ Description
 SourceFiles
     staticPressure.C
     IOstaticPressure.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::timeActivatedFileUpdate
 
@@ -50,6 +53,7 @@ Description
 SourceFiles
     timeActivatedFileUpdate.C
     IOtimeActivatedFileUpdate.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::yPlusLES
 
@@ -31,6 +34,7 @@ Description
 SourceFiles
     yPlusLES.C
     IOyPlusLES.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::yPlusRAS
 
@@ -31,6 +34,7 @@ Description
 SourceFiles
     yPlusRAS.C
     IOyPlusRAS.H
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/sampling/probes/probes.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::probes
 
@@ -31,6 +34,7 @@ Description
 
 SourceFiles
     probes.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/sampling/sampledSet/sampledSet/sampledSet.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::sampledSet
 
@@ -35,6 +38,7 @@ Description
 
 SourceFiles
     sampledSet.C
+@}
 
 \*---------------------------------------------------------------------------*/
 

src/sampling/sampledSurface/sampledSurface/sampledSurface.H

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+\addtogroup functionObjects
+@{
+
 Class
     Foam::sampledSurface
 
@@ -43,6 +46,7 @@ Description
 SourceFiles
     sampledSurface.C
     sampledSurfaceTemplates.C
+@}
 
 \*---------------------------------------------------------------------------*/