ENH: restructured doxygen entries for function objects

src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it under
+    the terms of the GNU General Public License as published by the Free
+    Software Foundation, either version 3 of the License, or (at your option)
+    any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+    details.
+
+    You should have received a copy of the GNU General Public License along with
+    OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\defgroup IOFunctionObjects Input/outuput function objects
+@{
+    \ingroup functionObjects
+    This group contains input/output-based function objects
+@}
+
+\*---------------------------------------------------------------------------*/

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

@@ -21,7 +21,7 @@ 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
+\addtogroup IOFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup IOFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup IOFunctionObjects
 @{
 
 Class

src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it under
+    the terms of the GNU General Public License as published by the Free
+    Software Foundation, either version 3 of the License, or (at your option)
+    any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+    details.
+
+    You should have received a copy of the GNU General Public License along with
+    OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\defgroup cloudFunctionObjects Cloud function objects
+@{
+    \ingroup functionObjects
+    This group contains cloud-based function objects
+@}
+
+\*---------------------------------------------------------------------------*/

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

@@ -21,7 +21,7 @@ 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
+\addtogroup cloudFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 class

src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it under
+    the terms of the GNU General Public License as published by the Free
+    Software Foundation, either version 3 of the License, or (at your option)
+    any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+    details.
+
+    You should have received a copy of the GNU General Public License along with
+    OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\defgroup fieldFunctionObjects Field function objects
+@{
+    \ingroup functionObjects
+    This group contains field-based function objects
+@}
+
+\*---------------------------------------------------------------------------*/

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup fieldFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup forcesFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup forcesFunctionObjects
 @{
 
 Class

src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it under
+    the terms of the GNU General Public License as published by the Free
+    Software Foundation, either version 3 of the License, or (at your option)
+    any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+    details.
+
+    You should have received a copy of the GNU General Public License along with
+    OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\defgroup forcesFunctionObjects Forces function objects
+@{
+    \ingroup functionObjects
+    This group contains force-based function objects
+@}
+
+\*---------------------------------------------------------------------------*/

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

@@ -21,7 +21,7 @@ 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
+\addtogroup jobControlFunctionObjects
 @{
 
 Class

src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it under
+    the terms of the GNU General Public License as published by the Free
+    Software Foundation, either version 3 of the License, or (at your option)
+    any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+    details.
+
+    You should have received a copy of the GNU General Public License along with
+    OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\defgroup jobControlFunctionObjects Job control function objects
+@{
+    \ingroup functionObjects
+    This group contains job control-based function objects
+@}
+
+\*---------------------------------------------------------------------------*/

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class

src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it under
+    the terms of the GNU General Public License as published by the Free
+    Software Foundation, either version 3 of the License, or (at your option)
+    any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+    details.
+
+    You should have received a copy of the GNU General Public License along with
+    OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\defgroup utilitiesFunctionObjects Utility function objects
+@{
+    \ingroup functionObjects
+    This group contains utility-based function objects
+@}
+
+\*---------------------------------------------------------------------------*/

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class

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

@@ -21,7 +21,7 @@ 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
+\addtogroup utilitiesFunctionObjects
 @{
 
 Class