Skip to content

Commit

Permalink
DOC: Fix miscellaneous Doxygen warnings
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jhlegarreta committed Dec 31, 2024
1 parent 46ebe1f commit 251d40f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class FastMarchingTraitsBase

using SuperclassType = TSuperclass;

/** \enum LabelEnum Fast Marching algorithm nodes types. */
/** \enum LabelType Fast Marching algorithm nodes types. */
enum LabelType
{
/** \c Far represent far away nodes*/
Expand Down
9 changes: 5 additions & 4 deletions Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ namespace itk
*
* An AnatomicalOrientation object can be constructed unambiguously with the following syntax:
*
* \code
* AnatomicalOrientation(AnatomicalOrientation::CoordinateEnum::RightToLeft,
* AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior,
* AnatomicalOrientation::CoordinateEnum::InferiorToSuperior);
\code
AnatomicalOrientation(AnatomicalOrientation::CoordinateEnum::RightToLeft,
AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior,
AnatomicalOrientation::CoordinateEnum::InferiorToSuperior);
\endcode
*
*
* The orientations were previously defined in the itk::SpatialOrientation class. However,
Expand Down
2 changes: 2 additions & 0 deletions Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -344,10 +344,12 @@ class ITK_TEMPLATE_EXPORT ResampleImageFilter : public ImageToImageFilter<TInput
virtual void
LinearThreadedGenerateData(const OutputImageRegionType & outputRegionForThread);

#if !defined(ITK_LEGACY_REMOVE)
/** Cast pixel from interpolator output to PixelType. */
itkLegacyMacro(virtual PixelType CastPixelWithBoundsChecking(const InterpolatorOutputType value,
const ComponentType minComponent,
const ComponentType maxComponent) const;)
#endif

private:
static PixelComponentType
Expand Down

0 comments on commit 251d40f

Please sign in to comment.