Commit 281f136f authored by Andrew Heather's avatar Andrew Heather
Browse files

DOC: Fixed some doxygen complaints

parent af864cdc
......@@ -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
......
......@@ -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.
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment