Skip to content

Commit 650cf36

Browse files
albert-githubjhlegarreta
authored andcommitted
DOC: Fix "unbalanced grouping commands" Doxygen warnings
Fix "unbalanced grouping commands" Doxygen warnings: - Use a brute force approach to fix the "unbalanced grouping commands" Doxygen warnings by explicitly placing the `ALIASES` `ITKStartGrouping` and `ITKEndGrouping` around the appropriate code blocks. This involved a multi-step, trial and error process where an initial attempt was made to address such warnings by inserting the Doxygen commands `@{` and `@}` around the identified faulty blocks, and then any new warnings appeared as a result of those changes was solved in an interative, manual process. - Remove grouping around single functions. - Remove grouping from `Examples`: the code in the `Examples` folder is meant to serve as files hosting code blocks used by the ITK Software Guide and such files do not appear in the ITK Doxygen documentaion. Thus, grouping has no meaningful application within these files. The use of the `Utilities/Doxygen/itkgroup.py` script to introduce the Doxygen grouping markers at the appropriate places has been abandoned as this implicitly added the commands based on the layout. Grouping is hard to enforce automatically and it is also hard to get an error-free output from this script (would nearly require a compiler). Virtually all of the grouping in ITK happens around `Get`/`Set` method pairs. Doxygen grouping documentation: https://www.doxygen.nl/manual/grouping.html
1 parent 5f011c8 commit 650cf36

File tree

769 files changed

+4194
-1785
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

769 files changed

+4194
-1785
lines changed

Modules/Bridge/VTK/include/itkVTKImageExport.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,13 @@ class ITK_TEMPLATE_EXPORT VTKImageExport : public VTKImageExportBase
7676
itkConceptMacro(ImageDimensionCheck, (Concept::SameDimensionOrMinusOneOrTwo<3, Self::InputImageDimension>));
7777

7878
/** Set the input image of this image exporter. */
79+
/** @ITKStartGrouping */
7980
using Superclass::SetInput;
8081
void
8182
SetInput(const InputImageType *);
8283
InputImageType *
8384
GetInput();
84-
85+
/** @ITKEndGrouping */
8586
protected:
8687
VTKImageExport();
8788
~VTKImageExport() override = default;

Modules/Bridge/VTK/include/itkVTKImageExportBase.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
5454
GetCallbackUserData();
5555

