Doxygen documentation: Use C++-style comments for enumeration elements

src/OpenFOAM/db/Time/Time.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -101,10 +101,10 @@ public:
         //- Stop-run control options
         enum stopAtControls
         {
-            saEndTime,    /*!< stop when Time reaches the prescribed endTime */
-            saNoWriteNow, /*!< set endTime to stop immediately w/o writing */
-            saWriteNow,   /*!< set endTime to stop immediately w/ writing */
-            saNextWrite   /*!< stop the next time data are written */
+            saEndTime,    //!< stop when Time reaches the prescribed endTime
+            saNoWriteNow, //!< set endTime to stop immediately w/o writing
+            saWriteNow,   //!< set endTime to stop immediately w/ writing
+            saNextWrite   //!< stop the next time data are written
         };
 
         //- Supported time directory name formats

src/OpenFOAM/db/functionObjects/outputFilterOutputControl/outputFilterOutputControl.C

@@ -107,7 +107,7 @@ void Foam::outputFilterOutputControl::read(const dictionary& dict)
         case ocClockTime:
         case ocRunTime:
         case ocCpuTime:
-        case ocAdjustableTime:
+        case ocAdjustableRunTime:
         {
             writeInterval_ = readScalar(dict.lookup("writeInterval"));
             break;
@@ -147,7 +147,7 @@ bool Foam::outputFilterOutputControl::output()
         }
 
         case ocRunTime:
-        case ocAdjustableTime:
+        case ocAdjustableRunTime:
         {
             label outputIndex = label
             (

src/OpenFOAM/db/functionObjects/outputFilterOutputControl/outputFilterOutputControl.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2013 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -56,13 +56,13 @@ public:
     //- The output control options
     enum outputControls
     {
-        ocTimeStep,       /*!< execution is coupled to the time-step */
-        ocOutputTime,     /*!< execution is coupled to the output-time */
-        ocAdjustableTime, /*!< Adjust time step for dumping */
-        ocRunTime,        /*!< run time for dumping */
-        ocClockTime,      /*!< clock time for dumping */
-        ocCpuTime,        /*!< cpu time for dumping */
-        ocNone            /*!< no output */
+        ocTimeStep,           //!< execution is coupled to the time-step
+        ocOutputTime,         //!< execution is coupled to the output-time
+        ocAdjustableRunTime,  //!< Adjust time step for dumping
+        ocRunTime,            //!< run time for dumping
+        ocClockTime,          //!< clock time for dumping
+        ocCpuTime,            //!< cpu time for dumping
+        ocNone                //!< no output
     };
 
 
@@ -86,7 +86,8 @@ private:
         //  a value <= 1 means execute at every time step
         label outputInterval_;
 
-        //- Dumping counter for ocOutputTime or index dump for ocAdjustableTime
+        //- Dumping counter for ocOutputTime or index dump
+        //  for ocAdjustableRunTime
         label outputTimeLastDump_;
 
         //- Dump each deltaT (adjust Ttime)

src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.H

@@ -61,9 +61,9 @@ public:
         //- Enumeration for handling out-of-bound values
         enum boundsHandling
         {
-            ERROR,          /*!< Exit with a FatalError */
-            WARN,           /*!< Issue warning and clamp value (default) */
-            CLAMP           /*!< Clamp value to the start/end value */
+            ERROR,          //!< Exit with a FatalError
+            WARN,           //!< Issue warning and clamp value (default)
+            CLAMP           //!< Clamp value to the start/end value
         };
 
         //- Cconvenience typedef

src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H

@@ -88,10 +88,10 @@ public:
         //- Enumeration for handling out-of-bound values
         enum boundsHandling
         {
-            ERROR,          /*!< Exit with a FatalError */
-            WARN,           /*!< Issue warning and clamp value (default) */
-            CLAMP,          /*!< Clamp value to the start/end value */
-            REPEAT          /*!< Treat as a repeating list */
+            ERROR,          //!< Exit with a FatalError
+            WARN,           //!< Issue warning and clamp value (default)
+            CLAMP,          //!< Clamp value to the start/end value
+            REPEAT          //!< Treat as a repeating list
         };
 
 

src/OpenFOAM/primitives/functions/Function1/Table/TableBase.H

@@ -64,10 +64,10 @@ public:
         //- Enumeration for handling out-of-bound values
         enum boundsHandling
         {
-            ERROR,          /*!< Exit with a FatalError */
-            WARN,           /*!< Issue warning and clamp value (default) */
-            CLAMP,          /*!< Clamp value to the start/end value */
-            REPEAT          /*!< Treat as a repeating list */
+            ERROR,          //!< Exit with a FatalError
+            WARN,           //!< Issue warning and clamp value (default)
+            CLAMP,          //!< Clamp value to the start/end value
+            REPEAT          //!< Treat as a repeating list
         };
 
 

src/OpenFOAM/primitives/strings/wordRe/wordRe.H

@@ -95,10 +95,10 @@ public:
         //  Note that 'REGEXP' is implicit if 'NOCASE' is specified alone.
         enum compOption
         {
-            LITERAL = 0, /*!< treat as a string literal */
-            DETECT  = 1, /*!< treat as regular expression */
-            REGEXP  = 2, /*!< detect if the string contains meta-characters */
-            NOCASE  = 4, /*!< ignore case in regular expression */
+            LITERAL = 0, //!< treat as a string literal
+            DETECT  = 1, //!< treat as regular expression
+            REGEXP  = 2, //!< detect if the string contains meta-characters
+            NOCASE  = 4, //!< ignore case in regular expression
             DETECT_NOCASE = DETECT | NOCASE,
             REGEXP_NOCASE = REGEXP | NOCASE
         };

src/mesh/snappyHexMesh/meshRefinement/meshRefinement.H

@@ -137,9 +137,9 @@ public:
         //- Enumeration for how the userdata is to be mapped upon refinement.
         enum mapType
         {
-            MASTERONLY = 1, /*!< maintain master only */
-            KEEPALL = 2,    /*!< have slaves (upon refinement) from master */
-            REMOVE = 4      /*!< set value to -1 any face that was refined */
+            MASTERONLY = 1, //!< maintain master only
+            KEEPALL = 2,    //!< have slaves (upon refinement) from master
+            REMOVE = 4      //!< set value to -1 any face that was refined
         };
 
 

src/mesh/snappyHexMesh/snappyHexMeshDriver/snappyLayerDriver.H

@@ -64,10 +64,10 @@ public:
         //- Extrusion controls
         enum extrudeMode
         {
-            NOEXTRUDE,      /*!< Do not extrude. No layers added. */
-            EXTRUDE,        /*!< Extrude */
-            EXTRUDEREMOVE   /*!< Extrude but afterwards remove added */
-                            /*!< faces locally */
+            NOEXTRUDE,      //!< Do not extrude. No layers added.
+            EXTRUDE,        //!< Extrude
+            EXTRUDEREMOVE   //!< Extrude but afterwards remove added
+                            //!< faces locally
         };
 
 private:

src/postProcessing/functionObjects/utilities/abort/abort.H

@@ -73,9 +73,9 @@ public:
         //- Enumeration defining the type of action
         enum actionType
         {
-            noWriteNow,    /*!< stop immediately without writing data */
-            writeNow,      /*!< write data and stop immediately */
-            nextWrite      /*!< stop the next time data are written */
+            noWriteNow,    //!< stop immediately without writing data
+            writeNow,      //!< write data and stop immediately
+            nextWrite      //!< stop the next time data are written
         };
 
 private: