Skip to content

Commit 222250b

Browse files
albert-githubalbert-github
committed
DOC: fixing "unbalanced grouping commands" warnings
Fixes after second test
1 parent 6e8c875 commit 222250b

File tree

202 files changed

+486
-949
lines changed

Some content is hidden

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

202 files changed

+486
-949
lines changed

‎Examples/IO/XML/itkParticleSwarmOptimizerSAXReader.cxx‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ namespace itk
2727
/**
2828
* Check that whether the file with given name is readable.
2929
*/
30-
/** @ITKStartGrouping */
3130
int
3231
ParticleSwarmOptimizerSAXReader::CanReadFile(const char * name)
3332
{
@@ -39,11 +38,10 @@ ParticleSwarmOptimizerSAXReader::CanReadFile(const char * name)
3938
}
4039
return yes;
4140
}
42-
/**@ITKEndGrouping*/
41+
4342
/**
4443
* Method called when a new xml tag start is encountered.
4544
*/
46-
/** @ITKStartGrouping */
4745
void
4846
ParticleSwarmOptimizerSAXReader::StartElement(const char * name,
4947
const char ** atts)
@@ -57,7 +55,7 @@ ParticleSwarmOptimizerSAXReader::StartElement(const char * name,
5755
this->ContextIs("/optimizer"))
5856
{
5957
std::vector<double> * bound = nullptr;
60-
/**@ITKEndGrouping*/
58+
6159
const char * id = this->GetAttribute(atts, "id");
6260
if (id == nullptr)
6361
{
@@ -90,7 +88,6 @@ ParticleSwarmOptimizerSAXReader::StartElement(const char * name,
9088
/**
9189
* Method called when an xml tag end is encountered.
9290
*/
93-
/** @ITKStartGrouping */
9491
void
9592
ParticleSwarmOptimizerSAXReader::EndElement(const char * name)
9693
{
@@ -108,7 +105,6 @@ ParticleSwarmOptimizerSAXReader::EndElement(const char * name)
108105
bounds.push_back(value);
109106
}
110107
this->m_OutputObject->SetParameterBounds(bounds);
111-
/**@ITKEndGrouping*/
112108
this->m_OutputObject->SetParametersConvergenceTolerance(
113109
this->m_ParametersConvergenceTolerance);
114110
}
@@ -160,7 +156,6 @@ ParticleSwarmOptimizerSAXReader::CharacterDataHandler(const char * inData,
160156
/**
161157
* Method for performing XML reading and output generation.
162158
*/
163-
/** @ITKStartGrouping */
164159
int
165160
ParticleSwarmOptimizerSAXReader::ReadFile()
166161
{
@@ -178,7 +173,6 @@ ParticleSwarmOptimizerSAXReader::ReadFile()
178173
e.SetDescription(message.c_str());
179174
throw e;
180175
}
181-
/**@ITKEndGrouping*/
182176
if (this->m_OutputObject == nullptr)
183177
{
184178
itkExceptionMacro("Object to be read is null!\n");
@@ -198,7 +192,6 @@ ParticleSwarmOptimizerSAXReader::ReadFile()
198192
}
199193

200194
/** Process tag 'optimizer' attributes. */
201-
/** @ITKStartGrouping */
202195
void
203196
ParticleSwarmOptimizerSAXReader::ProcessOptimizerAttributes(
204197
const char ** atts,
@@ -262,9 +255,8 @@ ParticleSwarmOptimizerSAXReader::ProcessOptimizerAttributes(
262255
}
263256
}
264257
}
265-
/**@ITKEndGrouping*/
258+
266259
/** Process tag 'bound' attributes. */
267-
/** @ITKStartGrouping */
268260
void
269261
ParticleSwarmOptimizerSAXReader::ProcessBoundAttributes(
270262
const char ** atts,
@@ -290,9 +282,8 @@ ParticleSwarmOptimizerSAXReader::ProcessBoundAttributes(
290282
} // end if
291283
} // end for
292284
}
293-
/**@ITKEndGrouping*/
285+
294286
/** Search for and return a particular attribute from the attribute list. */
295-
/** @ITKStartGrouping */
296287
const char *
297288
ParticleSwarmOptimizerSAXReader::GetAttribute(const char ** atts,
298289
const char * key)
@@ -307,9 +298,7 @@ ParticleSwarmOptimizerSAXReader::GetAttribute(const char ** atts,
307298
}
308299
return nullptr;
309300
}
310-
/**@ITKEndGrouping*/
311301
/** Check the current tags to see whether it matches a user input. */
312-
/** @ITKStartGrouping */
313302
bool
314303
ParticleSwarmOptimizerSAXReader::ContextIs(const char * test) const
315304
{
@@ -324,5 +313,4 @@ ParticleSwarmOptimizerSAXReader::ContextIs(const char * test) const
324313
}
325314
return (s == std::string(test));
326315
}
327-
/**@ITKEndGrouping*/
328316
} // namespace itk

