DOC: fixing "unbalanced grouping commands" warnings

Fixes after second test

Author: albert-github

Examples/IO/XML/itkParticleSwarmOptimizerSAXReader.cxx

@@ -27,7 +27,6 @@ namespace itk
 /**
  * Check that whether the file with given name is readable.
  */
-/** @ITKStartGrouping */
 int
 ParticleSwarmOptimizerSAXReader::CanReadFile(const char * name)
 {
@@ -39,11 +38,10 @@ ParticleSwarmOptimizerSAXReader::CanReadFile(const char * name)
   }
   return yes;
 }
-/**@ITKEndGrouping*/
+
 /**
  * Method called when a new xml tag start is encountered.
  */
-/** @ITKStartGrouping */
 void
 ParticleSwarmOptimizerSAXReader::StartElement(const char *  name,
                                               const char ** atts)
@@ -57,7 +55,7 @@ ParticleSwarmOptimizerSAXReader::StartElement(const char *  name,
            this->ContextIs("/optimizer"))
   {
     std::vector<double> * bound = nullptr;
-/**@ITKEndGrouping*/
+
     const char * id = this->GetAttribute(atts, "id");
     if (id == nullptr)
     {
@@ -90,7 +88,6 @@ ParticleSwarmOptimizerSAXReader::StartElement(const char *  name,
 /**
  * Method called when an xml tag end is encountered.
  */
-/** @ITKStartGrouping */
 void
 ParticleSwarmOptimizerSAXReader::EndElement(const char * name)
 {
@@ -108,7 +105,6 @@ ParticleSwarmOptimizerSAXReader::EndElement(const char * name)
       bounds.push_back(value);
     }
     this->m_OutputObject->SetParameterBounds(bounds);
-/**@ITKEndGrouping*/
     this->m_OutputObject->SetParametersConvergenceTolerance(
       this->m_ParametersConvergenceTolerance);
   }
@@ -160,7 +156,6 @@ ParticleSwarmOptimizerSAXReader::CharacterDataHandler(const char * inData,
 /**
  * Method for performing XML reading and output generation.
  */
-/** @ITKStartGrouping */
 int
 ParticleSwarmOptimizerSAXReader::ReadFile()
 {
@@ -178,7 +173,6 @@ ParticleSwarmOptimizerSAXReader::ReadFile()
       e.SetDescription(message.c_str());
       throw e;
     }
-/**@ITKEndGrouping*/
     if (this->m_OutputObject == nullptr)
     {
       itkExceptionMacro("Object to be read is null!\n");
@@ -198,7 +192,6 @@ ParticleSwarmOptimizerSAXReader::ReadFile()
 }
 
 /** Process tag 'optimizer' attributes. */
-/** @ITKStartGrouping */
 void
 ParticleSwarmOptimizerSAXReader::ProcessOptimizerAttributes(
   const char **            atts,
@@ -262,9 +255,8 @@ ParticleSwarmOptimizerSAXReader::ProcessOptimizerAttributes(
     }
   }
 }
-/**@ITKEndGrouping*/
+
 /** Process tag 'bound' attributes. */
-/** @ITKStartGrouping */
 void
 ParticleSwarmOptimizerSAXReader::ProcessBoundAttributes(
   const char **         atts,
@@ -290,9 +282,8 @@ ParticleSwarmOptimizerSAXReader::ProcessBoundAttributes(
     } // end if
   } // end for
 }
-/**@ITKEndGrouping*/
+
 /** Search for and return a particular attribute from the attribute list. */
-/** @ITKStartGrouping */
 const char *
 ParticleSwarmOptimizerSAXReader::GetAttribute(const char ** atts,
                                               const char *  key)
@@ -307,9 +298,7 @@ ParticleSwarmOptimizerSAXReader::GetAttribute(const char ** atts,
   }
   return nullptr;
 }
-/**@ITKEndGrouping*/
 /** Check the current tags to see whether it matches a user input. */
-/** @ITKStartGrouping */
 bool
 ParticleSwarmOptimizerSAXReader::ContextIs(const char * test) const
 {
@@ -324,5 +313,4 @@ ParticleSwarmOptimizerSAXReader::ContextIs(const char * test) const
   }
   return (s == std::string(test));
 }
