From 61eaea8b81599feee11f4f6437343a0d95600eb6 Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 11 Jul 2012 14:02:11 +0100 Subject: [PATCH] ENH: restructured doxygen entries for function objects --- .../functionObjects/IO/IOFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../IO/partialWrite/partialWrite.H | 2 +- .../removeRegisteredObject.H | 2 +- .../writeRegisteredObject.H | 2 +- .../cloud/cloudFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../cloud/cloudInfo/cloudInfo.H | 2 +- .../fieldAverage/fieldAverage/fieldAverage.H | 2 +- .../fieldCoordinateSystemTransform.H | 2 +- .../field/fieldFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../field/fieldMinMax/fieldMinMax.H | 2 +- .../field/fieldValues/fieldValue/fieldValue.H | 2 +- .../field/nearWallFields/nearWallFields.H | 2 +- .../field/processorField/processorField.H | 2 +- .../field/readFields/readFields.H | 2 +- .../regionSizeDistribution.H | 2 +- .../field/streamLine/streamLine.H | 2 +- .../surfaceInterpolateFields.H | 2 +- .../field/turbulenceFields/turbulenceFields.H | 2 +- .../wallBoundedStreamLine.H | 2 +- .../forces/forceCoeffs/forceCoeffs.H | 2 +- .../functionObjects/forces/forces/forces.H | 2 +- .../forces/forcesFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../abortCalculation/abortCalculation.H | 2 +- .../jobControl/jobControlFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../codedFunctionObject/codedFunctionObject.H | 2 +- .../utilities/dsmcFields/dsmcFields.H | 2 +- .../pressureCoefficient/pressureCoefficient.H | 2 +- .../utilities/staticPressure/staticPressure.H | 2 +- .../timeActivatedFileUpdate.H | 2 +- .../utilities/utilitiesFunctionObjectsDoc.H | 30 +++++++++++++++++++ .../utilities/yPlusLES/yPlusLES.H | 2 +- .../utilities/yPlusRAS/yPlusRAS.H | 2 +- 32 files changed, 206 insertions(+), 26 deletions(-) create mode 100644 src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H create mode 100644 src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H diff --git a/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H b/src/postProcessing/functionObjects/IO/IOFunctionObjectsDoc.H new file mode 100644 index 0000000000..70daa827dc --- /dev/null +++ b/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 . + +\defgroup IOFunctionObjects Input/outuput function objects +@{ + \ingroup functionObjects + This group contains input/output-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index 4c25bf7460..d34a0462ed 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/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 . -\addtogroup functionObjects +\addtogroup IOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index dd0a4211f2..b773fb9a7f 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/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 . -\addtogroup functionObjects +\addtogroup IOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index c4eb8d5c58..a646e171af 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/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 . -\addtogroup functionObjects +\addtogroup IOFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H b/src/postProcessing/functionObjects/cloud/cloudFunctionObjectsDoc.H new file mode 100644 index 0000000000..861ec1597c --- /dev/null +++ b/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 . + +\defgroup cloudFunctionObjects Cloud function objects +@{ + \ingroup functionObjects + This group contains cloud-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index 2e95f56a58..0342de2196 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/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 . -\addtogroup functionObjects +\addtogroup cloudFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index c56fda7685..17184c407b 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 696618bb3f..0d6bf886c1 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ class diff --git a/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H b/src/postProcessing/functionObjects/field/fieldFunctionObjectsDoc.H new file mode 100644 index 0000000000..89354bbb53 --- /dev/null +++ b/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 . + +\defgroup fieldFunctionObjects Field function objects +@{ + \ingroup functionObjects + This group contains field-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 71d155b193..92f2224cf8 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index ca765d8f64..b591c809c9 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 7815857b5c..5ed2009877 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index cdbb8a98e4..0884e31ef6 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index d7bf664fd3..772b6b8eda 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index e51f4729bc..2704dbc858 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index b912caf0c4..abbb974413 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index 97839a198e..10bc0cbdaf 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index a82f53b290..85a0cd2227 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 12d19f8d62..38847c1266 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/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 . -\addtogroup functionObjects +\addtogroup fieldFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index a6342f86e8..b90ff9ee9d 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/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 . -\addtogroup functionObjects +\addtogroup forcesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index bae6652c3a..15fd54ebdf 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/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 . -\addtogroup functionObjects +\addtogroup forcesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/forces/forcesFunctionObjectsDoc.H new file mode 100644 index 0000000000..43130004c3 --- /dev/null +++ b/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 . + +\defgroup forcesFunctionObjects Forces function objects +@{ + \ingroup functionObjects + This group contains force-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index ddabedf35b..9d4db70ae2 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/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 . -\addtogroup functionObjects +\addtogroup jobControlFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H b/src/postProcessing/functionObjects/jobControl/jobControlFunctionObjectsDoc.H new file mode 100644 index 0000000000..3dd25c6fed --- /dev/null +++ b/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 . + +\defgroup jobControlFunctionObjects Job control function objects +@{ + \ingroup functionObjects + This group contains job control-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 2c2dfe8306..8b8e8c9934 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index e197cc6924..f780c13b54 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 8cf05389cb..690a32d927 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index 5de19c4583..480cb661e9 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index b350f012a1..6b59273e7a 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/utilities/utilitiesFunctionObjectsDoc.H new file mode 100644 index 0000000000..b51693bedf --- /dev/null +++ b/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 . + +\defgroup utilitiesFunctionObjects Utility function objects +@{ + \ingroup functionObjects + This group contains utility-based function objects +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index d353e9bf9c..f45d018457 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 2a2c03ea1c..c40d8b2182 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/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 . -\addtogroup functionObjects +\addtogroup utilitiesFunctionObjects @{ Class