STYLE: Updated Doxygen comment markers

This commit is contained in:
Andrew Heather
2016-10-05 15:16:12 +01:00
parent 9ae7fd8725
commit 07bbb1852e
9 changed files with 36 additions and 36 deletions

View File

@ -117,8 +117,8 @@ public:
//- Operation mode enumeration //- Operation mode enumeration
enum operationMode enum operationMode
{ {
fixedHeatFlux, //< Fixed heat flux fixedHeatFlux, //!< Fixed heat flux
fixedHeatTransferCoeff, //< Fixed heat transfer coefficient fixedHeatTransferCoeff, //!< Fixed heat transfer coefficient
unknown unknown
}; };

View File

@ -106,8 +106,8 @@ public:
//- Region type enumeration //- Region type enumeration
enum regionTypes enum regionTypes
{ {
vrtCellZone, //< cell zone vrtCellZone, //!< cell zone
vrtAll //< all cells vrtAll //!< all cells
}; };
//- Region type names //- Region type names

View File

@ -107,11 +107,11 @@ public:
//- Operation type enumeration //- Operation type enumeration
enum operationType enum operationType
{ {
opAdd, //< Add opAdd, //!< Add
opSubtract, //< Subtract opSubtract, //!< Subtract
opMin, //< Minimum opMin, //!< Minimum
opMax, //< Maximum opMax, //!< Maximum
opAverage //< Average opAverage //!< Average
}; };
//- Operation type names //- Operation type names

View File

@ -199,21 +199,21 @@ public:
//- Operation type enumeration //- Operation type enumeration
enum operationType enum operationType
{ {
opNone, //< None opNone, //!< None
opSum, //< Sum opSum, //!< Sum
opSumMag, //< Magnitude of sum opSumMag, //!< Magnitude of sum
opSumDirection, //< Sum in a given direction opSumDirection, //!< Sum in a given direction
opSumDirectionBalance, //< Sum in a given direction for multiple opSumDirectionBalance, //!< Sum in a given direction for multiple
opAverage, //< Average opAverage, //!< Average
opWeightedAverage, //< Weighted average opWeightedAverage, //!< Weighted average
opAreaAverage, //< Area average opAreaAverage, //!< Area average
opWeightedAreaAverage, //< Weighted area average opWeightedAreaAverage, //!< Weighted area average
opAreaIntegrate, //< Area integral opAreaIntegrate, //!< Area integral
opMin, //< Minimum opMin, //!< Minimum
opMax, //< Maximum opMax, //!< Maximum
opCoV, //< Coefficient of variation opCoV, //!< Coefficient of variation
opAreaNormalAverage, //< Area average in normal direction opAreaNormalAverage, //!< Area average in normal direction
opAreaNormalIntegrate //< Area integral in normal direction opAreaNormalIntegrate //!< Area integral in normal direction
}; };
//- Operation type names //- Operation type names

View File

@ -110,9 +110,9 @@ public:
//- Face mode type //- Face mode type
enum modeType enum modeType
{ {
mdFaceZone, //< face zone mdFaceZone, //!< face zone
mdFaceZoneAndDirection, //< face zone with prescribed direction mdFaceZoneAndDirection, //!< face zone with prescribed direction
mdCellZoneAndDirection //< cell zone with prescribed direction mdCellZoneAndDirection //!< cell zone with prescribed direction
}; };
//- Mode type names //- Mode type names

View File

@ -69,9 +69,9 @@ public:
enum renderModeType enum renderModeType
{ {
rmFlat, //< Flat shading rmFlat, //!< Flat shading
rmGouraud, //< Gouraud shading rmGouraud, //!< Gouraud shading
rmPhong //< Phong shading rmPhong //!< Phong shading
}; };
static const NamedEnum<renderModeType, 3> renderModeTypeNames; static const NamedEnum<renderModeType, 3> renderModeTypeNames;

View File

@ -65,8 +65,8 @@ public:
enum representationType enum representationType
{ {
rtSphere, //< Sphere rtSphere, //!< Sphere
rtVector //< Vector rtVector //!< Vector
}; };
static const NamedEnum<representationType, 2> representationTypeNames; static const NamedEnum<representationType, 2> representationTypeNames;

View File

@ -60,8 +60,8 @@ public:
enum operatingMode enum operatingMode
{ {
omMin, //< Minimum omMin, //!< Minimum
omMax //< Maximum omMax //!< Maximum
}; };
static const NamedEnum<operatingMode, 2> operatingModeNames; static const NamedEnum<operatingMode, 2> operatingModeNames;

View File

@ -64,8 +64,8 @@ public:
// Mode type // Mode type
enum modeType enum modeType
{ {
mdMin, //< Minimum mdMin, //!< Minimum
mdMax //< Maximum mdMax //!< Maximum
}; };
static const NamedEnum<modeType, 2> modeTypeNames_; static const NamedEnum<modeType, 2> modeTypeNames_;