DOC: fixing "unbalanced grouping commands" warnings

Brute force approach to fix the "unbalanced grouping commands" warnings by explicitly placing the `ALIASES` `ITKStartGrouping` and `ITKEndGrouping` in the code where unbalanced grouping commands" warnings an attempt was made to insert the commands `@{` and `@}` and afterwards solving the warnings that were already present in respect to the "unbalanced grouping commands" warnings and also solving the warnings that appeared due to these changes.

The usage of the script has been abandoned as this implicitly added the commands based on the layout and this is is hard to enforce and it is also hard to get the script without errors (would nearly require a compiler).

This is related to issue #3654.

Author: albert-github

Examples/IO/XML/itkParticleSwarmOptimizerSAXReader.cxx

@@ -105,7 +105,6 @@ ParticleSwarmOptimizerSAXReader::EndElement(const char * name)
       bounds.push_back(value);
     }
     this->m_OutputObject->SetParameterBounds(bounds);
-
     this->m_OutputObject->SetParametersConvergenceTolerance(
       this->m_ParametersConvergenceTolerance);
   }
@@ -174,7 +173,6 @@ ParticleSwarmOptimizerSAXReader::ReadFile()
       e.SetDescription(message.c_str());
       throw e;
     }
-
     if (this->m_OutputObject == nullptr)
     {
       itkExceptionMacro("Object to be read is null!\n");
@@ -300,7 +298,6 @@ ParticleSwarmOptimizerSAXReader::GetAttribute(const char ** atts,
   }
   return nullptr;
 }
-
 /** Check the current tags to see whether it matches a user input. */
 bool
 ParticleSwarmOptimizerSAXReader::ContextIs(const char * test) const
@@ -316,5 +313,4 @@ ParticleSwarmOptimizerSAXReader::ContextIs(const char * test) const
   }
   return (s == std::string(test));
 }
-
 } // namespace itk

Examples/IO/XML/itkParticleSwarmOptimizerSAXWriter.cxx

@@ -37,7 +37,6 @@ ParticleSwarmOptimizerSAXWriter::CanWriteFile(const char * name)
   }
   return yes;
 }
-
 /**
  * Method for performing XML file generation from the input object.
  */

Examples/RegistrationITKv4/DeformableRegistration4.cxx

@@ -437,6 +437,7 @@ main(int argc, char * argv[])
                                             CoordinateRepType>;
 
   /** Create an setup displacement field generator. */
+  /** @ITKStartGrouping */
   auto dispfieldGenerator = DisplacementFieldGeneratorType::New();
   dispfieldGenerator->UseReferenceImageOn();
   dispfieldGenerator->SetReferenceImage(fixedImage);
@@ -451,7 +452,7 @@ main(int argc, char * argv[])
     std::cerr << " : " << err << std::endl;
     return EXIT_FAILURE;
   }
-
+  /**@ITKEndGrouping*/
   using FieldWriterType = itk::ImageFileWriter<DisplacementFieldImageType>;
   auto fieldWriter = FieldWriterType::New();
 

Examples/RegistrationITKv4/DeformableRegistration6.cxx

@@ -474,6 +474,7 @@ main(int argc, char * argv[])
                                             CoordinateRepType>;
 
   /** Create an setup displacement field generator. */
+  /** @ITKStartGrouping */
   auto dispfieldGenerator = DisplacementFieldGeneratorType::New();
   dispfieldGenerator->UseReferenceImageOn();
   dispfieldGenerator->SetReferenceImage(fixedImage);
@@ -488,7 +489,7 @@ main(int argc, char * argv[])
     std::cerr << " : " << err << std::endl;
     return EXIT_FAILURE;
   }
-
+  /**@ITKEndGrouping*/
   using FieldWriterType = itk::ImageFileWriter<DisplacementFieldImageType>;
   auto fieldWriter = FieldWriterType::New();
 

Examples/RegistrationITKv4/DeformableRegistration7.cxx

