Commit 6a53ed41 authored by Henry Weller's avatar Henry Weller
Browse files

Doxygen documentation: Standardized the 'See also' heading

parent b3f3562d
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -32,7 +32,7 @@ Description
A simple alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField with
a fixed volumetric phase-change mass flux.
SeeAlso
See also
Foam::compressible::
alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -51,7 +51,7 @@ Description
Daejeon, Korea, September 10-12 2012
\endverbatim
SeeAlso
See also
Foam::fixedValueFvPatchField
SourceFiles
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Group
Description
Copies the boundary values from a user specified field.
SeeAlso
See also
Foam::fixedValueFvPatchField
SourceFiles
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -36,7 +36,7 @@ Description
- Set 'fixedMultiPhaseHeatFlux' boundary for one of the phases
- Use 'copiedFixedValue' for all the other phases.
SeeAlso
See also
Foam::fixedValueFvPatchField
SourceFiles
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -27,7 +27,7 @@ Application
Description
Simple tests and examples of use of FixedList
See Also
See also
Foam::FixedList
\*---------------------------------------------------------------------------*/
......
......@@ -27,7 +27,7 @@ Application
Description
Simple tests and examples of use of List
See Also
See also
Foam::List
\*---------------------------------------------------------------------------*/
......
......@@ -44,7 +44,7 @@ Note
will be used if available. Otherwise the cellZones are used when
creating the cellTable information.
See Also
See also
Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD
\*---------------------------------------------------------------------------*/
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -40,7 +40,7 @@ Description
Note
To use the \c -fixedValue option, the \c -field option should also be used
SeeAlso
See also
Foam::helpType
Foam::fvPatchField
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -33,7 +33,7 @@ Description
\c -browse \<patch type\> | open documentation for object in browser
\endplaintable
SeeAlso
See also
Foam::helpType
Foam::functionObject
......
......@@ -53,7 +53,7 @@ Usage
objectNames | objects to write | yes |
\endtable
SeeAlso
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::timeControl
......
......@@ -71,7 +71,7 @@ Usage
- one-third-octave-band PFL spectrum
- one-third-octave-band pressure spectrum
SeeAlso
See also
CSV.H
noiseFFT.H
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -41,7 +41,7 @@ Note:
The addressing is patch-local, i.e. point indices for each patch point
used for face addressing starts at index 0.
SeeAlso
See also
externalCoupledMixedFvPatchField
\*---------------------------------------------------------------------------*/
......
......@@ -43,7 +43,7 @@
#
# foamEtcFile must be found in the same directory as this script
#
# SeeAlso
# See also
# foamEtcFile
#
#------------------------------------------------------------------------------
......
......@@ -123,8 +123,8 @@ s/^ //
}
/^See *Also *$/,/^[^ ]/{
/^See *Also/c\
/^See *[Aa]lso *$/,/^[^ ]/{
/^See *[Aa]lso/c\
\\see
s/^ //
}
......
......@@ -30,7 +30,7 @@
# The prefs.csh file will be sourced by the OpenFOAM etc/cshrc when it is
# found by foamEtcFile.
#
# See Also
# See also
# 'foamEtcFile -help' or 'foamEtcFile -list' for information about the
# paths searched
#
......
......@@ -30,7 +30,7 @@
# The prefs.sh file will be sourced by the OpenFOAM etc/bashrc when it is
# found by foamEtcFile.
#
# See Also
# See also
# 'foamEtcFile -help' or 'foamEtcFile -list' for information about the
# paths searched
#
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -43,7 +43,7 @@ Description
Springer-Verlag, Berlin. 1993, ISBN 3-540-56670-8.
\endverbatim
SeeAlso
See also
Foam::RKF45
Foam::RKCK45
......
......@@ -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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -27,7 +27,7 @@ Class
Description
Starts timing CPU usage and return elapsed time from start.
SeeAlso
See also
clockTime
SourceFiles
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
The PCRE '(?i)' extension is provided to compile the regular expression
as being case-insensitive.
SeeAlso
See also
The manpage regex(7) for more information about POSIX regular expressions.
These differ somewhat from \c Perl and \c sed regular expressions.
......
......@@ -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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
The standard interupt handler is overridden to ensure that the
runningJob file is removed.
See Also
See also
Foam::JobInfo
SourceFiles
......
......@@ -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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
The standard interupt handler is overridden to ensure that the
runningJob file is removed.
See Also
See also
Foam::JobInfo
SourceFiles
......
......@@ -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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
The standard interupt handler is overridden to ensure that the
runningJob file is removed.
See Also
See also
Foam::JobInfo
SourceFiles
......
......@@ -36,7 +36,7 @@ Note
gcc 2.95.2 so it has to be instantiated for T when an instantiation of
DictionaryBase is requested
See Also
See also
Dictionary and UDictionary
SourceFiles
......
......@@ -27,7 +27,7 @@ Class
Description
A HashTable to objects of type \<T\> with a label key.
See Also
See also
PtrMap
\*---------------------------------------------------------------------------*/
......
......@@ -27,7 +27,7 @@ Class
Description
A HashTable of pointers to objects of type \<T\> with a label key.
See Also
See also
Map, HashPtrTable
\*---------------------------------------------------------------------------*/
......
......@@ -27,7 +27,7 @@ Class
Description
A List with indirect addressing.
SeeAlso
See also
Foam::UIndirectList for a version without any allocation for the
addressing.
......
......@@ -35,7 +35,7 @@ SourceFiles
PackedBoolListI.H
PackedBoolList.C
SeeAlso
See also
Foam::PackedList
\*---------------------------------------------------------------------------*/
......
......@@ -89,7 +89,7 @@ Note
\endverbatim
In both cases, the supplied indices can be randomly ordered.
SeeAlso
See also
Foam::DynamicList
SourceFiles
......
......@@ -36,7 +36,7 @@ Description
The usual expansion of environment variables and other constructs
(eg, the \c ~OpenFOAM/ expansion) is retained.
See Also
See also
fileName, string::expand()
SourceFiles
......
......@@ -51,7 +51,7 @@ Description
The usual expansion of environment variables and other constructs is
retained.
See Also
See also
findEtcFile, fileName, string::expand()
SourceFiles
......
......@@ -55,7 +55,7 @@ Description
#includeFunc mag(p)
\endverbatim
See Also
See also
Foam::functionObjectList
SourceFiles
......
......@@ -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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
The \c \#includeIfPresent directive is similar to the \c \#include
directive, but does not generate an error if the file does not exist.
See Also
See also
Foam::functionEntries::includeEntry
SourceFiles
......
......@@ -97,7 +97,7 @@ Class
Description
Abstract base-class for Time/database function objects.
See Also
See also
Foam::functionObjectList
Foam::functionObjects::timeControl
......
......@@ -28,7 +28,7 @@ Description
List of function objects with start(), execute() and end() functions
that is called for each object.
See Also
See also
Foam::functionObject
Foam::functionObjects::timeControl
......
......@@ -28,7 +28,7 @@ Description
Specialization of Foam::functionObject for a region and providing a
reference to the region Foam::objectRegistry.
SeeAlso
See also
Foam::functionObject
SourceFiles
......
......@@ -27,7 +27,7 @@ Class
Description
functionObject base class for writing single files
See Also
See also
Foam::regionFunctionObject
Foam::functionObject
......
......@@ -27,7 +27,7 @@ Class
Description
functionObject base class for writing files
See Also
See also
Foam::functionObject
Foam::OutputFilterFunctionObject
......
......@@ -71,7 +71,7 @@ Description
}
\endverbatim
SeeAlso
See also
codedFixedValueFvPatchField
SourceFiles
......
......@@ -27,7 +27,7 @@ Class
Description
A time-varying form of a uniform fixed value boundary condition.
See Also
See also
Foam::timeVaryingUniformFixedValueFvField
SourceFiles
......
......@@ -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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -27,7 +27,7 @@ Class
Description
Geometric agglomerated algebraic multigrid preconditioner.
See Also
See also
GAMGSolver for more details.
SourceFiles
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -59,7 +59,7 @@ Description
labelList plainLst(dynLst.xfer());
\endcode
SeeAlso
See also
xferCopy, xferCopyTo, xferMove, xferMoveTo, xferTmp
SourceFiles
......
......@@ -27,7 +27,7 @@ Class
Description
Reference counter for various OpenFOAM components.
SeeAlso
See also
Foam::tmp
Foam::token::compound
......
......@@ -30,7 +30,7 @@ Description
SourceFiles