Skip to content

Commit 16b1e55

Browse files
committed
DOC: fixing "unbalanced grouping commands" warnings
Based on review in InsightSoftwareConsortium/ITKSoftwareGuide#225 (comment)
1 parent e93a125 commit 16b1e55

File tree

728 files changed

+1967
-1967
lines changed

Some content is hidden

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

728 files changed

+1967
-1967
lines changed

Modules/Bridge/VTK/include/itkVTKImageExport.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class ITK_TEMPLATE_EXPORT VTKImageExport : public VTKImageExportBase
8282
SetInput(const InputImageType *);
8383
InputImageType *
8484
GetInput();
85-
/**@ITKEndGrouping*/
85+
/** @ITKEndGrouping */
8686
protected:
8787
VTKImageExport();
8888
~VTKImageExport() override = default;

Modules/Bridge/VTK/include/itkVTKImageExportBase.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
6767
using UpdateDataCallbackType = void (*)(void *);
6868
using DataExtentCallbackType = int * (*)(void *);
6969
using BufferPointerCallbackType = void * (*)(void *);
70-
/**@ITKEndGrouping*/
70+
/** @ITKEndGrouping */
7171
/** Compatibility for VTK older than 4.4. */
7272
/** @ITKStartGrouping */
7373
using FloatSpacingCallbackType = float * (*)(void *);
7474
using FloatOriginCallbackType = float * (*)(void *);
75-
/**@ITKEndGrouping*/
75+
/** @ITKEndGrouping */
7676
/**
7777
* \class CallbackTypeProxy
7878
* \brief Provide compatibility between VTK 4.4 and earlier versions.

Modules/Bridge/VTK/include/itkVTKImageImport.h

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -96,27 +96,27 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
9696
using UpdateDataCallbackType = void (*)(void *);
9797
using DataExtentCallbackType = int * (*)(void *);
9898
using BufferPointerCallbackType = void * (*)(void *);
99-
/**@ITKEndGrouping*/
99+
/** @ITKEndGrouping */
100100
/** Compatibility for VTK older than 4.4. */
101101
/** @ITKStartGrouping */
102102
using FloatSpacingCallbackType = float * (*)(void *);
103103
using FloatOriginCallbackType = float * (*)(void *);
104-
/**@ITKEndGrouping*/
104+
/** @ITKEndGrouping */
105105
/** What to do when receiving UpdateInformation(). */
106106
/** @ITKStartGrouping */
107107
itkSetMacro(UpdateInformationCallback, UpdateInformationCallbackType);
108108
itkGetConstMacro(UpdateInformationCallback, UpdateInformationCallbackType);
109-
/**@ITKEndGrouping*/
109+
/** @ITKEndGrouping */
110110
/** What to do when receiving PipelineModified(). */
111111
/** @ITKStartGrouping */
112112
itkSetMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
113113
itkGetConstMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
114-
/**@ITKEndGrouping*/
114+
/** @ITKEndGrouping */
115115
/** What to do when receiving SetWholeExtent(). */
116116
/** @ITKStartGrouping */
117117
itkSetMacro(WholeExtentCallback, WholeExtentCallbackType);
118118
itkGetConstMacro(WholeExtentCallback, WholeExtentCallbackType);
119-
/**@ITKEndGrouping*/
119+
/** @ITKEndGrouping */
120120
/** What to do when receiving SetSpacing(). */
121121
/** @ITKStartGrouping */
122122
itkSetMacro(SpacingCallback, SpacingCallbackType);
@@ -128,7 +128,7 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
128128
{
129129
this->SetFloatSpacingCallback(f);
130130
}
131-
/**@ITKEndGrouping*/
131+
/** @ITKEndGrouping */
132132
/** What to do when receiving SetOrigin(). */
133133
/** @ITKStartGrouping */
134134
itkSetMacro(OriginCallback, OriginCallbackType);
@@ -140,47 +140,47 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
140140
{
141141
this->SetFloatOriginCallback(f);
142142
}
143-
/**@ITKEndGrouping*/
143+
/** @ITKEndGrouping */
144144
/** What to do when receiving SetDirection(). */
145145
/** @ITKStartGrouping */
146146
itkSetMacro(DirectionCallback, DirectionCallbackType);
147147
itkGetConstMacro(DirectionCallback, DirectionCallbackType);
148-
/**@ITKEndGrouping*/
148+
/** @ITKEndGrouping */
149149
/** What to do when receiving UpdateInformation(). */
150150
/** @ITKStartGrouping */
151151
itkSetMacro(ScalarTypeCallback, ScalarTypeCallbackType);
152152
itkGetConstMacro(ScalarTypeCallback, ScalarTypeCallbackType);
153-
/**@ITKEndGrouping*/
153+
/** @ITKEndGrouping */
154154
/** What to do when receiving SetNumberOfComponents(). */
155155
/** @ITKStartGrouping */
156156
itkSetMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
157157
itkGetConstMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
158-
/**@ITKEndGrouping*/
158+
/** @ITKEndGrouping */
159159
/** What to do when receiving PropagateUpdateExtent(). */
160160
/** @ITKStartGrouping */
161161
itkSetMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
162162
itkGetConstMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
163-
/**@ITKEndGrouping*/
163+
/** @ITKEndGrouping */
164164
/** What to do when receiving UpdateData(). */
165165
/** @ITKStartGrouping */
166166
itkSetMacro(UpdateDataCallback, UpdateDataCallbackType);
167167
itkGetConstMacro(UpdateDataCallback, UpdateDataCallbackType);
168-
/**@ITKEndGrouping*/
168+
/** @ITKEndGrouping */
169169
/** What to do when receiving DataExtent(). */
170170
/** @ITKStartGrouping */
171171
itkSetMacro(DataExtentCallback, DataExtentCallbackType);
172172
itkGetConstMacro(DataExtentCallback, DataExtentCallbackType);
173-
/**@ITKEndGrouping*/
173+
/** @ITKEndGrouping */
174174
/** What to do when receiving BufferPointer(). */
175175
/** @ITKStartGrouping */
176176
itkSetMacro(BufferPointerCallback, BufferPointerCallbackType);
177177
itkGetConstMacro(BufferPointerCallback, BufferPointerCallbackType);
178-
/**@ITKEndGrouping*/
178+
/** @ITKEndGrouping */
179179
/** Specify callback data. */
180180
/** @ITKStartGrouping */
181181
itkSetMacro2(CallbackUserData, void *);
182182
itkGetConstMacro(CallbackUserData, void *);
183-
/**@ITKEndGrouping*/
183+
/** @ITKEndGrouping */
184184
protected:
185185
VTKImageImport();
186186
~VTKImageImport() override = default;

