Added documentation of two enums

smistad · Aug 30, 2023 · c5782af · c5782af
1 parent 4f1163d
commit c5782af
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/source/FAST/Algorithms/ImageResampler/IsotropicResampler.hpp b/source/FAST/Algorithms/ImageResampler/IsotropicResampler.hpp
@@ -27,11 +27,11 @@ class FAST_EXPORT IsotropicResampler : public ImageResampler {
      * @brief Which spacing to select
      */
     enum class SpacingSelector {
-        SMALLEST = 0,   // Select smallest spacing
-        LARGEST,        // Select largest spacing
-        X,              // Select X spacing always
-        Y,              // Select Y spacing always
-        Z               // Select Z spacing always
+        SMALLEST = 0,   /**< Select smallest spacing */
+        LARGEST,        /**< Select largest spacing */
+        X,              /**< Select X spacing always */
+        Y,              /**< Select Y spacing always */
+        Z               /**< Select Z spacing always */
     };
     /**
      * @brief Create instance

diff --git a/source/FAST/Algorithms/NeuralNetwork/ImageToImageNetwork.hpp b/source/FAST/Algorithms/NeuralNetwork/ImageToImageNetwork.hpp
@@ -22,9 +22,9 @@ class FAST_EXPORT ImageToImageNetwork : public NeuralNetwork {
         /** @brief Normalization method of image after each iteration
          */
         enum class Normalization {
-            CLIP_0_1 = 0, // Clip image intensities at 0 and 1
-            CLIP_0_SQUEEZE, // Clip image intensities at 0 and squeeze intensity range if max is above 1.0
-            NONE, // No normalization
+            CLIP_0_1 = 0,      /**< Clip image intensities at 0 and 1 */
+            CLIP_0_SQUEEZE,    /**< Clip image intensities at 0 and squeeze intensity range if max is above 1.0 */
+            NONE,              /**< No normalization */
         };
         /**
          * @brief Create instance