Skip to content

Commit 251d40f

Browse files
committed
DOC: Fix miscellaneous Doxygen warnings
Fix miscellaneous Doxygen warnings: - Fix the Doxygen name for the `itk::FastMarchingTraits::LabelType` enum. - Add the missing `\endcode` tag to a code snippet in `itk::OrientImageFilter`. - Add the `ITK_LEGACY_REMOVE` macro to a function declared as legacy with the `itkLegacyMacro` in `itk::ResampleImageFilter`. Fixes: ``` Warning Modules/Filtering/FastMarching/include/itkFastMarchingTraits.h:77: warning: Documentation for undefined enum 'LabelEnum' found. ``` and ``` Warning Modul/.../ITK/Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h:268: warning: Reached end of file while still inside a (nested) comment. Nesting level 1 (probable line reference: 29) Warning Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h:268: warning: File ended in the middle of a comment block! Perhaps a missing \endcode? ``` and ``` Warning Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h:367: warning: no uniquely matching class member found for template < TComponent > static itk::ResampleImageFilter< TComponent >::itkLegacyMacro(const TComponent value) ``` raised for example in: https://open.cdash.org/viewBuildError.php?type=1&buildid=10117138
1 parent 46ebe1f commit 251d40f

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

Modules/Filtering/FastMarching/include/itkFastMarchingTraits.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class FastMarchingTraitsBase
7474

7575
using SuperclassType = TSuperclass;
7676

77-
/** \enum LabelEnum Fast Marching algorithm nodes types. */
77+
/** \enum LabelType Fast Marching algorithm nodes types. */
7878
enum LabelType
7979
{
8080
/** \c Far represent far away nodes*/

Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,11 @@ namespace itk
4545
*
4646
* An AnatomicalOrientation object can be constructed unambiguously with the following syntax:
4747
*
48-
* \code
49-
* AnatomicalOrientation(AnatomicalOrientation::CoordinateEnum::RightToLeft,
50-
* AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior,
51-
* AnatomicalOrientation::CoordinateEnum::InferiorToSuperior);
48+
\code
49+
AnatomicalOrientation(AnatomicalOrientation::CoordinateEnum::RightToLeft,
50+
AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior,
51+
AnatomicalOrientation::CoordinateEnum::InferiorToSuperior);
52+
\endcode
5253
*
5354
*
5455
* The orientations were previously defined in the itk::SpatialOrientation class. However,

Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,10 +344,12 @@ class ITK_TEMPLATE_EXPORT ResampleImageFilter : public ImageToImageFilter<TInput
344344
virtual void
345345
LinearThreadedGenerateData(const OutputImageRegionType & outputRegionForThread);
346346

347+
#if !defined(ITK_LEGACY_REMOVE)
347348
/** Cast pixel from interpolator output to PixelType. */
348349
itkLegacyMacro(virtual PixelType CastPixelWithBoundsChecking(const InterpolatorOutputType value,
349350
const ComponentType minComponent,
350351
const ComponentType maxComponent) const;)
352+
#endif
351353

352354
private:
353355
static PixelComponentType

0 commit comments

Comments
 (0)