‎Examples/IO/XML/itkParticleSwarmOptimizerSAXWriter.cxx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ namespace itk
2626
/**
2727
* Check that whether the file with given name is writable.
2828
*/
29-
/** @ITKStartGrouping */
3029
int
3130
ParticleSwarmOptimizerSAXWriter::CanWriteFile(const char * name)
3231
{
@@ -38,11 +37,9 @@ ParticleSwarmOptimizerSAXWriter::CanWriteFile(const char * name)
3837
}
3938
return yes;
4039
}
41-
/**@ITKEndGrouping*/
4240
/**
4341
* Method for performing XML file generation from the input object.
4442
*/
45-
/** @ITKStartGrouping */
4643
int
4744
ParticleSwarmOptimizerSAXWriter::WriteFile()
4845
{
@@ -57,7 +54,7 @@ ParticleSwarmOptimizerSAXWriter::WriteFile()
5754
e.SetDescription(message.c_str());
5855
throw e;
5956
}
60-
/**@ITKEndGrouping*/
57+
6158
if (this->m_InputObject == nullptr)
6259
{
6360
itkExceptionMacro("Object to be written is null!\n");

‎Examples/RegistrationITKv4/ModelToImageRegistration1.cxx‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -168,14 +168,13 @@ class IterationCallback : public itk::Command
168168
using OptimizerType = TOptimizer;
169169

170170
/** Method to specify the optimizer. */
171-
/** @ITKStartGrouping */
172171
void
173172
SetOptimizer(OptimizerType * optimizer)
174173
{
175174
m_Optimizer = optimizer;
176175
m_Optimizer->AddObserver(itk::IterationEvent(), this);
177176
}
178-
/**@ITKEndGrouping*/
177+
179178
/** Execute method will print data at each iteration */
180179
void
181180
Execute(itk::Object * caller, const itk::EventObject & event) override
@@ -271,7 +270,6 @@ class SimpleImageToSpatialObjectMetric
271270
static constexpr unsigned int ParametricSpaceDimension = 3;
272271

273272
/** Specify the moving spatial object. */
274-
/** @ITKStartGrouping */
275273
void
276274
SetMovingSpatialObject(const MovingSpatialObjectType * object) override
277275
{
@@ -285,7 +283,7 @@ class SimpleImageToSpatialObjectMetric
285283
m_PointList.clear();
286284
using myIteratorType =
287285
itk::ImageRegionConstIteratorWithIndex<TFixedImage>;
288-
/**@ITKEndGrouping*/
286+
289287
myIteratorType it(this->m_FixedImage,
290288
this->m_FixedImage->GetBufferedRegion());
291289

@@ -331,14 +329,13 @@ class SimpleImageToSpatialObjectMetric
331329
// Software Guide : EndLatex
332330

333331
/** Get the value for SingleValue optimizers. */
334-
/** @ITKStartGrouping */
335332
// Software Guide : BeginCodeSnippet
336333
MeasureType
337334
GetValue(const ParametersType & parameters) const override
338335
{
339336
double value;
340337
this->m_Transform->SetParameters(parameters);
341-
/**@ITKEndGrouping*/
338+
342339
value = 0;
343340
for (auto point : m_PointList)
344341
{
@@ -354,7 +351,6 @@ class SimpleImageToSpatialObjectMetric
354351
// Software Guide : EndCodeSnippet
355352

356353
/** Get Value and Derivatives for MultipleValuedOptimizers */
357-
/** @ITKStartGrouping */
358354
void
359355
GetValueAndDerivative(const ParametersType & parameters,
360356
MeasureType & Value,
@@ -363,7 +359,7 @@ class SimpleImageToSpatialObjectMetric
363359
Value = this->GetValue(parameters);
364360
this->GetDerivative(parameters, Derivative);
365361
}
366-
/**@ITKEndGrouping*/
362+
367363
private:
368364
PointListType m_PointList;
369365
};

‎Modules/Bridge/VTK/include/itkVTKImageExportBase.h‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,13 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
7878
* \brief Provide compatibility between VTK 4.4 and earlier versions.
7979
* \ingroup ITKVTK
8080
*/
81-
/** @ITKStartGrouping */
8281
class CallbackTypeProxy
8382
{
8483
public:
8584
using DoubleCallbackType = double * (*)(void *);
8685
using FloatCallbackType = float * (*)(void *);
8786
operator DoubleCallbackType() { return m_DoubleCallback; }
88-
/**@ITKEndGrouping*/
87+
8988
operator FloatCallbackType() { return m_FloatCallback; }
9089
CallbackTypeProxy(DoubleCallbackType d, FloatCallbackType f)
9190
: m_DoubleCallback(d)

‎Modules/Core/Common/include/itkBSplineKernelFunction.h‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
9595
{};
9696

9797
/** Zeroth order spline. */
98-
/** @ITKStartGrouping */
9998
static inline TRealValueType
10099
Evaluate(const Dispatch<0> &, const TRealValueType & u)
101100
{
@@ -113,9 +112,8 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
113112
return TRealValueType{ 0.0 };
114113
}
115114
}
116-
/**@ITKEndGrouping*/
115+
117116
/** First order spline */
118-
/** @ITKStartGrouping */
119117
static inline TRealValueType
120118
Evaluate(const Dispatch<1> &, const TRealValueType & u)
121119
{
@@ -124,12 +122,11 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
124122
{
125123
return TRealValueType{ 1.0 } - absValue;
126124
}
127-
/**@ITKEndGrouping*/
125+
128126
return TRealValueType{ 0.0 };
129127
}
130128

131129
/** Second order spline. */
132-
/** @ITKStartGrouping */
133130
static inline TRealValueType
134131
Evaluate(const Dispatch<2> &, const TRealValueType & u)
135132
{
@@ -151,9 +148,8 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
151148
return TRealValueType{ 0.0 };
152149
}
153150
}
154-
/**@ITKEndGrouping*/
151+
155152
/** Third order spline. */
156-
/** @ITKStartGrouping */
157153
static inline TRealValueType
158154
Evaluate(const Dispatch<3> &, const TRealValueType & u)
159155
{
@@ -176,15 +172,14 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
176172
return TRealValueType{ 0.0 };
177173
}
178174
}
179-
/**@ITKEndGrouping*/
175+
180176
/** Unimplemented spline order */
181-
/** @ITKStartGrouping */
182177
static inline TRealValueType
183178
Evaluate(const DispatchBase &, const TRealValueType &)
184179
{
185180
itkGenericExceptionMacro("Evaluate not implemented for spline order " << SplineOrder);
186181
}
187-
/**@ITKEndGrouping*/
182+
188183
};
189184
} // end namespace itk
190185