-/**@ITKEndGrouping*/
 } // namespace itk

Examples/IO/XML/itkParticleSwarmOptimizerSAXWriter.cxx

@@ -26,7 +26,6 @@ namespace itk
 /**
  * Check that whether the file with given name is writable.
  */
-/** @ITKStartGrouping */
 int
 ParticleSwarmOptimizerSAXWriter::CanWriteFile(const char * name)
 {
@@ -38,11 +37,9 @@ ParticleSwarmOptimizerSAXWriter::CanWriteFile(const char * name)
   }
   return yes;
 }
-/**@ITKEndGrouping*/
 /**
  * Method for performing XML file generation from the input object.
  */
-/** @ITKStartGrouping */
 int
 ParticleSwarmOptimizerSAXWriter::WriteFile()
 {
@@ -57,7 +54,7 @@ ParticleSwarmOptimizerSAXWriter::WriteFile()
       e.SetDescription(message.c_str());
       throw e;
     }
-/**@ITKEndGrouping*/
+
     if (this->m_InputObject == nullptr)
     {
       itkExceptionMacro("Object to be written is null!\n");

Examples/RegistrationITKv4/ModelToImageRegistration1.cxx

@@ -168,14 +168,13 @@ class IterationCallback : public itk::Command
   using OptimizerType = TOptimizer;
 
   /** Method to specify the optimizer. */
-  /** @ITKStartGrouping */
   void
   SetOptimizer(OptimizerType * optimizer)
   {
     m_Optimizer = optimizer;
     m_Optimizer->AddObserver(itk::IterationEvent(), this);
   }
-  /**@ITKEndGrouping*/
+
   /** Execute method will print data at each iteration */
   void
   Execute(itk::Object * caller, const itk::EventObject & event) override
@@ -271,7 +270,6 @@ class SimpleImageToSpatialObjectMetric
   static constexpr unsigned int ParametricSpaceDimension = 3;
 
   /** Specify the moving spatial object. */
-  /** @ITKStartGrouping */
   void
   SetMovingSpatialObject(const MovingSpatialObjectType * object) override
   {
@@ -285,7 +283,7 @@ class SimpleImageToSpatialObjectMetric
     m_PointList.clear();
     using myIteratorType =
       itk::ImageRegionConstIteratorWithIndex<TFixedImage>;
-  /**@ITKEndGrouping*/
+
     myIteratorType it(this->m_FixedImage,
                       this->m_FixedImage->GetBufferedRegion());
 
@@ -331,14 +329,13 @@ class SimpleImageToSpatialObjectMetric
   //  Software Guide : EndLatex
 
   /** Get the value for SingleValue optimizers. */
-  /** @ITKStartGrouping */
   //  Software Guide : BeginCodeSnippet
   MeasureType
   GetValue(const ParametersType & parameters) const override
   {
     double value;
     this->m_Transform->SetParameters(parameters);
-  /**@ITKEndGrouping*/
+
     value = 0;
     for (auto point : m_PointList)
     {
@@ -354,7 +351,6 @@ class SimpleImageToSpatialObjectMetric
   //  Software Guide : EndCodeSnippet
 
   /** Get Value and Derivatives for MultipleValuedOptimizers */
-  /** @ITKStartGrouping */
   void
   GetValueAndDerivative(const ParametersType & parameters,
                         MeasureType &          Value,
@@ -363,7 +359,7 @@ class SimpleImageToSpatialObjectMetric
     Value = this->GetValue(parameters);
     this->GetDerivative(parameters, Derivative);
   }
-  /**@ITKEndGrouping*/
+
 private:
   PointListType m_PointList;
 };

Modules/Bridge/VTK/include/itkVTKImageExportBase.h

@@ -78,14 +78,13 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
    * \brief Provide compatibility between VTK 4.4 and earlier versions.
    * \ingroup ITKVTK
    */
-  /** @ITKStartGrouping */
   class CallbackTypeProxy
   {
   public:
     using DoubleCallbackType = double * (*)(void *);
     using FloatCallbackType = float * (*)(void *);
     operator DoubleCallbackType() { return m_DoubleCallback; }
-  /**@ITKEndGrouping*/
+
     operator FloatCallbackType() { return m_FloatCallback; }
     CallbackTypeProxy(DoubleCallbackType d, FloatCallbackType f)
       : m_DoubleCallback(d)

Modules/Core/Common/include/itkBSplineKernelFunction.h

@@ -95,7 +95,6 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
   {};
 
   /** Zeroth order spline. */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<0> &, const TRealValueType & u)
   {
@@ -113,9 +112,8 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
       return TRealValueType{ 0.0 };
     }
   }
-  /**@ITKEndGrouping*/
+
   /** First order spline */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<1> &, const TRealValueType & u)
   {
@@ -124,12 +122,11 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
     {
       return TRealValueType{ 1.0 } - absValue;
     }
-  /**@ITKEndGrouping*/
+
     return TRealValueType{ 0.0 };
   }
 
   /** Second order spline. */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<2> &, const TRealValueType & u)
   {
@@ -151,9 +148,8 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
       return TRealValueType{ 0.0 };
     }
   }
