From 251d40fae016b01e0007f4f1d65843589d63c7a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Tue, 31 Dec 2024 17:34:18 -0500 Subject: [PATCH] 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 --- .../FastMarching/include/itkFastMarchingTraits.h | 2 +- .../Filtering/ImageGrid/include/itkOrientImageFilter.h | 9 +++++---- .../Filtering/ImageGrid/include/itkResampleImageFilter.h | 2 ++ 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/Modules/Filtering/FastMarching/include/itkFastMarchingTraits.h b/Modules/Filtering/FastMarching/include/itkFastMarchingTraits.h index bf2308fde1f..f9f9c5a7801 100644 --- a/Modules/Filtering/FastMarching/include/itkFastMarchingTraits.h +++ b/Modules/Filtering/FastMarching/include/itkFastMarchingTraits.h @@ -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*/ diff --git a/Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h b/Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h index 1698b032d2f..d24ea0129d7 100644 --- a/Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h +++ b/Modules/Filtering/ImageGrid/include/itkOrientImageFilter.h @@ -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, diff --git a/Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h b/Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h index 7a689bf79e9..68fe832b5fb 100644 --- a/Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h +++ b/Modules/Filtering/ImageGrid/include/itkResampleImageFilter.h @@ -344,10 +344,12 @@ class ITK_TEMPLATE_EXPORT ResampleImageFilter : public ImageToImageFilter