‎Modules/Core/Common/include/itkBitCast.h‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ namespace itk
2828
/** Rudimentary `bit_cast` implementation for C++14/C++17. From C++20, `std::bit_cast` would be preferred, at least if
2929
* the C++20 feature macro `__cpp_lib_bit_cast` is defined.
3030
*/
31-
/** @ITKStartGrouping */
3231
template <typename TDestination, class TSource>
3332
TDestination
3433
bit_cast(const TSource & source)
@@ -37,7 +36,7 @@ bit_cast(const TSource & source)
3736
"The destination type should have the same size as the source type.");
3837
static_assert(std::is_trivially_copyable_v<TDestination>, "The destination type should be trivially copyable");
3938
static_assert(std::is_trivially_copyable_v<TSource>, "The source type should be trivially copyable.");
40-
/**@ITKEndGrouping*/
39+
4140
std::remove_const_t<TDestination> result;
4241
std::memcpy(&result, &source, sizeof(TSource));
4342
return result;

‎Modules/Core/Common/include/itkCellInterface.h‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@ class ITK_TEMPLATE_EXPORT CellInterface
169169
using Pointer = SmartPointer<Self>;
170170

171171
/** Method for creation through the object factory. */
172-
/** @ITKStartGrouping */
173172
// itkNewMacro(Self);
174173
static Pointer
175174
New()
@@ -178,7 +177,7 @@ class ITK_TEMPLATE_EXPORT CellInterface
178177
smartPtr->UnRegister();
179178
return smartPtr;
180179
}
181-
/**@ITKEndGrouping*/
180+
182181
/** Run-time type information (and related methods). */
183182
itkOverrideGetNameOfClassMacro(MultiVisitor);
184183

@@ -388,13 +387,12 @@ class ITK_TEMPLATE_EXPORT CellInterface
388387
* Array is ordered (xmin, xmax, ymin, ymax, ....). A pointer to the
389388
* array is returned for convenience. This allows code like:
390389
* "CoordRep* bounds = cell->GetBoundingBox(new CoordRep[6]);". */
391-
/** @ITKStartGrouping */
392390
CoordinateType *
393391
GetBoundingBox(CoordinateType[PointDimension * 2])
394392
{
395393
return nullptr;
396394
}
397-
/**@ITKEndGrouping*/
395+
398396
/** Compute the square of the diagonal length of the bounding box. */
399397
CoordinateType
400398
GetBoundingBoxDiagonalLength2()

0 commit comments

Comments
 (0)