From e96990c8bf1c3840fc1fdb3fe42e2aaf0ae876c9 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Fri, 17 Jun 2022 11:47:42 +0100
Subject: [PATCH] DOC: Doxygen corrections
---
src/OpenFOAM/db/IOobject/IOobject.C | 2 +-
src/OpenFOAM/db/IOstreams/output/FlatOutput.H | 1 -
src/OpenFOAM/dimensionSet/dimensionSets.C | 2 +-
src/OpenFOAM/expressions/exprDriver/exprDriverIO.C | 2 +-
src/OpenFOAM/expressions/exprTools/exprTools.C | 2 +-
src/conversion/ccm/common/ccmInternal.C | 2 +-
src/conversion/ccm/reader/ccmBoundaryInfo.H | 2 +-
.../forces/propellerInfo/propellerInfo.H | 8 ++++----
.../patchMeanVelocityForce/patchMeanVelocityForce.H | 1 +
.../topoSet/faceSources/cellToFace/cellToFace.H | 2 +-
.../adjoint/objectives/objective/objective.H | 6 ++----
.../NURBS/NURBS3DSurface/NURBS3DSurface.C | 12 ++++++------
12 files changed, 20 insertions(+), 22 deletions(-)
diff --git a/src/OpenFOAM/db/IOobject/IOobject.C b/src/OpenFOAM/db/IOobject/IOobject.C
index 0654d28772e..803c53dece9 100644
--- a/src/OpenFOAM/db/IOobject/IOobject.C
+++ b/src/OpenFOAM/db/IOobject/IOobject.C
@@ -96,7 +96,7 @@ registerOptSwitch
);
-//! \cond file-scope
+//! \cond file_scope
namespace Foam
{
// Register re-reader
diff --git a/src/OpenFOAM/db/IOstreams/output/FlatOutput.H b/src/OpenFOAM/db/IOstreams/output/FlatOutput.H
index 5abbc3de9ce..4737d942feb 100644
--- a/src/OpenFOAM/db/IOstreams/output/FlatOutput.H
+++ b/src/OpenFOAM/db/IOstreams/output/FlatOutput.H
@@ -122,7 +122,6 @@ makeDecorator(SquareSpace,'[',']', ' ');
//
// \endcode
//
-// \noop
template<class Container, class Delimiters>
class OutputAdaptor
{
diff --git a/src/OpenFOAM/dimensionSet/dimensionSets.C b/src/OpenFOAM/dimensionSet/dimensionSets.C
index 9089c4dc124..159d6878cc2 100644
--- a/src/OpenFOAM/dimensionSet/dimensionSets.C
+++ b/src/OpenFOAM/dimensionSet/dimensionSets.C
@@ -45,7 +45,7 @@ dictionary* dimensionSystemsPtr_(nullptr);
HashTable<dimensionedScalar>* unitSetPtr_(nullptr);
dimensionSets* writeUnitSetPtr_(nullptr);
-//! \cond file-scope
+//! \cond file_scope
// Helper class to
// register re-reader
diff --git a/src/OpenFOAM/expressions/exprDriver/exprDriverIO.C b/src/OpenFOAM/expressions/exprDriver/exprDriverIO.C
index 93960cf4140..97eda4f0a24 100644
--- a/src/OpenFOAM/expressions/exprDriver/exprDriverIO.C
+++ b/src/OpenFOAM/expressions/exprDriver/exprDriverIO.C
@@ -34,7 +34,7 @@ License
namespace Foam
{
-//! \cond file-scope
+//! \cond file_scope
// Write list as single or multiple entries - see exprTools::getList()
static void writeList
(
diff --git a/src/OpenFOAM/expressions/exprTools/exprTools.C b/src/OpenFOAM/expressions/exprTools/exprTools.C
index 111d295ab82..ffe42a3db67 100644
--- a/src/OpenFOAM/expressions/exprTools/exprTools.C
+++ b/src/OpenFOAM/expressions/exprTools/exprTools.C
@@ -38,7 +38,7 @@ Note
namespace Foam
{
-//! \cond file-scope
+//! \cond file_scope
// Maximum depth for recursive variable names
static constexpr label maxRecursionDepth_ = 100;
diff --git a/src/conversion/ccm/common/ccmInternal.C b/src/conversion/ccm/common/ccmInternal.C
index 2be5cdc0e1c..cb57492e2ab 100644
--- a/src/conversion/ccm/common/ccmInternal.C
+++ b/src/conversion/ccm/common/ccmInternal.C
@@ -39,7 +39,7 @@ defineTypeNameAndDebug(ccm, 0);
// * * * * * * * * * * * * * * Static Functions * * * * * * * * * * * * * * //
-// \cond file-scope
+// \cond file_scope
// Return the string corresponding to the error
static const char* errorMsg(CCMIOError err)
{
diff --git a/src/conversion/ccm/reader/ccmBoundaryInfo.H b/src/conversion/ccm/reader/ccmBoundaryInfo.H
index 5879ade6c20..85b9ba8698a 100644
--- a/src/conversion/ccm/reader/ccmBoundaryInfo.H
+++ b/src/conversion/ccm/reader/ccmBoundaryInfo.H
@@ -36,7 +36,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-//! \cond internal-use
+//! \cond internal_use
// internal use only - skip doxygen documentation
namespace Foam
{
diff --git a/src/functionObjects/forces/propellerInfo/propellerInfo.H b/src/functionObjects/forces/propellerInfo/propellerInfo.H
index 63725c2a4c4..dfd464f0f81 100644
--- a/src/functionObjects/forces/propellerInfo/propellerInfo.H
+++ b/src/functionObjects/forces/propellerInfo/propellerInfo.H
@@ -38,18 +38,18 @@ Description
- Torque coefficient, 10*Kq
- Advance coefficient, J
- Open water efficiency, etaO
- - Written to postProcessing/<name>/<time>/propellerPerformance.dat
+ - Written to postProcessing/\<name\>/\<time\>/propellerPerformance.dat
Controlled by writeControl:
- Wake field text file
- Wake: 1 - UzMean/URef
- Velocity in cylindrical coordinates at xyz locations
- - Written to postProcessing/<name>/<time>/wake.dat
+ - Written to postProcessing/\<name\>/\<time\>/wake.dat
- Axial wake field text file
- 1 - Uz/URef at r/R and angle
- - Written to postProcessing/<name>/<time>/axialWake.dat
+ - Written to postProcessing/\<name\>/\<time\>/axialWake.dat
- Velocity surface
- - Written to postProcessing/<name>/surfaces/time>/disk.<fileType>
+ - Written to postProcessing/\<name\>/surfaces/\<time\>/disk.<fileType>
Usage
Example of function object specification:
diff --git a/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H b/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H
index 8a77be7fd7f..76b22302644 100644
--- a/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H
+++ b/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H
@@ -53,6 +53,7 @@ Usage
// Mandatory/Optional (inherited) entries
...
}
+ \endverbatim
where the entries mean:
\table
diff --git a/src/meshTools/topoSet/faceSources/cellToFace/cellToFace.H b/src/meshTools/topoSet/faceSources/cellToFace/cellToFace.H
index 6b8fa0ed0f7..c9ce52b0fdf 100644
--- a/src/meshTools/topoSet/faceSources/cellToFace/cellToFace.H
+++ b/src/meshTools/topoSet/faceSources/cellToFace/cellToFace.H
@@ -94,7 +94,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input cellSets | wordList | cond'l | -
set | Name of input cellSet | word | cond'l | -
- \endverbatm
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/optimisation/adjointOptimisation/adjoint/objectives/objective/objective.H b/src/optimisation/adjointOptimisation/adjoint/objectives/objective/objective.H
index b290784f0ec..49f3d46343d 100644
--- a/src/optimisation/adjointOptimisation/adjoint/objectives/objective/objective.H
+++ b/src/optimisation/adjointOptimisation/adjoint/objectives/objective/objective.H
@@ -98,12 +98,10 @@ protected:
//- Contribution to field sensitivity derivatives
// Topology optimisation or other variants with
// as many design variables as the mesh cells
- //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
autoPtr<volScalarField> dJdbPtr_;
// Contribution to surface sensitivity derivatives
- //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- Term from material derivative
autoPtr<boundaryVectorField> bdJdbPtr_;
@@ -129,7 +127,7 @@ protected:
// Contribution to volume-based sensitivities from volume-based
// objective functions
- //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- Multiplier of d(Volume)/db
autoPtr<volScalarField> divDxDbMultPtr_;
diff --git a/src/optimisation/adjointOptimisation/adjoint/parameterization/NURBS/NURBS3DSurface/NURBS3DSurface.C b/src/optimisation/adjointOptimisation/adjoint/parameterization/NURBS/NURBS3DSurface/NURBS3DSurface.C
index 25758e30bf2..855fd3fd0a3 100644
--- a/src/optimisation/adjointOptimisation/adjoint/parameterization/NURBS/NURBS3DSurface/NURBS3DSurface.C
+++ b/src/optimisation/adjointOptimisation/adjoint/parameterization/NURBS/NURBS3DSurface/NURBS3DSurface.C
@@ -653,7 +653,7 @@ void NURBS3DSurface::buildSurface()
<< "\nuNCPs: " << uNCPs << "\nvNCPs: " << vNCPs
<< "\nNURBSSurface:\nCPs: " << CPs
<< endl;
-//*/
+*/
vectorField& field = *this;
field = vector::zero;
@@ -800,7 +800,7 @@ void NURBS3DSurface::makeEquidistant
Info<< "Making points equidistant is physical space on surface "
<< name_
<< endl;
-//*/
+*/
// Equidistant spacing in u along v isoLines.
for (label vI = 0; vI<nVPts_; vI++)
{
@@ -1295,7 +1295,7 @@ List<scalarList> NURBS3DSurface::genEquidistant
Info<< "Generating points equidistant in physical space on surface "
<< name_
<< endl;
-//*/
+*/
// Preset U and V with uniform values.
List<scalarList> UV(NPARAMS, scalarList(0));
@@ -2151,7 +2151,7 @@ void NURBS3DSurface::write(const word fileName)
curveFileBases << endl;
}
-//*/
+*/
}
}
@@ -2208,7 +2208,7 @@ void NURBS3DSurface::write(const fileName dirName, const fileName fileName)
curveFileBases << endl;
}
-//*/
+*/
}
}
@@ -2273,7 +2273,7 @@ void NURBS3DSurface::writeWParses(const word fileName)
curveFileBases << endl;
}
-//*/
+*/
}
}
--
GitLab