DOC: fixing "unbalanced grouping commands" warnings

review: remove single function grouping

Author: albert-github

Modules/Core/Common/include/itkArray.h

@@ -100,7 +100,6 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
 #endif
 
   /** Constructor to initialize an array from another of any data type */
-  /** @ITKStartGrouping */
   template <typename TArrayValue>
   Array(const Array<TArrayValue> & r)
   {
@@ -110,7 +109,7 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
       this->operator[](i) = static_cast<TValue>(r[i]);
     }
   }
-  /**@ITKEndGrouping*/
+
   /** Set all the elements of the array to the specified value */
   void
   Fill(const TValue & v)

Modules/Core/Common/include/itkArray2D.h

@@ -79,15 +79,14 @@ class ITK_TEMPLATE_EXPORT Array2D : public vnl_matrix<TValue>
   /** Move-assignment operator.
    * \note This move-assignment operator is `noexcept`, even while the move-assignment operator of its base class
    * (`vnl_matrix`) is not `noexcept`, because unlike `vnl_matrix`, `Array2D` always manages its own memory. */
-  /** @ITKStartGrouping */
   Self &
   operator=(Self && array) noexcept
   {
     // Note: GCC <= 9.5 does not yet support "defaulting" (`= default`) this `noexcept` move-assignment operator.
     this->VnlMatrixType::operator=(std::move(array));
     return *this;
   }
-  /**@ITKEndGrouping*/
+
   /** Assigns the specified matrix to an Array2D. */
   Self &
   operator=(const VnlMatrixType & matrix);

Modules/Core/Common/include/itkAutoPointer.h

@@ -56,14 +56,13 @@ class AutoPointer
   {}
 
   /** Copy constructor.  */
-  /** @ITKStartGrouping */
   explicit AutoPointer(AutoPointer & p)
   {
     m_IsOwner = p.IsOwner();          // Ownership can only be taken from
                                       // another owner
     m_Pointer = p.ReleaseOwnership(); // release ownership if appropriate
   }
-  /**@ITKEndGrouping*/
+
   /** Constructor to pointer p.  */
   explicit AutoPointer(ObjectType * p, bool takeOwnership)
     : m_Pointer(p)
@@ -82,7 +81,6 @@ class AutoPointer
 
   /** Clear the AutoPointer. If it had a pointer the object
       is deleted and the pointer is set to null. */
-  /** @ITKStartGrouping */
   void
   Reset()
   {
@@ -93,7 +91,7 @@ class AutoPointer
     m_Pointer = nullptr;
     m_IsOwner = false;
   }
-  /**@ITKEndGrouping*/
+
   /** Explicitly set the ownership */
   void
   TakeOwnership()
@@ -102,7 +100,6 @@ class AutoPointer
   }
 
   /** Explicitly set the ownership */
-  /** @ITKStartGrouping */
   void
   TakeOwnership(ObjectType * objectptr)
   {
@@ -113,9 +110,8 @@ class AutoPointer
     m_Pointer = objectptr;
     m_IsOwner = true;
   }
-  /**@ITKEndGrouping*/
+
   /** Explicitly reject ownership */
-  /** @ITKStartGrouping */
   void
   TakeNoOwnership(ObjectType * objectptr)
   {
@@ -126,7 +122,7 @@ class AutoPointer
     m_Pointer = objectptr;
     m_IsOwner = false;
   }
-  /**@ITKEndGrouping*/
+
   /** Query for the ownership */
   bool
   IsOwner() const
@@ -146,14 +142,13 @@ class AutoPointer
    *  Note that the AutoPointer still points to the object after the
    *  ReleaseOwnership operation, but it doesn't own the object any
    *  more. */
-  /** @ITKStartGrouping */
   ObjectType *
   ReleaseOwnership()
   {
     m_IsOwner = false;
     return m_Pointer;
   }
-  /**@ITKEndGrouping*/
+
   /** Access function to pointer. */
   ObjectType *
   GetPointer() const
@@ -199,20 +194,18 @@ class AutoPointer
   }
 
   /** Overload operator assignment.  */
-  /** @ITKStartGrouping */
   AutoPointer &
   operator=(AutoPointer & r)
   {
     AutoPointer(r).Swap(*this);
     return *this;
   }
-  /**@ITKEndGrouping*/
+
   /** Casting operator to boolean. This is used in conditional
       statements to check the content of the pointer against null */
   operator bool() const { return (m_Pointer != nullptr); }
 
   /** Function to print object pointed to.  */
