From c5782af04be5eac490a6b1434524eb8bbe35221f Mon Sep 17 00:00:00 2001 From: Erik Smistad Date: Wed, 30 Aug 2023 14:53:56 +0200 Subject: [PATCH] Added documentation of two enums --- .../Algorithms/ImageResampler/IsotropicResampler.hpp | 10 +++++----- .../Algorithms/NeuralNetwork/ImageToImageNetwork.hpp | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/source/FAST/Algorithms/ImageResampler/IsotropicResampler.hpp b/source/FAST/Algorithms/ImageResampler/IsotropicResampler.hpp index 28f1fd1dd..f714f1df7 100644 --- 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 index 0379e7315..ee07d6445 100644 --- 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