@@ -422,6 +422,7 @@ main(int argc, char * argv[])
                                             CoordinateRepType>;
 
   /** Create an setup displacement field generator. */
+  /** @ITKStartGrouping */
   auto dispfieldGenerator = DisplacementFieldGeneratorType::New();
   dispfieldGenerator->UseReferenceImageOn();
   dispfieldGenerator->SetReferenceImage(fixedImage);
@@ -436,7 +437,7 @@ main(int argc, char * argv[])
     std::cerr << " : " << err << std::endl;
     return EXIT_FAILURE;
   }
-
+  /**@ITKEndGrouping*/
   using FieldWriterType = itk::ImageFileWriter<DisplacementFieldImageType>;
   auto fieldWriter = FieldWriterType::New();
 

Examples/RegistrationITKv4/DeformableRegistration8.cxx

@@ -437,6 +437,7 @@ main(int argc, char * argv[])
                                               CoordinateRepType>;
 
     /** Create an setup displacement field generator. */
+    /** @ITKStartGrouping */
     auto dispfieldGenerator = DisplacementFieldGeneratorType::New();
     dispfieldGenerator->UseReferenceImageOn();
     dispfieldGenerator->SetReferenceImage(fixedImage);
@@ -451,7 +452,7 @@ main(int argc, char * argv[])
       std::cerr << " : " << err << std::endl;
       return EXIT_FAILURE;
     }
-
+    /**@ITKEndGrouping*/
     using FieldWriterType = itk::ImageFileWriter<DisplacementFieldImageType>;
     auto fieldWriter = FieldWriterType::New();
 

Examples/Statistics/WeightedSampleStatistics.cxx

@@ -67,9 +67,10 @@ class ExampleWeightFunction
   using ConstPointer = itk::SmartPointer<const Self>;
 
   /** Standard macros. */
+  /** @ITKStartGrouping */
   itkOverrideGetNameOfClassMacro(ExampleWeightFunction);
   itkNewMacro(Self);
-
+  /**@ITKEndGrouping*/
   /** Input type */
   using InputType = MeasurementVectorType;
 

Modules/Bridge/VTK/include/itkVTKImageExport.h

@@ -76,12 +76,13 @@ class ITK_TEMPLATE_EXPORT VTKImageExport : public VTKImageExportBase
   itkConceptMacro(ImageDimensionCheck, (Concept::SameDimensionOrMinusOneOrTwo<3, Self::InputImageDimension>));
 
   /** Set the input image of this image exporter. */
+  /** @ITKStartGrouping */
   using Superclass::SetInput;
   void
   SetInput(const InputImageType *);
   InputImageType *
   GetInput();
-
+  /**@ITKEndGrouping*/
 protected:
   VTKImageExport();
   ~VTKImageExport() override = default;

Modules/Bridge/VTK/include/itkVTKImageExportBase.h

@@ -54,6 +54,7 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
   GetCallbackUserData();
 
   /** The function pointer type expected for a callback. */
+  /** @ITKStartGrouping */
   using UpdateInformationCallbackType = void (*)(void *);
   using PipelineModifiedCallbackType = int (*)(void *);
   using WholeExtentCallbackType = int * (*)(void *);
@@ -66,11 +67,12 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
   using UpdateDataCallbackType = void (*)(void *);
   using DataExtentCallbackType = int * (*)(void *);
   using BufferPointerCallbackType = void * (*)(void *);
-
+  /**@ITKEndGrouping*/
   /** Compatibility for VTK older than 4.4.  */
+  /** @ITKStartGrouping */
   using FloatSpacingCallbackType = float * (*)(void *);
   using FloatOriginCallbackType = float * (*)(void *);
-
+  /**@ITKEndGrouping*/
   /**
    * \class CallbackTypeProxy
    * \brief Provide compatibility between VTK 4.4 and earlier versions.

Modules/Bridge/VTK/include/itkVTKImageImport.h

@@ -83,6 +83,7 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
 
   /** These are function pointer types for the pipeline connection
    * callbacks. */
