zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: First pass through doxygen info updates for function objects

Browse Source
This commit is contained in:
andy
2012-07-11 12:26:08 +01:00
parent 5ebb8dc482
commit 354d0ae7ce
30 changed files with 147 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

8
src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/processorField/processorField.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/readFields/readFields.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/streamLine/streamLine.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
View File

@ -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
@}
\*---------------------------------------------------------------------------*/