-  /** @ITKStartGrouping */
   /*  ObjectType *Print (std::ostream& os) const
       {
       // This prints the object pointed to by the pointer
@@ -221,7 +214,7 @@ class AutoPointer
       return m_Pointer;
       }
   */
-  /**@ITKEndGrouping*/
+
 private:
   /** Exchange the content of two AutoPointers */
   void
@@ -249,7 +242,6 @@ operator<<(std::ostream & os, const AutoPointer<T> p)
 
 /** This templated function is intended to facilitate the
     transfer between AutoPointers of Derived class to Base class */
-/** @ITKStartGrouping */
 template <typename TAutoPointerBase, typename TAutoPointerDerived>
 void
 TransferAutoPointer(TAutoPointerBase & pa, TAutoPointerDerived & pb)
@@ -262,7 +254,7 @@ TransferAutoPointer(TAutoPointerBase & pa, TAutoPointerDerived & pb)
     pb.ReleaseOwnership(); // pb Release Ownership and clears
   }
 }
-/**@ITKEndGrouping*/
+
 } // end namespace itk
 
 #endif

Modules/Core/Common/include/itkBSplineDerivativeKernelFunction.h

@@ -102,7 +102,6 @@ class ITK_TEMPLATE_EXPORT BSplineDerivativeKernelFunction : public KernelFunctio
   }
 
   /** Evaluate the function:  first order spline */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<1> &, const TRealValueType & u)
   {
@@ -131,9 +130,8 @@ class ITK_TEMPLATE_EXPORT BSplineDerivativeKernelFunction : public KernelFunctio
       return TRealValueType{ 0.0 };
     }
   }
-  /**@ITKEndGrouping*/
+
   /** Evaluate the function:  second order spline. */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<2> &, const TRealValueType & u)
   {
@@ -154,9 +152,8 @@ class ITK_TEMPLATE_EXPORT BSplineDerivativeKernelFunction : public KernelFunctio
       return TRealValueType{ 0.0 };
     }
   }
-  /**@ITKEndGrouping*/
+
   /** Evaluate the function:  third order spline. */
-  /** @ITKStartGrouping */
   static inline TRealValueType
   Evaluate(const Dispatch<3> &, const TRealValueType & u)
   {
@@ -181,15 +178,14 @@ class ITK_TEMPLATE_EXPORT BSplineDerivativeKernelFunction : public KernelFunctio
       return TRealValueType{ 0.0 };
     }
   }
-  /**@ITKEndGrouping*/
+
   /** Evaluate the function:  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/itkBackwardDifferenceOperator.h

@@ -67,13 +67,12 @@ class ITK_TEMPLATE_EXPORT BackwardDifferenceOperator : public NeighborhoodOperat
   GenerateCoefficients() override;
 
   /** Arranges coefficients spatially in the memory buffer. */
-  /** @ITKStartGrouping */
   void
   Fill(const CoefficientVector & coeff) override
   {
     this->FillCenteredDirectional(coeff);
   }
-  /**@ITKEndGrouping*/
+
 };
 
 } // namespace itk

Modules/Core/Common/include/itkBufferedImageNeighborhoodPixelAccessPolicy.h

@@ -103,15 +103,14 @@ class BufferedImageNeighborhoodPixelAccessPolicy final
 
   /** Constructor called directly by the pixel proxy of ShapedImageNeighborhoodRange.
    * \note The parameter `pixelIndex` is assumed to be in the buffered region. */
-  /** @ITKStartGrouping */
   BufferedImageNeighborhoodPixelAccessPolicy(const ImageSizeType &                   imageSize,
                                              const OffsetType &                      offsetTable,
                                              const NeighborhoodAccessorFunctorType & neighborhoodAccessor,
                                              const IndexType &                       pixelIndex) noexcept
     : m_PixelIndexValue{ CalculatePixelIndexValue(imageSize, offsetTable, pixelIndex) }
     , m_NeighborhoodAccessor(neighborhoodAccessor)
   {}
-  /**@ITKEndGrouping*/
+
   /** Retrieves the pixel value from the image buffer, at the current
    * index value.  */
   PixelType
@@ -122,13 +121,12 @@ class BufferedImageNeighborhoodPixelAccessPolicy final
 
   /** Sets the value of the image buffer at the current index value to the
    * specified value.  */
-  /** @ITKStartGrouping */
   void
   SetPixelValue(InternalPixelType * const imageBufferPointer, const PixelType & pixelValue) const noexcept
   {
     m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue);
   }