-  /**@ITKEndGrouping*/
+
   /**  Third order spline. */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<3> &, const TRealValueType & u)
   {
@@ -176,15 +172,14 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
       return TRealValueType{ 0.0 };
     }
   }
-  /**@ITKEndGrouping*/
+
   /** Unimplemented spline order */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const DispatchBase &, const TRealValueType &)
   {
     itkGenericExceptionMacro("Evaluate not implemented for spline order " << SplineOrder);
   }
-  /**@ITKEndGrouping*/
+
 };
 } // end namespace itk
 

Modules/Core/Common/include/itkBitCast.h

@@ -28,7 +28,6 @@ namespace itk
 /** Rudimentary `bit_cast` implementation for C++14/C++17. From C++20, `std::bit_cast` would be preferred, at least if
  * the C++20 feature macro `__cpp_lib_bit_cast` is defined.
  */
-/** @ITKStartGrouping */
 template <typename TDestination, class TSource>
 TDestination
 bit_cast(const TSource & source)
@@ -37,7 +36,7 @@ bit_cast(const TSource & source)
                 "The destination type should have the same size as the source type.");
   static_assert(std::is_trivially_copyable_v<TDestination>, "The destination type should be trivially copyable");
   static_assert(std::is_trivially_copyable_v<TSource>, "The source type should be trivially copyable.");
-/**@ITKEndGrouping*/
+
   std::remove_const_t<TDestination> result;
   std::memcpy(&result, &source, sizeof(TSource));
   return result;

Modules/Core/Common/include/itkCellInterface.h

@@ -169,7 +169,6 @@ class ITK_TEMPLATE_EXPORT CellInterface
     using Pointer = SmartPointer<Self>;
 
     /** Method for creation through the object factory.   */
-    /** @ITKStartGrouping */
     // itkNewMacro(Self);
     static Pointer
     New()
@@ -178,7 +177,7 @@ class ITK_TEMPLATE_EXPORT CellInterface
       smartPtr->UnRegister();
       return smartPtr;
     }
-    /**@ITKEndGrouping*/
+
     /** Run-time type information (and related methods).   */
     itkOverrideGetNameOfClassMacro(MultiVisitor);
 
@@ -388,13 +387,12 @@ class ITK_TEMPLATE_EXPORT CellInterface
    * Array is ordered (xmin, xmax,  ymin, ymax, ....).  A pointer to the
    * array is returned for convenience.  This allows code like:
    * "CoordRep* bounds = cell->GetBoundingBox(new CoordRep[6]);". */
-  /** @ITKStartGrouping */
   CoordinateType *
   GetBoundingBox(CoordinateType[PointDimension * 2])
   {
     return nullptr;
   }
-  /**@ITKEndGrouping*/
+
   /** Compute the square of the diagonal length of the bounding box. */
   CoordinateType
   GetBoundingBoxDiagonalLength2()