5656
/** The function pointer type expected for a callback. */
57+
/** @ITKStartGrouping */
5758
using UpdateInformationCallbackType = void (*)(void *);
5859
using PipelineModifiedCallbackType = int (*)(void *);
5960
using WholeExtentCallbackType = int * (*)(void *);
@@ -66,11 +67,12 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
6667
using UpdateDataCallbackType = void (*)(void *);
6768
using DataExtentCallbackType = int * (*)(void *);
6869
using BufferPointerCallbackType = void * (*)(void *);
69-
70+
/** @ITKEndGrouping */
7071
/** Compatibility for VTK older than 4.4. */
72+
/** @ITKStartGrouping */
7173
using FloatSpacingCallbackType = float * (*)(void *);
7274
using FloatOriginCallbackType = float * (*)(void *);
73-
75+
/** @ITKEndGrouping */
7476
/**
7577
* \class CallbackTypeProxy
7678
* \brief Provide compatibility between VTK 4.4 and earlier versions.

Modules/Bridge/VTK/include/itkVTKImageImport.h

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
8383

8484
/** These are function pointer types for the pipeline connection
8585
* callbacks. */
86+
/** @ITKStartGrouping */
8687
using UpdateInformationCallbackType = void (*)(void *);
8788
using PipelineModifiedCallbackType = int (*)(void *);
8889
using WholeExtentCallbackType = int * (*)(void *);
@@ -95,24 +96,29 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
9596
using UpdateDataCallbackType = void (*)(void *);
9697
using DataExtentCallbackType = int * (*)(void *);
9798
using BufferPointerCallbackType = void * (*)(void *);
98-
99+
/** @ITKEndGrouping */
99100
/** Compatibility for VTK older than 4.4. */
101+
/** @ITKStartGrouping */
100102
using FloatSpacingCallbackType = float * (*)(void *);
101103
using FloatOriginCallbackType = float * (*)(void *);
102-
104+
/** @ITKEndGrouping */
103105
/** What to do when receiving UpdateInformation(). */
106+
/** @ITKStartGrouping */
104107
itkSetMacro(UpdateInformationCallback, UpdateInformationCallbackType);
105108
itkGetConstMacro(UpdateInformationCallback, UpdateInformationCallbackType);
106-
109+
/** @ITKEndGrouping */
107110
/** What to do when receiving PipelineModified(). */
111+
/** @ITKStartGrouping */
108112
itkSetMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
109113
itkGetConstMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
110-
114+
/** @ITKEndGrouping */
111115
/** What to do when receiving SetWholeExtent(). */
116+
/** @ITKStartGrouping */
112117
itkSetMacro(WholeExtentCallback, WholeExtentCallbackType);
113118
itkGetConstMacro(WholeExtentCallback, WholeExtentCallbackType);
114-
119+
/** @ITKEndGrouping */
115120
/** What to do when receiving SetSpacing(). */
121+
/** @ITKStartGrouping */
116122
itkSetMacro(SpacingCallback, SpacingCallbackType);
117123
itkGetConstMacro(SpacingCallback, SpacingCallbackType);
118124
itkSetMacro(FloatSpacingCallback, FloatSpacingCallbackType);
@@ -122,8 +128,9 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
122128
{
123129
this->SetFloatSpacingCallback(f);
124130
}
125-
131+
/** @ITKEndGrouping */
126132
/** What to do when receiving SetOrigin(). */
133+
/** @ITKStartGrouping */
127134
itkSetMacro(OriginCallback, OriginCallbackType);
128135
itkGetConstMacro(OriginCallback, OriginCallbackType);
129136
itkSetMacro(FloatOriginCallback, FloatOriginCallbackType);
@@ -133,39 +140,47 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
133140
{
134141
this->SetFloatOriginCallback(f);
135142
}
136-
143+
/** @ITKEndGrouping */
137144
/** What to do when receiving SetDirection(). */
145+
/** @ITKStartGrouping */
138146
itkSetMacro(DirectionCallback, DirectionCallbackType);
139147
itkGetConstMacro(DirectionCallback, DirectionCallbackType);
140-
148+
/** @ITKEndGrouping */
141149
/** What to do when receiving UpdateInformation(). */
150+
/** @ITKStartGrouping */
142151
itkSetMacro(ScalarTypeCallback, ScalarTypeCallbackType);
143152
itkGetConstMacro(ScalarTypeCallback, ScalarTypeCallbackType);
144-
153+
/** @ITKEndGrouping */
145154
/** What to do when receiving SetNumberOfComponents(). */
155+
/** @ITKStartGrouping */
146156
itkSetMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
147157
itkGetConstMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
148-
158+
/** @ITKEndGrouping */
149159
/** What to do when receiving PropagateUpdateExtent(). */
160+
/** @ITKStartGrouping */
150161
itkSetMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
151162
itkGetConstMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
152-
163+
/** @ITKEndGrouping */
153164
/** What to do when receiving UpdateData(). */
165+
/** @ITKStartGrouping */
154166
itkSetMacro(UpdateDataCallback, UpdateDataCallbackType);
155167
itkGetConstMacro(UpdateDataCallback, UpdateDataCallbackType);
156-
168+
/** @ITKEndGrouping */
157169
/** What to do when receiving DataExtent(). */
170+
/** @ITKStartGrouping */
158171
itkSetMacro(DataExtentCallback, DataExtentCallbackType);
159172
itkGetConstMacro(DataExtentCallback, DataExtentCallbackType);
160-
173+
/** @ITKEndGrouping */
161174
/** What to do when receiving BufferPointer(). */
175+
/** @ITKStartGrouping */
162176
itkSetMacro(BufferPointerCallback, BufferPointerCallbackType);
163177
itkGetConstMacro(BufferPointerCallback, BufferPointerCallbackType);
164-
178+
/** @ITKEndGrouping */
165179
/** Specify callback data. */
180+
/** @ITKStartGrouping */
166181
itkSetMacro2(CallbackUserData, void *);
167182
itkGetConstMacro(CallbackUserData, void *);
168-
183+
/** @ITKEndGrouping */
169184
protected:
170185
VTKImageImport();
171186
~VTKImageImport() override = default;

