From 281f136f38a78dd4f7e999ef653a30d3055c321f Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Mon, 20 Dec 2021 14:11:47 +0000
Subject: [PATCH] DOC: Fixed some doxygen complaints
---
doc/Doxygen/Doxyfile | 2 +-
doc/Doxygen/Macros/tensorOperator.sty | 5 +++--
.../variableHeatTransfer/variableHeatTransfer.H | 4 ++--
src/meshTools/sets/cellSources/boxToCell/boxToCell.H | 2 +-
src/meshTools/sets/cellSources/cellToCell/cellToCell.H | 2 +-
src/meshTools/sets/cellSources/faceToCell/faceToCell.H | 2 +-
.../sets/cellSources/faceZoneToCell/faceZoneToCell.H | 2 +-
src/meshTools/sets/cellSources/patchToCell/patchToCell.H | 2 +-
src/meshTools/sets/cellSources/pointToCell/pointToCell.H | 2 +-
src/meshTools/sets/cellSources/zoneToCell/zoneToCell.H | 2 +-
src/meshTools/sets/faceSources/boxToFace/boxToFace.H | 2 +-
src/meshTools/sets/faceSources/cellToFace/cellToFace.H | 2 +-
src/meshTools/sets/faceSources/faceToFace/faceToFace.H | 2 +-
src/meshTools/sets/faceSources/patchToFace/patchToFace.H | 2 +-
src/meshTools/sets/faceSources/pointToFace/pointToFace.H | 2 +-
src/meshTools/sets/faceSources/zoneToFace/zoneToFace.H | 2 +-
src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H | 2 +-
src/meshTools/sets/pointSources/cellToPoint/cellToPoint.H | 2 +-
src/meshTools/sets/pointSources/faceToPoint/faceToPoint.H | 2 +-
src/meshTools/sets/pointSources/pointToPoint/pointToPoint.H | 2 +-
src/meshTools/sets/pointSources/zoneToPoint/zoneToPoint.H | 2 +-
.../timeVaryingMassSorptionFvPatchScalarField.H | 4 ++--
.../CoulaloglouTavlaridesCoalescence.H | 2 +-
.../populationBalanceModel/coalescenceModels/Luo/Luo.H | 2 +-
.../radiation/radiationModels/viewFactor/viewFactor.C | 2 +-
25 files changed, 29 insertions(+), 28 deletions(-)
diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile
index f8079abb130..ee97f543f50 100644
--- a/doc/Doxygen/Doxyfile
+++ b/doc/Doxygen/Doxyfile
@@ -754,7 +754,7 @@ WARN_FORMAT = "$file:$line: $text"
# messages should be written. If left blank the output is written to standard
# error (stderr).
-WARN_LOGFILE =
+WARN_LOGFILE = Doxygen.warnings
#---------------------------------------------------------------------------
# Configuration options related to the input files
diff --git a/doc/Doxygen/Macros/tensorOperator.sty b/doc/Doxygen/Macros/tensorOperator.sty
index bd8fe685797..9232acb1868 100644
--- a/doc/Doxygen/Macros/tensorOperator.sty
+++ b/doc/Doxygen/Macros/tensorOperator.sty
@@ -54,13 +54,14 @@
\newcommand{\Hodge} {\ensuremath{\operatorname{\stackrel{\displaystyle \ast}{}}}}
\newcommand{\hyd} {\ensuremath{\operatorname{hyd}}}
-\renewcommand{\max} {\ensuremath{\operatorname{max}}}
-\renewcommand{\min} {\ensuremath{\operatorname{min}}}
+%\renewcommand{\max} {\ensuremath{\operatorname{max}}}
+%\renewcommand{\min} {\ensuremath{\operatorname{min}}}
\newcommand{\inv} {\ensuremath{\operatorname{inv}}}
\newcommand{\sym} {\ensuremath{\operatorname{symm}}} % symm ?
\newcommand{\skw} {\ensuremath{\operatorname{skew}}} % skew already defined
\newcommand{\tr} {\ensuremath{\operatorname{tr}}}
\newcommand{\trans}[1] {\ensuremath{#1^{\operatorname{T}}}}
+\newcommand{\symm}[1] {\ensuremath{frac{1}{2}\left(#1 + {#1}^T\right)}}
% alternative tensor operators for hypersonics etc.
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H
index 66606f09bf8..3b3f279e970 100644
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H
@@ -38,13 +38,13 @@ Description
The Nu number is calculated as:
\f[
- Nu = a \, \text{Re}^b \, \text{Pr}^c
+ Nu = a \, \textrm{Re}^b \, \textrm{Pr}^c
\f]
and the heat transfer coefficient as:
\f[
- htc = \frac{\text{Nu} \, K}{ds}
+ htc = \frac{\textrm{Nu} \, K}{ds}
\f]
where
diff --git a/src/meshTools/sets/cellSources/boxToCell/boxToCell.H b/src/meshTools/sets/cellSources/boxToCell/boxToCell.H
index 66758bc4d7b..1da35b00b0b 100644
--- a/src/meshTools/sets/cellSources/boxToCell/boxToCell.H
+++ b/src/meshTools/sets/cellSources/boxToCell/boxToCell.H
@@ -97,7 +97,7 @@ Usage
min | Minimum point (single box) | vector | cond'l | -
max | Maximum point (single box) | vector | cond'l | -
span | Box width (single box) | vector | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/cellSources/cellToCell/cellToCell.H b/src/meshTools/sets/cellSources/cellToCell/cellToCell.H
index 52ae643dded..1a42aa8b00d 100644
--- a/src/meshTools/sets/cellSources/cellToCell/cellToCell.H
+++ b/src/meshTools/sets/cellSources/cellToCell/cellToCell.H
@@ -86,7 +86,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input cellSets | wordList | cond'l | -
set | Name of input cellSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/cellSources/faceToCell/faceToCell.H b/src/meshTools/sets/cellSources/faceToCell/faceToCell.H
index 8e39500ba38..dbd6f18f8a3 100644
--- a/src/meshTools/sets/cellSources/faceToCell/faceToCell.H
+++ b/src/meshTools/sets/cellSources/faceToCell/faceToCell.H
@@ -98,7 +98,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input faceSets | wordList | cond'l | -
set | Name of input faceSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/cellSources/faceZoneToCell/faceZoneToCell.H b/src/meshTools/sets/cellSources/faceZoneToCell/faceZoneToCell.H
index 7bad0f2e198..a471c6f76e5 100644
--- a/src/meshTools/sets/cellSources/faceZoneToCell/faceZoneToCell.H
+++ b/src/meshTools/sets/cellSources/faceZoneToCell/faceZoneToCell.H
@@ -95,7 +95,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
zones | Names of input faceZones | wordRes | cond'l | -
zone | Name of input faceZone | wordRe | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/cellSources/patchToCell/patchToCell.H b/src/meshTools/sets/cellSources/patchToCell/patchToCell.H
index 307e3f07038..4f787642884 100644
--- a/src/meshTools/sets/cellSources/patchToCell/patchToCell.H
+++ b/src/meshTools/sets/cellSources/patchToCell/patchToCell.H
@@ -84,7 +84,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
patches | Names of patches or wildcards | wordList | cond'l | -
patch | Name of patch or wildcard | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/cellSources/pointToCell/pointToCell.H b/src/meshTools/sets/cellSources/pointToCell/pointToCell.H
index dd99adedbc6..7d5432501d8 100644
--- a/src/meshTools/sets/cellSources/pointToCell/pointToCell.H
+++ b/src/meshTools/sets/cellSources/pointToCell/pointToCell.H
@@ -95,7 +95,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input pointSets | wordList | cond'l | -
set | Name of input pointSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/cellSources/zoneToCell/zoneToCell.H b/src/meshTools/sets/cellSources/zoneToCell/zoneToCell.H
index 11f63165485..a83ce416eca 100644
--- a/src/meshTools/sets/cellSources/zoneToCell/zoneToCell.H
+++ b/src/meshTools/sets/cellSources/zoneToCell/zoneToCell.H
@@ -86,7 +86,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
zones | Names of input cellZones | wordRes | cond'l | -
zone | Name of input cellZone | wordRe | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/faceSources/boxToFace/boxToFace.H b/src/meshTools/sets/faceSources/boxToFace/boxToFace.H
index 0f81e945aec..ecd4b0b305b 100644
--- a/src/meshTools/sets/faceSources/boxToFace/boxToFace.H
+++ b/src/meshTools/sets/faceSources/boxToFace/boxToFace.H
@@ -97,7 +97,7 @@ Usage
min | Minimum point (single box) | vector | cond'l | -
max | Maximum point (single box) | vector | cond'l | -
span | Box width (single box) | vector | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/faceSources/cellToFace/cellToFace.H b/src/meshTools/sets/faceSources/cellToFace/cellToFace.H
index 66fb9eaba81..6b8fa0ed0f7 100644
--- a/src/meshTools/sets/faceSources/cellToFace/cellToFace.H
+++ b/src/meshTools/sets/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 | -
- \verbatim
+ \endverbatm
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/faceSources/faceToFace/faceToFace.H b/src/meshTools/sets/faceSources/faceToFace/faceToFace.H
index f2f432a80ee..67642a41ea9 100644
--- a/src/meshTools/sets/faceSources/faceToFace/faceToFace.H
+++ b/src/meshTools/sets/faceSources/faceToFace/faceToFace.H
@@ -86,7 +86,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input faceSets | wordList | cond'l | -
set | Name of input faceSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/faceSources/patchToFace/patchToFace.H b/src/meshTools/sets/faceSources/patchToFace/patchToFace.H
index 79ffc44e6a5..844824483d7 100644
--- a/src/meshTools/sets/faceSources/patchToFace/patchToFace.H
+++ b/src/meshTools/sets/faceSources/patchToFace/patchToFace.H
@@ -85,7 +85,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
patches | Names of patches | wordList | cond'l | -
patch | Name of patch | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/faceSources/pointToFace/pointToFace.H b/src/meshTools/sets/faceSources/pointToFace/pointToFace.H
index 170ccfd1a22..ea632bc4819 100644
--- a/src/meshTools/sets/faceSources/pointToFace/pointToFace.H
+++ b/src/meshTools/sets/faceSources/pointToFace/pointToFace.H
@@ -96,7 +96,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input pointSets | wordList | cond'l | -
set | Name of input pointSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/faceSources/zoneToFace/zoneToFace.H b/src/meshTools/sets/faceSources/zoneToFace/zoneToFace.H
index efad9bc4e7b..3369ea17db8 100644
--- a/src/meshTools/sets/faceSources/zoneToFace/zoneToFace.H
+++ b/src/meshTools/sets/faceSources/zoneToFace/zoneToFace.H
@@ -86,7 +86,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
zones | Names of input faceZones | wordRes | cond'l | -
zone | Name of input faceZone | wordRe | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H b/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H
index 3bb64d6e4e3..462c29285c2 100644
--- a/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H
+++ b/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H
@@ -97,7 +97,7 @@ Usage
min | Minimum point (single box) | vector | cond'l | -
max | Maximum point (single box) | vector | cond'l | -
span | Box width (single box) | vector | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/pointSources/cellToPoint/cellToPoint.H b/src/meshTools/sets/pointSources/cellToPoint/cellToPoint.H
index b2c7bb54ea4..7ff71fb09f7 100644
--- a/src/meshTools/sets/pointSources/cellToPoint/cellToPoint.H
+++ b/src/meshTools/sets/pointSources/cellToPoint/cellToPoint.H
@@ -93,7 +93,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input cellSets | wordList | cond'l | -
set | Name of input cellSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/pointSources/faceToPoint/faceToPoint.H b/src/meshTools/sets/pointSources/faceToPoint/faceToPoint.H
index 7d0a58f22a2..8e12ef2740e 100644
--- a/src/meshTools/sets/pointSources/faceToPoint/faceToPoint.H
+++ b/src/meshTools/sets/pointSources/faceToPoint/faceToPoint.H
@@ -94,7 +94,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input faceSets | wordList | cond'l | -
set | Name of input faceSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/pointSources/pointToPoint/pointToPoint.H b/src/meshTools/sets/pointSources/pointToPoint/pointToPoint.H
index 261181a0790..55efeceb8d5 100644
--- a/src/meshTools/sets/pointSources/pointToPoint/pointToPoint.H
+++ b/src/meshTools/sets/pointSources/pointToPoint/pointToPoint.H
@@ -86,7 +86,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
sets | Names of input pointSets | wordList | cond'l | -
set | Name of input pointSet | word | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/meshTools/sets/pointSources/zoneToPoint/zoneToPoint.H b/src/meshTools/sets/pointSources/zoneToPoint/zoneToPoint.H
index 2405fe42217..8f44db859eb 100644
--- a/src/meshTools/sets/pointSources/zoneToPoint/zoneToPoint.H
+++ b/src/meshTools/sets/pointSources/zoneToPoint/zoneToPoint.H
@@ -86,7 +86,7 @@ Usage
Entry | Description | Type | Req'd | Dflt
zones | Names of input pointZones | wordRes | cond'l | -
zone | Name of input pointZone | wordRe | cond'l | -
- \verbatim
+ \endverbatim
Note
The order of precedence among the conditional mandatory entries from the
diff --git a/src/phaseSystemModels/multiphaseInter/phasesSystem/derivedFvPatchFields/timeVaryingMassSorption/timeVaryingMassSorptionFvPatchScalarField.H b/src/phaseSystemModels/multiphaseInter/phasesSystem/derivedFvPatchFields/timeVaryingMassSorption/timeVaryingMassSorptionFvPatchScalarField.H
index 0a8a3d753e4..e054fd12dbf 100644
--- a/src/phaseSystemModels/multiphaseInter/phasesSystem/derivedFvPatchFields/timeVaryingMassSorption/timeVaryingMassSorptionFvPatchScalarField.H
+++ b/src/phaseSystemModels/multiphaseInter/phasesSystem/derivedFvPatchFields/timeVaryingMassSorption/timeVaryingMassSorptionFvPatchScalarField.H
@@ -36,11 +36,11 @@ Description
\f[
\frac{d c}{d t} =
- k_{abs} w (c_{int} - c_{p_{w}}) + k_{des} (c_{p_{w} - c_{int}})
+ k_{abs} w (c_{int} - c_{p_{w}}) + k_{des} (c_{p_{w}} - c_{int})
\f]
\f[
- w = max(1 - c_{p_{w}/max, 0);
+ w = \max(1 - c_{p_{w}}/max, 0)
\f]
where
diff --git a/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/CoulaloglouTavlaridesCoalescence/CoulaloglouTavlaridesCoalescence.H b/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/CoulaloglouTavlaridesCoalescence/CoulaloglouTavlaridesCoalescence.H
index 1a789cc5d7b..dce21a82416 100644
--- a/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/CoulaloglouTavlaridesCoalescence/CoulaloglouTavlaridesCoalescence.H
+++ b/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/CoulaloglouTavlaridesCoalescence/CoulaloglouTavlaridesCoalescence.H
@@ -33,7 +33,7 @@ Description
\f[
C_1 (v_i^{2/3} + v_j^{2/3}) (v_i^{2/9} + v_j^{2/9})^{1/2}
\frac{\epsilon_c^{1/3}}{1 + \alpha_d}
- \text{exp}
+ \textrm{exp}
\left[
- C_2 \frac{\mu_c \rho_c}{\sigma^2}
\frac{\epsilon_c}{(1 + \alpha_d)^{3}}
diff --git a/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/Luo/Luo.H b/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/Luo/Luo.H
index 5976fa6daa8..dd051de582a 100644
--- a/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/Luo/Luo.H
+++ b/src/phaseSystemModels/reactingEuler/multiphaseSystem/populationBalanceModel/coalescenceModels/Luo/Luo.H
@@ -30,7 +30,7 @@ Description
Model of Luo (1993). The coalescence rate is calculated by
\f[
- &\frac{\pi}{4} (d_i + d_j)^2 u_{ij}
+ \frac{\pi}{4} (d_i + d_j)^2 u_{ij}
\mathrm{exp}
\left[
- C_1
diff --git a/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.C b/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.C
index fbc9b9629d9..a67ec076940 100644
--- a/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.C
+++ b/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.C
@@ -613,7 +613,7 @@ void Foam::radiation::viewFactor::calculate()
if (pp.size() > 0)
{
scalarField& qrp = qrBf[patchID];
- const scalarField& sf = mesh_.magSf().boundaryField()[patchID];
+ //const scalarField& sf = mesh_.magSf().boundaryField()[patchID];
const labelList& agglom = finalAgglom_[patchID];
label nAgglom = max(agglom)+1;
--
GitLab