ENH: Doxygen docs - using Note instead of \note

This commit is contained in:
andy
2012-08-03 11:43:28 +01:00
parent db306003ab
commit d9912c2003
47 changed files with 88 additions and 91 deletions

View File

@ -44,9 +44,6 @@ Description
- base: average over 'time', or 'iteration' (\f$N\f$ in the above)
- window: optional averaging window, specified in 'base' units
\note
To employ the \c prime2Mean option, the \c mean option must be selecetd.
Average field names are constructed by concatenating the base field with
the averaging type, e.g. when averaging field 'U', the resultant fields
are:
@ -99,6 +96,9 @@ Description
}
\endverbatim
Note
To employ the \c prime2Mean option, the \c mean option must be selecetd.
SourceFiles
fieldAverage.C
fieldAverageTemplates.C

View File

@ -74,7 +74,7 @@ Description
For example, to calculate the volumetric or mass flux across a patch,
apply the 'sum' operator to the flux field (typically \c phi)
\note
Note
- faces on empty patches get ignored
- if the field is a volField the \c faceZone can only consist of boundary
faces