Modules/Core/Common/include/itkAnnulusOperator.h

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
9191

9292
/** Set/Get the inner radius of the annulus. Radius is specified in
9393
* physical units (mm). */
94+
/** @ITKStartGrouping */
9495
void
9596
SetInnerRadius(double r)
9697
{
@@ -101,10 +102,11 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
101102
{
102103
return m_InnerRadius;
103104
}
104-
105+
/** @ITKEndGrouping */
105106
/** Set/Get the thickness of the annulus. The outer radius of the
106107
* annulus is defined as r = InnerRadius + Thickness. Thickness is
107108
* specified in physical units (mm). */
109+
/** @ITKStartGrouping */
108110
void
109111
SetThickness(double t)
110112
{
@@ -115,9 +117,10 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
115117
{
116118
return m_Thickness;
117119
}
118-
120+
/** @ITKEndGrouping */
119121
/** Set/Get the pixel spacings. Setting these ensures the annulus
120122
* is round in physical space. Defaults to 1. */
123+
/** @ITKStartGrouping */
121124
void
122125
SetSpacing(SpacingType & s)
123126
{
@@ -128,9 +131,10 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
128131
{
129132
return m_Spacing;
130133
}
131-
134+
/** @ITKEndGrouping */
132135
/** Set/Get whether kernel values are computed automatically or
133136
* specified manually */
137+
/** @ITKStartGrouping */
134138
void
135139
SetNormalize(bool b)
136140
{
@@ -151,9 +155,10 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
151155
{
152156
this->SetNormalize(false);
153157
}
154-
158+
/** @ITKEndGrouping */
155159
/** If Normalize is on, you define the annulus to have a bright
156160
* center or a dark center. */
161+
/** @ITKStartGrouping */
157162
void
158163
SetBrightCenter(bool b)
159164
{
@@ -174,11 +179,12 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
174179
{
175180
this->SetBrightCenter(false);
176181
}
177-
182+
/** @ITKEndGrouping */
178183
/** If Normalize is off, the interior to annulus, the
179184
* annulus (region between the two circles), and the region exterior to the
180185
* annulus to be defined manually. Defaults are 0, 1, 0
181186
* respectively. */
187+
/** @ITKStartGrouping */
182188
void
183189
SetInteriorValue(TPixel v)
184190
{
@@ -209,7 +215,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
209215
{
210216
return m_ExteriorValue;
211217
}
212-
218+
/** @ITKEndGrouping */
213219
void
214220
PrintSelf(std::ostream & os, Indent indent) const override
215221
{

Modules/Core/Common/include/itkArray.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
125125
operator=(const VnlVectorType & rhs);
126126

127127
/** Return the number of elements in the Array */
128+
/** @ITKStartGrouping */
128129
SizeValueType
129130
Size() const
130131
{
@@ -135,7 +136,7 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
135136
{
136137
return static_cast<SizeValueType>(this->size());
137138
}
138-
139+
/** @ITKEndGrouping */
139140
/** Get one element */
140141
const TValue &
141142
GetElement(SizeValueType i) const

Modules/Core/Common/include/itkAutoPointerDataObjectDecorator.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ class ITK_TEMPLATE_EXPORT AutoPointerDataObjectDecorator : public DataObject
8484
Set(T * val);
8585

8686
/** Get the contained object */
87+
/** @ITKStartGrouping */
8788
virtual T *
8889
Get()
8990
{
@@ -94,7 +95,7 @@ class ITK_TEMPLATE_EXPORT AutoPointerDataObjectDecorator : public DataObject
9495
{
9596
return m_Component.get();
9697
}
97-
98+
/** @ITKEndGrouping */
9899
protected:
99100
AutoPointerDataObjectDecorator() = default;
100101
~AutoPointerDataObjectDecorator() override = default;

Modules/Core/Common/include/itkBinaryThresholdSpatialFunction.h

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,20 @@ class ITK_TEMPLATE_EXPORT BinaryThresholdSpatialFunction
7171
using FunctionOutputType = typename TFunction::OutputType;
7272

7373
/** Set/Get the lower threshold. */
74+
/** @ITKStartGrouping */
7475
itkSetMacro(LowerThreshold, FunctionOutputType);
7576
itkGetConstReferenceMacro(LowerThreshold, FunctionOutputType);
76-
77+
/** @ITKEndGrouping */
7778
/** Set/Get the upper threshold. */
79+
/** @ITKStartGrouping */
7880
itkSetMacro(UpperThreshold, FunctionOutputType);
7981
itkGetConstReferenceMacro(UpperThreshold, FunctionOutputType);
80-
82+
/** @ITKEndGrouping */
8183
/** Set/Get the underlying function. */
84+
/** @ITKStartGrouping */
8285
itkSetObjectMacro(Function, FunctionType);
8386
itkGetModifiableObjectMacro(Function, FunctionType);
84-
87+
/** @ITKEndGrouping */
8588
/** Evaluate the function at a given position. */
8689
OutputType
8790
Evaluate(const InputType & point) const override;

Modules/Core/Common/include/itkBuildInformation.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ class ITKCommon_EXPORT BuildInformation final : public Object
8585
New();
8686

8787
/** Returns the global singleton instance of the BuildInformation */
88+
/** @ITKStartGrouping */
8889
static Pointer
8990
GetInstance();
9091
static const MapType &
@@ -95,7 +96,7 @@ class ITKCommon_EXPORT BuildInformation final : public Object
9596
GetDescription(const MapKeyType &);
9697
static const std::vector<MapKeyType>
9798
GetAllKeys();
98-
99+
/** @ITKEndGrouping */
99100
private:
100101
BuildInformation();
101102

Modules/Core/Common/include/itkCellInterface.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,12 +306,13 @@ class ITK_TEMPLATE_EXPORT CellInterface
306306
PointIdsEnd() const = 0;
307307

308308
/** Get/Set the point id list used by the cell */
309+
/** @ITKStartGrouping */
309310
using PointIdentifierContainerType = itk::Array<PointIdentifier>;
310311
PointIdentifierContainerType
311312
GetPointIdsContainer() const;
312313
void
313314
SetPointIdsContainer(const PointIdentifierContainerType &);
314-
315+
/** @ITKEndGrouping */
315316
/** Given the parametric coordinates of a point in the cell
316317
* (pCoords[CellDimension]), get the closest cell boundary feature of
317318
* topological dimension CellDimension-1. If the "inside" pointer is not

Modules/Core/Common/include/itkColorTable.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,12 @@ class ITK_TEMPLATE_EXPORT ColorTable : public Object
9595
* the color. If a name is not provided, the name "UserDefined" is
9696
* used.
9797
*/
98+
/** @ITKStartGrouping */
9899
bool
99100
SetColor(unsigned int c, TComponent r, TComponent g, TComponent b, const char * name = "UserDefined");
100101
bool
101102
SetColor(unsigned int c, RGBPixel<TComponent> pixel, const char * name = "UserDefined");
102-
103+
/** @ITKEndGrouping */
103104
/** Given the position in the table and the color
104105
* returns the value.
105106
*/

0 commit comments

Comments
 (0)