Modules/Core/Common/include/itkAnnulusOperator.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
102102
{
103103
return m_InnerRadius;
104104
}
105-
/**@ITKEndGrouping*/
105+
/** @ITKEndGrouping */
106106
/** Set/Get the thickness of the annulus. The outer radius of the
107107
* annulus is defined as r = InnerRadius + Thickness. Thickness is
108108
* specified in physical units (mm). */
@@ -117,7 +117,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
117117
{
118118
return m_Thickness;
119119
}
120-
/**@ITKEndGrouping*/
120+
/** @ITKEndGrouping */
121121
/** Set/Get the pixel spacings. Setting these ensures the annulus
122122
* is round in physical space. Defaults to 1. */
123123
/** @ITKStartGrouping */
@@ -131,7 +131,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
131131
{
132132
return m_Spacing;
133133
}
134-
/**@ITKEndGrouping*/
134+
/** @ITKEndGrouping */
135135
/** Set/Get whether kernel values are computed automatically or
136136
* specified manually */
137137
/** @ITKStartGrouping */
@@ -155,7 +155,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
155155
{
156156
this->SetNormalize(false);
157157
}
158-
/**@ITKEndGrouping*/
158+
/** @ITKEndGrouping */
159159
/** If Normalize is on, you define the annulus to have a bright
160160
* center or a dark center. */
161161
/** @ITKStartGrouping */
@@ -179,7 +179,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
179179
{
180180
this->SetBrightCenter(false);
181181
}
182-
/**@ITKEndGrouping*/
182+
/** @ITKEndGrouping */
183183
/** If Normalize is off, the interior to annulus, the
184184
* annulus (region between the two circles), and the region exterior to the
185185
* annulus to be defined manually. Defaults are 0, 1, 0
@@ -215,7 +215,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
215215
{
216216
return m_ExteriorValue;
217217
}
218-
/**@ITKEndGrouping*/
218+
/** @ITKEndGrouping */
219219
void
220220
PrintSelf(std::ostream & os, Indent indent) const override
221221
{

Modules/Core/Common/include/itkArray.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
136136
{
137137
return static_cast<SizeValueType>(this->size());
138138
}
139-
/**@ITKEndGrouping*/
139+
/** @ITKEndGrouping */
140140
/** Get one element */
141141
const TValue &
142142
GetElement(SizeValueType i) const

Modules/Core/Common/include/itkAutoPointerDataObjectDecorator.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class ITK_TEMPLATE_EXPORT AutoPointerDataObjectDecorator : public DataObject
9595
{
9696
return m_Component.get();
9797
}
98-
/**@ITKEndGrouping*/
98+
/** @ITKEndGrouping */
9999
protected:
100100
AutoPointerDataObjectDecorator() = default;
101101
~AutoPointerDataObjectDecorator() override = default;

Modules/Core/Common/include/itkBinaryThresholdSpatialFunction.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,17 @@ class ITK_TEMPLATE_EXPORT BinaryThresholdSpatialFunction
7474
/** @ITKStartGrouping */
7575
itkSetMacro(LowerThreshold, FunctionOutputType);
7676
itkGetConstReferenceMacro(LowerThreshold, FunctionOutputType);
77-
/**@ITKEndGrouping*/
77+
/** @ITKEndGrouping */
7878
/** Set/Get the upper threshold. */
7979
/** @ITKStartGrouping */
8080
itkSetMacro(UpperThreshold, FunctionOutputType);
8181
itkGetConstReferenceMacro(UpperThreshold, FunctionOutputType);
82-
/**@ITKEndGrouping*/
82+
/** @ITKEndGrouping */
8383
/** Set/Get the underlying function. */
8484
/** @ITKStartGrouping */
8585
itkSetObjectMacro(Function, FunctionType);
8686
itkGetModifiableObjectMacro(Function, FunctionType);
87-
/**@ITKEndGrouping*/
87+
/** @ITKEndGrouping */
8888
/** Evaluate the function at a given position. */
8989
OutputType
9090
Evaluate(const InputType & point) const override;

Modules/Core/Common/include/itkBuildInformation.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ class ITKCommon_EXPORT BuildInformation final : public Object
9696
GetDescription(const MapKeyType &);
9797
static const std::vector<MapKeyType>
9898
GetAllKeys();
99-
/**@ITKEndGrouping*/
99+
/** @ITKEndGrouping */
100100
private:
101101
BuildInformation();
102102

Modules/Core/Common/include/itkCellInterface.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ class ITK_TEMPLATE_EXPORT CellInterface
312312
GetPointIdsContainer() const;
313313
void
314314
SetPointIdsContainer(const PointIdentifierContainerType &);
315-
/**@ITKEndGrouping*/
315+
/** @ITKEndGrouping */
316316
/** Given the parametric coordinates of a point in the cell
317317
* (pCoords[CellDimension]), get the closest cell boundary feature of
318318
* topological dimension CellDimension-1. If the "inside" pointer is not

Modules/Core/Common/include/itkColorTable.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ class ITK_TEMPLATE_EXPORT ColorTable : public Object
100100
SetColor(unsigned int c, TComponent r, TComponent g, TComponent b, const char * name = "UserDefined");
101101
bool
102102
SetColor(unsigned int c, RGBPixel<TComponent> pixel, const char * name = "UserDefined");
103-
/**@ITKEndGrouping*/
103+
/** @ITKEndGrouping */
104104
/** Given the position in the table and the color
105105
* returns the value.
106106
*/

0 commit comments

Comments
 (0)