-  /**@ITKEndGrouping*/
+
 };
 
 } // namespace itk

Modules/Core/Common/include/itkByteSwapper.h

@@ -120,10 +120,9 @@ class ITK_TEMPLATE_EXPORT ByteSwapper : public Object
    * can be handled. Single byte types are not swapped;
    * others raise an exception. The method is used to
    * swap to and from Big Endian. */
-  /** @ITKStartGrouping */
   static void
   SwapWriteRangeFromSystemToBigEndian(const T * p, int num, std::ostream * fp);
-  /**@ITKEndGrouping*/
+
   /** Generic swap method handles type T. The swapping is
    * done in-place. 2, 4 and 8 byte swapping
    * can be handled. Single byte types are not swapped;
@@ -147,10 +146,9 @@ class ITK_TEMPLATE_EXPORT ByteSwapper : public Object
    * can be handled. Single byte types are not swapped;
    * others raise an exception. The method is used to
    * swap to and from Little Endian. */
-  /** @ITKStartGrouping */
   static void
   SwapWriteRangeFromSystemToLittleEndian(const T * p, int num, std::ostream * fp);
-  /**@ITKEndGrouping*/
+
 protected:
   ByteSwapper() = default;
   ~ByteSwapper() override = default;

Modules/Core/Common/include/itkCommand.h

@@ -120,7 +120,6 @@ class ITK_TEMPLATE_EXPORT MemberCommand : public Command
   }
 
   /**  Invoke the member function. */
-  /** @ITKStartGrouping */
   void
   Execute(Object * caller, const EventObject & event) override
   {
@@ -129,9 +128,8 @@ class ITK_TEMPLATE_EXPORT MemberCommand : public Command
       (m_This->*(m_MemberFunction))(caller, event);
     }
   }
-  /**@ITKEndGrouping*/
+
   /**  Invoke the member function with a const object. */
-  /** @ITKStartGrouping */
   void
   Execute(const Object * caller, const EventObject & event) override
   {
@@ -140,7 +138,7 @@ class ITK_TEMPLATE_EXPORT MemberCommand : public Command
       (m_This->*(m_ConstMemberFunction))(caller, event);
     }
   }
-  /**@ITKEndGrouping*/
+
 protected:
   T *                         m_This{ nullptr };
   TMemberFunctionPointer      m_MemberFunction{ nullptr };
@@ -189,7 +187,6 @@ class ITK_TEMPLATE_EXPORT ReceptorMemberCommand : public Command
   }
 
   /**  Invoke the member function. */
-  /** @ITKStartGrouping */
   void
   Execute(Object *, const EventObject & event) override
   {
@@ -198,9 +195,8 @@ class ITK_TEMPLATE_EXPORT ReceptorMemberCommand : public Command
       (m_This->*(m_MemberFunction))(event);
     }
   }
-  /**@ITKEndGrouping*/
+
   /**  Invoke the member function with a const object */
-  /** @ITKStartGrouping */
   void
   Execute(const Object *, const EventObject & event) override
   {
@@ -209,7 +205,7 @@ class ITK_TEMPLATE_EXPORT ReceptorMemberCommand : public Command
       (m_This->*(m_MemberFunction))(event);
     }
   }
-  /**@ITKEndGrouping*/
+
 protected:
   T *                    m_This{ nullptr };
   TMemberFunctionPointer m_MemberFunction{ nullptr };
@@ -256,7 +252,6 @@ class ITK_TEMPLATE_EXPORT SimpleMemberCommand : public Command
   }
 
   /** Invoke the callback function. */
-  /** @ITKStartGrouping */
   void
   Execute(Object *, const EventObject &) override
   {
@@ -265,7 +260,7 @@ class ITK_TEMPLATE_EXPORT SimpleMemberCommand : public Command
       (m_This->*(m_MemberFunction))();
     }
   }
-  /**@ITKEndGrouping*/
+
   void
   Execute(const Object *, const EventObject &) override
   {
@@ -321,7 +316,6 @@ class ITK_TEMPLATE_EXPORT SimpleConstMemberCommand : public Command
   }
 
   /** Invoke the const member method callback. */
-  /** @ITKStartGrouping */
   void
   Execute(Object *, const EventObject &) override
   {
@@ -330,7 +324,7 @@ class ITK_TEMPLATE_EXPORT SimpleConstMemberCommand : public Command
       (m_This->*(m_MemberFunction))();
     }
   }
-  /**@ITKEndGrouping*/
+
   void
   Execute(const Object *, const EventObject &) override
   {