From 3e29b9c3aa25cc7b91c817c63d1f35a1d7a18459 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 11 Sep 2018 12:13:19 +0100
Subject: [PATCH] BUG: Doxygen corrections
---
.../phasesSystem/phasePair/phasePair/phasePair.H | 6 +++---
.../containers/Bits/PackedList/PackedList.H | 3 +--
.../functionObject/functionObject.H | 2 +-
.../hostCollatedFileOperation.H | 6 +++---
.../masterUncollatedFileOperation.H | 9 +++++----
.../meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H | 1 +
.../primitives/functions/Function1/Table/Table.H | 6 ++++++
.../primitives/strings/stringOps/stringOps.H | 16 ++++++++--------
src/combustionModels/EDC/EDC.H | 2 +-
.../solutionControl/loopControl/loopControl.H | 1 +
.../turbulentDFSEMInletFvPatchVectorField.H | 4 ++--
src/functionObjects/field/CourantNo/CourantNo.H | 2 +-
.../field/DESModelRegions/DESModelRegions.H | 2 +-
src/functionObjects/field/PecletNo/PecletNo.H | 2 +-
src/functionObjects/field/Q/Q.H | 2 +-
.../field/blendingFactor/blendingFactor.H | 2 +-
.../field/fluxSummary/fluxSummary.H | 2 +-
src/functionObjects/field/mapFields/mapFields.H | 2 +-
src/functionObjects/field/reference/reference.H | 4 ++--
.../stabilityBlendingFactor.H | 15 +++++++--------
.../solvers/scalarTransport/scalarTransport.H | 1 +
src/overset/include/setCellMask.H | 4 ----
src/overset/include/setInterpolatedCells.H | 4 ----
23 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/phasesSystem/phasePair/phasePair/phasePair.H b/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/phasesSystem/phasePair/phasePair/phasePair.H
index 413bda2b045..02dd12e2b1c 100644
--- a/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/phasesSystem/phasePair/phasePair/phasePair.H
+++ b/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/phasesSystem/phasePair/phasePair/phasePair.H
@@ -22,11 +22,11 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::phasePair description for mass transfer between a pair of
- phases. The direction of the mass transfer is from the phase
- 'from' to the phasse 'to'.
+ Foam::phasePair
Description
+ Description for mass transfer between a pair of phases. The direction of
+ the mass transfer is from the phase 'from' to the phasse 'to'.
SourceFiles
phasePair.C
diff --git a/src/OpenFOAM/containers/Bits/PackedList/PackedList.H b/src/OpenFOAM/containers/Bits/PackedList/PackedList.H
index 700ffb6db52..bfd1dc4f779 100644
--- a/src/OpenFOAM/containers/Bits/PackedList/PackedList.H
+++ b/src/OpenFOAM/containers/Bits/PackedList/PackedList.H
@@ -155,7 +155,7 @@ public:
// \code
// (numElem / elem_per_block)
// + (numElem % elem_per_block) ? 1 : 0
- // \code
+ // \endcode
// But avoiding the modulus operation
static constexpr label num_blocks(label numElem)
{
@@ -471,7 +471,6 @@ public:
Ostream& os,
const PackedList<Width>& list
);
-
};
diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
index 6bd43b8c9e6..7d19a907cae 100644
--- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
+++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
@@ -32,7 +32,7 @@ Description
field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c -postProcess command-line option.
- \subsection secFunctionObjects Using function objects
+ \section secFunctionObjects Using function objects
FunctionObjects are selected by additional entries in the
$FOAM_CASE/system/controlDict dictionary. Each object is listed in the \c
diff --git a/src/OpenFOAM/global/fileOperations/collatedFileOperation/hostCollatedFileOperation.H b/src/OpenFOAM/global/fileOperations/collatedFileOperation/hostCollatedFileOperation.H
index 4d61b622b24..9571c3d67fe 100644
--- a/src/OpenFOAM/global/fileOperations/collatedFileOperation/hostCollatedFileOperation.H
+++ b/src/OpenFOAM/global/fileOperations/collatedFileOperation/hostCollatedFileOperation.H
@@ -29,9 +29,9 @@ Description
In parallel it will assume ranks are sorted according to hostname
and the lowest rank per hostname will be the IO rank. The output directories
- will get a unique name processors<N>_<low>-<high> where N is the overall
- number of processors and low and high is the range of ranks contained
- in the files. Each of these subsets uses its own communicator.
+ will get a unique name processors\<N\>_\<low\>-\<high\> where N is the
+ overall number of processors and low and high is the range of ranks
+ contained in the files. Each of these subsets uses its own communicator.
Instead of using the hostnames the IO ranks can be assigned using the
FOAM_IORANKS environment variable (also when running non-parallel), e.g.
diff --git a/src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.H b/src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.H
index 77eba09a7c7..b709d3fba0a 100644
--- a/src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.H
+++ b/src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.H
@@ -28,8 +28,9 @@ Description
fileOperations that performs all file operations on the master processor.
Requires the calls to be parallel synchronised!
- Limitations: - no /processor in filename
- - no /uniform/ in the filename
+ Limitations
+ - no /processor in filename
+ - no /uniform/ in the filename
The main logic is in ::filePath which returns a
- same path on all processors. This can either be a global file
@@ -40,12 +41,12 @@ Description
- different path on all processors (processor0/0/p)
system/controlDict:
- filePath worldmaster: <globalRoot>/system/controlDict
+ filePath worldmaster: \<globalRoot\>/system/controlDict
localmaster: ,,
slave : ,,
processor0/uniform/time
- filePath worldmaster: <globalRoot>/processorXXX/uniform/time
+ filePath worldmaster: \<globalRoot\>/processorXXX/uniform/time
localmaster: ,,
slave : ,,
diff --git a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H
index 59d1d220526..94e03c15756 100644
--- a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H
@@ -231,6 +231,7 @@ public:
//
// if (nOrig == zones.size()) { existing... } else { new... }
// \endcode
+ // \param zoneName the name of the zone
// \param verbose report if an existing zone was selected or
// a new zone was created.
// \return non-const reference to the existing or new zone
diff --git a/src/OpenFOAM/primitives/functions/Function1/Table/Table.H b/src/OpenFOAM/primitives/functions/Function1/Table/Table.H
index ae7066f96e5..d46a53e00b0 100644
--- a/src/OpenFOAM/primitives/functions/Function1/Table/Table.H
+++ b/src/OpenFOAM/primitives/functions/Function1/Table/Table.H
@@ -86,6 +86,12 @@ public:
//- Copy constructor
explicit Table(const Table<Type>& tbl);
+ //- Construct and return a clone
+ virtual tmp<Function1<Type>> clone() const
+ {
+ return tmp<Function1<Type>>(new Table<Type>(*this));
+ }
+
//- Destructor
virtual ~Table();
diff --git a/src/OpenFOAM/primitives/strings/stringOps/stringOps.H b/src/OpenFOAM/primitives/strings/stringOps/stringOps.H
index 6a483affa24..85414c90087 100644
--- a/src/OpenFOAM/primitives/strings/stringOps/stringOps.H
+++ b/src/OpenFOAM/primitives/strings/stringOps/stringOps.H
@@ -218,10 +218,10 @@ namespace stringOps
// -# current directory
// - leading "./" : the current directory
// -# leading tag expansion for commonly used directories
- // - <etc>/ : user/group/other OpenFOAM directory
- // - <case>/ : FOAM_CASE directory
- // - <constant>/ : FOAM_CASE/constant directory
- // - <system>/ : FOAM_CASE/system directory
+ // - \<etc\>/ : user/group/other OpenFOAM directory
+ // - \<case\>/ : FOAM_CASE directory
+ // - \<constant\>/ : FOAM_CASE/constant directory
+ // - \<system\>/ : FOAM_CASE/system directory
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
@@ -258,10 +258,10 @@ namespace stringOps
// -# current directory
// - leading "./" : the current directory
// -# leading tag expansion for commonly used directories
- // - <etc>/ : user/group/other OpenFOAM directory
- // - <case>/ : FOAM_CASE directory
- // - <constant>/ : FOAM_CASE/constant directory
- // - <system>/ : FOAM_CASE/system directory
+ // - \<etc\>/ : user/group/other OpenFOAM directory
+ // - \<case\>/ : FOAM_CASE directory
+ // - \<constant\>/ : FOAM_CASE/constant directory
+ // - \<system\>/ : FOAM_CASE/system directory
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
diff --git a/src/combustionModels/EDC/EDC.H b/src/combustionModels/EDC/EDC.H
index 5cda96b6f6e..fdddde56be4 100644
--- a/src/combustionModels/EDC/EDC.H
+++ b/src/combustionModels/EDC/EDC.H
@@ -35,7 +35,7 @@ Description
There are many versions and developments of the EDC model, 4 of which are
currently supported in this implementation: v1981, v1996, v2005 and
v2016. The model variant is selected using the optional \c version entry in
- the \c EDCCoeffs dictionary, \eg
+ the \c EDCCoeffs dictionary, e.g.
\verbatim
EDCCoeffs
diff --git a/src/finiteVolume/cfdTools/general/solutionControl/loopControl/loopControl.H b/src/finiteVolume/cfdTools/general/solutionControl/loopControl/loopControl.H
index 2190a00502d..42b206080f6 100644
--- a/src/finiteVolume/cfdTools/general/solutionControl/loopControl/loopControl.H
+++ b/src/finiteVolume/cfdTools/general/solutionControl/loopControl/loopControl.H
@@ -45,6 +45,7 @@ Usage
}
}
}
+ \endverbatim
Where the loop entries comprise:
\table
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H
index 2903f2002b8..31767113fe2 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H
@@ -45,8 +45,8 @@ Description
except that no interpolation in time is supported. These should be
located in the directory:
- \$FOAM_CASE/constant/boundaryData/<patchName>/points
- \$FOAM_CASE/constant/boundaryData/<patchName>/0/\{R|U|L\}
+ \$FOAM_CASE/constant/boundaryData/\<patchName\>/points
+ \$FOAM_CASE/constant/boundaryData/\<patchName\>/0/\{R|U|L\}
Usage
diff --git a/src/functionObjects/field/CourantNo/CourantNo.H b/src/functionObjects/field/CourantNo/CourantNo.H
index 26c467525e3..f65e61048cb 100644
--- a/src/functionObjects/field/CourantNo/CourantNo.H
+++ b/src/functionObjects/field/CourantNo/CourantNo.H
@@ -49,7 +49,7 @@ Usage
type | Type name: CourantNo | yes |
rho | Name of density field | no | rho
field | Name of flux field | no | phi
- result | Name of Courant number field | no | <function name>
+ result | Name of Courant number field | no | \<function name\>
log | Log to standard output | no | yes
\endtable
diff --git a/src/functionObjects/field/DESModelRegions/DESModelRegions.H b/src/functionObjects/field/DESModelRegions/DESModelRegions.H
index 8119b9d738b..6223bcb4a43 100644
--- a/src/functionObjects/field/DESModelRegions/DESModelRegions.H
+++ b/src/functionObjects/field/DESModelRegions/DESModelRegions.H
@@ -51,7 +51,7 @@ Usage
\table
Property | Description | Required | Default value
type | type name: DESModelRegions| yes |
- resultName | Name of DES indicator field | no | <function name>
+ resultName | Name of DES indicator field | no | \<function name\>
log | log to standard output | no | yes
\endtable
diff --git a/src/functionObjects/field/PecletNo/PecletNo.H b/src/functionObjects/field/PecletNo/PecletNo.H
index bb6bf485970..a52904fff5a 100644
--- a/src/functionObjects/field/PecletNo/PecletNo.H
+++ b/src/functionObjects/field/PecletNo/PecletNo.H
@@ -47,7 +47,7 @@ Usage
type | type name: Peclet | yes |
phi | Name of flux field | no | phi
rho | Name of density field | no | rho
- result | Name of Peclet field | no | <function name>
+ result | Name of Peclet field | no | \<function name\>
log | Log to standard output | no | yes
\endtable
diff --git a/src/functionObjects/field/Q/Q.H b/src/functionObjects/field/Q/Q.H
index ca2cc1b7445..4bf3a08199e 100644
--- a/src/functionObjects/field/Q/Q.H
+++ b/src/functionObjects/field/Q/Q.H
@@ -56,7 +56,7 @@ Usage
Property | Description | Required | Default value
type | type name: Q | yes |
U | Name of velocity field | no | U
- result | Name of Q field | no | <function name>
+ result | Name of Q field | no | \<function name\>
log | Log to standard output | no | yes
\endtable
diff --git a/src/functionObjects/field/blendingFactor/blendingFactor.H b/src/functionObjects/field/blendingFactor/blendingFactor.H
index cac6b782d9e..4db4dec3d0c 100644
--- a/src/functionObjects/field/blendingFactor/blendingFactor.H
+++ b/src/functionObjects/field/blendingFactor/blendingFactor.H
@@ -42,7 +42,7 @@ Description
The factor is a face-based quantity, which is converted to a cell-based
quantity by assigning the minimum blending factor for any cell face.
- An indicator (volume) field, named <functionObjectName>:<fieldName>, is
+ An indicator (volume) field, named \<functionObjectName\>:\<fieldName\>, is
generated that is set to (1 - f), i.e. values of:
- 0 represent scheme1 as active, and
- 1 represent scheme2 as active.
diff --git a/src/functionObjects/field/fluxSummary/fluxSummary.H b/src/functionObjects/field/fluxSummary/fluxSummary.H
index 1677d826a01..324ce7c4733 100644
--- a/src/functionObjects/field/fluxSummary/fluxSummary.H
+++ b/src/functionObjects/field/fluxSummary/fluxSummary.H
@@ -71,7 +71,7 @@ Usage
- surface
- surfaceAndDirection
- Output data is written to files of the form \<timeDir\>/<faceZoneName>.dat
+ Output data is written to files of the form \<timeDir\>/\<faceZoneName\>.dat
See also
Foam::functionObjects::fvMeshFunctionObject
diff --git a/src/functionObjects/field/mapFields/mapFields.H b/src/functionObjects/field/mapFields/mapFields.H
index fa5fc85151a..4d80b1baa77 100644
--- a/src/functionObjects/field/mapFields/mapFields.H
+++ b/src/functionObjects/field/mapFields/mapFields.H
@@ -53,7 +53,7 @@ Usage
type | Type name: mapFields | yes |
mapRegion | Name of region to map to | yes |
mapMethod | Mapping method | yes |
- patchMapMethod | Patch mapping method | no | <auto>
+ patchMapMethod | Patch mapping method | no | \<auto\>
consistent | Mapping meshes have consistent boundaries | yes |
fields | List of field names to map | yes |
log | Log to standard output | no | yes
diff --git a/src/functionObjects/field/reference/reference.H b/src/functionObjects/field/reference/reference.H
index 07621cdd6ed..d1dd0c36f45 100644
--- a/src/functionObjects/field/reference/reference.H
+++ b/src/functionObjects/field/reference/reference.H
@@ -67,8 +67,8 @@ Usage
Property | Description | Required | Default value
type | Type name: reference | yes |
field | Name of field | yes |
- result | Name of result field | no | reference(<field>)
- position | Position to sample | no | <not used>
+ result | Name of result field | no | reference(\<field\>)
+ position | Position to sample | no | \<not used\>
scale | Scale value | no | 1
offset | Offset value | no | zero
log | Log to standard output | no | yes
diff --git a/src/functionObjects/field/stabilityBlendingFactor/stabilityBlendingFactor.H b/src/functionObjects/field/stabilityBlendingFactor/stabilityBlendingFactor.H
index 98776a4d2a7..9d58a323fd2 100644
--- a/src/functionObjects/field/stabilityBlendingFactor/stabilityBlendingFactor.H
+++ b/src/functionObjects/field/stabilityBlendingFactor/stabilityBlendingFactor.H
@@ -63,7 +63,7 @@ Description
),
1.0
)
- \f[
+ \f]
For option 2, the following relation is used:
\f[
@@ -78,7 +78,7 @@ Description
),
1.0
)
- \f[
+ \f]
Note that magGradCC is equal to 3 for ortoghonal meshes
For option 3 a PID control is used in order to control residual
@@ -89,14 +89,14 @@ Description
P*residual
+ I*residualIntegral
+ D*residualDifferential
- \f[
+ \f]
where P, I and D are user inputs
The following relation is used:
\f[
fRes = (factor - meanRes)/(maxRes*meanRes);
- \f[
+ \f]
where:
meanRes = average(residual)
@@ -120,7 +120,7 @@ Description
),
1.0
)
- \f[
+ \f]
Note that faceWeights for a orthogonal mesh is 0.5.
@@ -138,7 +138,7 @@ Description
),
1.0
)
- \f[
+ \f]
For option 6 , the following relation is used:
@@ -275,8 +275,7 @@ Usage
tolerance | Tolerance for number of blended cells | no | 0.001
field | Name of field to evaluate | yes |
result | Name of surface field to be used in the localBlended scheme
- | yes
-
+ | yes |
\endtable
The 'log' flag true write the number of cells on each scheme, plus it
diff --git a/src/functionObjects/solvers/scalarTransport/scalarTransport.H b/src/functionObjects/solvers/scalarTransport/scalarTransport.H
index df11dabe423..bed7201e690 100644
--- a/src/functionObjects/solvers/scalarTransport/scalarTransport.H
+++ b/src/functionObjects/solvers/scalarTransport/scalarTransport.H
@@ -48,6 +48,7 @@ Description
Usage
Example of function object specification to solve a scalar transport
equation:
+ \verbatim
functions
{
scalar1
diff --git a/src/overset/include/setCellMask.H b/src/overset/include/setCellMask.H
index 92e187ee596..1a57b79b668 100644
--- a/src/overset/include/setCellMask.H
+++ b/src/overset/include/setCellMask.H
@@ -21,13 +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/>.
-Class
-
Description
Sets blocked cells mask field
-SourceFiles
-
\*---------------------------------------------------------------------------*/
{
diff --git a/src/overset/include/setInterpolatedCells.H b/src/overset/include/setInterpolatedCells.H
index 6b3cac9e854..d33755e96a2 100644
--- a/src/overset/include/setInterpolatedCells.H
+++ b/src/overset/include/setInterpolatedCells.H
@@ -21,13 +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/>.
-Class
-
Description
Sets blocked cells mask field
-SourceFiles
-
\*---------------------------------------------------------------------------*/
{
--
GitLab