From 07bbb1852eecc55b0cb72dcf326921034e49aa4c Mon Sep 17 00:00:00 2001
From: Andrew Heather <andy@shelob.opencfd.co.uk>
Date: Wed, 5 Oct 2016 15:16:12 +0100
Subject: [PATCH] STYLE: Updated Doxygen comment markers
---
...allHeatFluxTemperatureFvPatchScalarField.H | 4 +--
.../functionObjects/volRegion/volRegion.H | 4 +--
.../fieldValueDelta/fieldValueDelta.H | 10 +++----
.../surfaceFieldValue/surfaceFieldValue.H | 30 +++++++++----------
.../field/fluxSummary/fluxSummary.H | 6 ++--
.../runTimePostProcessing/geometryBase.H | 6 ++--
.../runTimePostProcessing/pointData.H | 4 +--
.../equationInitialResidualCondition.H | 4 +--
.../minMaxCondition/minMaxCondition.H | 4 +--
9 files changed, 36 insertions(+), 36 deletions(-)
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
index 0e36d26701a..a253a040f4f 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
@@ -117,8 +117,8 @@ public:
//- Operation mode enumeration
enum operationMode
{
- fixedHeatFlux, //< Fixed heat flux
- fixedHeatTransferCoeff, //< Fixed heat transfer coefficient
+ fixedHeatFlux, //!< Fixed heat flux
+ fixedHeatTransferCoeff, //!< Fixed heat transfer coefficient
unknown
};
diff --git a/src/finiteVolume/functionObjects/volRegion/volRegion.H b/src/finiteVolume/functionObjects/volRegion/volRegion.H
index 78972545ce6..d466a131410 100644
--- a/src/finiteVolume/functionObjects/volRegion/volRegion.H
+++ b/src/finiteVolume/functionObjects/volRegion/volRegion.H
@@ -106,8 +106,8 @@ public:
//- Region type enumeration
enum regionTypes
{
- vrtCellZone, //< cell zone
- vrtAll //< all cells
+ vrtCellZone, //!< cell zone
+ vrtAll //!< all cells
};
//- Region type names
diff --git a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
index 5a9687f53fc..97bc9377842 100644
--- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
+++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
@@ -107,11 +107,11 @@ public:
//- Operation type enumeration
enum operationType
{
- opAdd, //< Add
- opSubtract, //< Subtract
- opMin, //< Minimum
- opMax, //< Maximum
- opAverage //< Average
+ opAdd, //!< Add
+ opSubtract, //!< Subtract
+ opMin, //!< Minimum
+ opMax, //!< Maximum
+ opAverage //!< Average
};
//- Operation type names
diff --git a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
index 963d60ce740..c17e6513fe3 100644
--- a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
+++ b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
@@ -199,21 +199,21 @@ public:
//- Operation type enumeration
enum operationType
{
- opNone, //< None
- opSum, //< Sum
- opSumMag, //< Magnitude of sum
- opSumDirection, //< Sum in a given direction
- opSumDirectionBalance, //< Sum in a given direction for multiple
- opAverage, //< Average
- opWeightedAverage, //< Weighted average
- opAreaAverage, //< Area average
- opWeightedAreaAverage, //< Weighted area average
- opAreaIntegrate, //< Area integral
- opMin, //< Minimum
- opMax, //< Maximum
- opCoV, //< Coefficient of variation
- opAreaNormalAverage, //< Area average in normal direction
- opAreaNormalIntegrate //< Area integral in normal direction
+ opNone, //!< None
+ opSum, //!< Sum
+ opSumMag, //!< Magnitude of sum
+ opSumDirection, //!< Sum in a given direction
+ opSumDirectionBalance, //!< Sum in a given direction for multiple
+ opAverage, //!< Average
+ opWeightedAverage, //!< Weighted average
+ opAreaAverage, //!< Area average
+ opWeightedAreaAverage, //!< Weighted area average
+ opAreaIntegrate, //!< Area integral
+ opMin, //!< Minimum
+ opMax, //!< Maximum
+ opCoV, //!< Coefficient of variation
+ opAreaNormalAverage, //!< Area average in normal direction
+ opAreaNormalIntegrate //!< Area integral in normal direction
};
//- Operation type names
diff --git a/src/functionObjects/field/fluxSummary/fluxSummary.H b/src/functionObjects/field/fluxSummary/fluxSummary.H
index eab9df9c24b..0300b65c9fb 100644
--- a/src/functionObjects/field/fluxSummary/fluxSummary.H
+++ b/src/functionObjects/field/fluxSummary/fluxSummary.H
@@ -110,9 +110,9 @@ public:
//- Face mode type
enum modeType
{
- mdFaceZone, //< face zone
- mdFaceZoneAndDirection, //< face zone with prescribed direction
- mdCellZoneAndDirection //< cell zone with prescribed direction
+ mdFaceZone, //!< face zone
+ mdFaceZoneAndDirection, //!< face zone with prescribed direction
+ mdCellZoneAndDirection //!< cell zone with prescribed direction
};
//- Mode type names
diff --git a/src/functionObjects/graphics/runTimePostProcessing/geometryBase.H b/src/functionObjects/graphics/runTimePostProcessing/geometryBase.H
index d1dc8a6a26b..1163d70a89b 100644
--- a/src/functionObjects/graphics/runTimePostProcessing/geometryBase.H
+++ b/src/functionObjects/graphics/runTimePostProcessing/geometryBase.H
@@ -69,9 +69,9 @@ public:
enum renderModeType
{
- rmFlat, //< Flat shading
- rmGouraud, //< Gouraud shading
- rmPhong //< Phong shading
+ rmFlat, //!< Flat shading
+ rmGouraud, //!< Gouraud shading
+ rmPhong //!< Phong shading
};
static const NamedEnum<renderModeType, 3> renderModeTypeNames;
diff --git a/src/functionObjects/graphics/runTimePostProcessing/pointData.H b/src/functionObjects/graphics/runTimePostProcessing/pointData.H
index 1ced613bd5a..41c425e4aad 100644
--- a/src/functionObjects/graphics/runTimePostProcessing/pointData.H
+++ b/src/functionObjects/graphics/runTimePostProcessing/pointData.H
@@ -65,8 +65,8 @@ public:
enum representationType
{
- rtSphere, //< Sphere
- rtVector //< Vector
+ rtSphere, //!< Sphere
+ rtVector //!< Vector
};
static const NamedEnum<representationType, 2> representationTypeNames;
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
index cbf53d276e6..85dc192476b 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
@@ -60,8 +60,8 @@ public:
enum operatingMode
{
- omMin, //< Minimum
- omMax //< Maximum
+ omMin, //!< Minimum
+ omMax //!< Maximum
};
static const NamedEnum<operatingMode, 2> operatingModeNames;
diff --git a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
index 8729530b7c2..27cbe4356d7 100644
--- a/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
+++ b/src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
@@ -64,8 +64,8 @@ public:
// Mode type
enum modeType
{
- mdMin, //< Minimum
- mdMax //< Maximum
+ mdMin, //!< Minimum
+ mdMax //!< Maximum
};
static const NamedEnum<modeType, 2> modeTypeNames_;
--
GitLab