+  /** @ITKStartGrouping */
   using UpdateInformationCallbackType = void (*)(void *);
   using PipelineModifiedCallbackType = int (*)(void *);
   using WholeExtentCallbackType = int * (*)(void *);
@@ -95,24 +96,29 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
   using UpdateDataCallbackType = void (*)(void *);
   using DataExtentCallbackType = int * (*)(void *);
   using BufferPointerCallbackType = void * (*)(void *);
-
+  /**@ITKEndGrouping*/
   /** Compatibility for VTK older than 4.4.  */
+  /** @ITKStartGrouping */
   using FloatSpacingCallbackType = float * (*)(void *);
   using FloatOriginCallbackType = float * (*)(void *);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving UpdateInformation(). */
+  /** @ITKStartGrouping */
   itkSetMacro(UpdateInformationCallback, UpdateInformationCallbackType);
   itkGetConstMacro(UpdateInformationCallback, UpdateInformationCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving PipelineModified(). */
+  /** @ITKStartGrouping */
   itkSetMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
   itkGetConstMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving SetWholeExtent(). */
+  /** @ITKStartGrouping */
   itkSetMacro(WholeExtentCallback, WholeExtentCallbackType);
   itkGetConstMacro(WholeExtentCallback, WholeExtentCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving SetSpacing(). */
+  /** @ITKStartGrouping */
   itkSetMacro(SpacingCallback, SpacingCallbackType);
   itkGetConstMacro(SpacingCallback, SpacingCallbackType);
   itkSetMacro(FloatSpacingCallback, FloatSpacingCallbackType);
@@ -122,8 +128,9 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
   {
     this->SetFloatSpacingCallback(f);
   }
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving SetOrigin(). */
+  /** @ITKStartGrouping */
   itkSetMacro(OriginCallback, OriginCallbackType);
   itkGetConstMacro(OriginCallback, OriginCallbackType);
   itkSetMacro(FloatOriginCallback, FloatOriginCallbackType);
@@ -133,39 +140,47 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
   {
     this->SetFloatOriginCallback(f);
   }
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving SetDirection(). */
+  /** @ITKStartGrouping */
   itkSetMacro(DirectionCallback, DirectionCallbackType);
   itkGetConstMacro(DirectionCallback, DirectionCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving UpdateInformation(). */
+  /** @ITKStartGrouping */
   itkSetMacro(ScalarTypeCallback, ScalarTypeCallbackType);
   itkGetConstMacro(ScalarTypeCallback, ScalarTypeCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving SetNumberOfComponents(). */
+  /** @ITKStartGrouping */
   itkSetMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
   itkGetConstMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving PropagateUpdateExtent(). */
+  /** @ITKStartGrouping */
   itkSetMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
   itkGetConstMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving UpdateData(). */
+  /** @ITKStartGrouping */
   itkSetMacro(UpdateDataCallback, UpdateDataCallbackType);
   itkGetConstMacro(UpdateDataCallback, UpdateDataCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving DataExtent(). */
+  /** @ITKStartGrouping */
   itkSetMacro(DataExtentCallback, DataExtentCallbackType);
   itkGetConstMacro(DataExtentCallback, DataExtentCallbackType);
-
+  /**@ITKEndGrouping*/
   /** What to do when receiving BufferPointer(). */
+  /** @ITKStartGrouping */
   itkSetMacro(BufferPointerCallback, BufferPointerCallbackType);
   itkGetConstMacro(BufferPointerCallback, BufferPointerCallbackType);
-
+  /**@ITKEndGrouping*/
   /** Specify callback data. */
+  /** @ITKStartGrouping */
   itkSetMacro2(CallbackUserData, void *);
   itkGetConstMacro(CallbackUserData, void *);
-
+  /**@ITKEndGrouping*/
 protected:
   VTKImageImport();
   ~VTKImageImport() override = default;