Corrected documentation for Doxygen

This commit is contained in:
Henry Weller
2016-06-21 11:04:34 +01:00
parent 3990302a54
commit 7200384f18
4 changed files with 33 additions and 25 deletions

View File

@ -372,7 +372,7 @@ public:
const word& constantName = "constant"
);
//- Write time dictionary to the <time>/uniform directory
//- Write time dictionary to the \<time\>/uniform directory
virtual bool writeTimeDict() const;
//- Write using given format, version and compression

View File

@ -84,7 +84,7 @@ Description
none | Execute/write every time-step
\endtable
The sub-dictionary name \c <functionObjectName> is chosen by the user, and
The sub-dictionary name \c \<functionObjectName\> is chosen by the user, and
is typically used as the name of the output directory for any data written
by the functionObject. The \c type entry defines the type of function
object properties that follow. FunctionObjects are packaged into separate

View File

@ -27,7 +27,12 @@ Class
Description
Fixed temperature equation constraint
Sources described by:
Usage
\verbatim
fixedTemperature
{
type fixedTemperatureConstraint;
active yes;
fixedTemperatureConstraintCoeffs
{
@ -39,6 +44,8 @@ Description
// For lookup option
// T <Tname>; // optional temperature field name
}
}
\endverbatim
Note:
The 'uniform' option allows the use of a time-varying uniform temperature

View File

@ -27,6 +27,7 @@ Class
Description
Constrain the field values within a specified region.
Usage
For example to set the turbulence properties within a porous region:
\verbatim
porosityTurbulence