From 2dd28a46a6f9a7c65fca7b35bf0a646c12a528bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Mon, 9 Oct 2023 10:41:08 -0400 Subject: [PATCH 1/2] DOC: Remove `itk` prefix to class names in Doxygen `class` command Remove `itk` prefix to class names in Doxygen `\class` command: `itk` is name of the of the namespace. Removing the prefix allows the classes to be grouped under the `itk` namespace; otherwise they are listed twice, once under the `itk` namespace and once outside the `itk` namespace. --- Modules/Compatibility/Deprecated/include/itkTreeIteratorClone.h | 2 +- Modules/Core/Common/include/itkFloatingPointExceptions.h | 2 +- Modules/Core/Transform/include/itkTransformBase.h | 2 +- .../include/itkBSplineCenteredL2ResampleImageFilterBase.h | 2 +- Modules/Numerics/FEM/include/itkFEMLoadNoisyLandmark.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Modules/Compatibility/Deprecated/include/itkTreeIteratorClone.h b/Modules/Compatibility/Deprecated/include/itkTreeIteratorClone.h index 20fc820cf7d..6c5b156cd87 100644 --- a/Modules/Compatibility/Deprecated/include/itkTreeIteratorClone.h +++ b/Modules/Compatibility/Deprecated/include/itkTreeIteratorClone.h @@ -23,7 +23,7 @@ namespace itk { -/** \class itkTreeIteratorClone +/** \class TreeIteratorClone * \brief itkTreeIteratorClone class * \ingroup DataRepresentation * \ingroup ITKDeprecated diff --git a/Modules/Core/Common/include/itkFloatingPointExceptions.h b/Modules/Core/Common/include/itkFloatingPointExceptions.h index 35f2876ce63..d407803204b 100644 --- a/Modules/Core/Common/include/itkFloatingPointExceptions.h +++ b/Modules/Core/Common/include/itkFloatingPointExceptions.h @@ -43,7 +43,7 @@ class FloatingPointExceptionsEnums extern ITKCommon_EXPORT std::ostream & operator<<(std::ostream & out, const FloatingPointExceptionsEnums::ExceptionAction value); -/** \class itkFloatingPointExceptions +/** \class FloatingPointExceptions * \brief Allows floating point exceptions to be caught during program execution. * * Allows floating point exceptions to be caught during program execution. diff --git a/Modules/Core/Transform/include/itkTransformBase.h b/Modules/Core/Transform/include/itkTransformBase.h index 01fb6fd31bd..a93c17158ad 100644 --- a/Modules/Core/Transform/include/itkTransformBase.h +++ b/Modules/Core/Transform/include/itkTransformBase.h @@ -55,7 +55,7 @@ class TransformBaseTemplateEnums // Define how to print enumeration extern ITKTransform_EXPORT std::ostream & operator<<(std::ostream & out, const TransformBaseTemplateEnums::TransformCategory value); -/** \class itkTransformBaseTemplate +/** \class TransformBaseTemplate * * This class is an abstract class to represent a spatial transform. * diff --git a/Modules/Filtering/ImageGrid/include/itkBSplineCenteredL2ResampleImageFilterBase.h b/Modules/Filtering/ImageGrid/include/itkBSplineCenteredL2ResampleImageFilterBase.h index 5194d099c5f..3844269e082 100644 --- a/Modules/Filtering/ImageGrid/include/itkBSplineCenteredL2ResampleImageFilterBase.h +++ b/Modules/Filtering/ImageGrid/include/itkBSplineCenteredL2ResampleImageFilterBase.h @@ -33,7 +33,7 @@ namespace itk { -/** \class itkBSplineCenteredL2ResampleImageFilterBase +/** \class BSplineCenteredL2ResampleImageFilterBase * \brief Uses the "Centered L2" B-Spline pyramid implementation of B-Spline Filters * to up/down sample an image by a factor of 2. * diff --git a/Modules/Numerics/FEM/include/itkFEMLoadNoisyLandmark.h b/Modules/Numerics/FEM/include/itkFEMLoadNoisyLandmark.h index 0db4535128c..eb73d67c099 100644 --- a/Modules/Numerics/FEM/include/itkFEMLoadNoisyLandmark.h +++ b/Modules/Numerics/FEM/include/itkFEMLoadNoisyLandmark.h @@ -27,7 +27,7 @@ namespace itk namespace fem { /** - * \class itkFEMLoadNoisyLandmark + * \class FEMLoadNoisyLandmark * \brief This landmark is derived from the motion of a specific landmark, but * allows the existence of noise or outliers * From f0019cb8f91a37d6adc8cd116be0f0f79c05a0a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Mon, 9 Oct 2023 10:47:16 -0400 Subject: [PATCH 2/2] DOC: Fix `QuadEdgeMeshScalarDataVTKPolyDataWriter` Doxygen `class` name Fix the `itk::QuadEdgeMeshScalarDataVTKPolyDataWriter` class name in the Doxygen `\class` command. --- .../include/itkQuadEdgeMeshScalarDataVTKPolyDataWriter.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshScalarDataVTKPolyDataWriter.h b/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshScalarDataVTKPolyDataWriter.h index 8f07d992940..e6a190393c9 100644 --- a/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshScalarDataVTKPolyDataWriter.h +++ b/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshScalarDataVTKPolyDataWriter.h @@ -24,7 +24,7 @@ namespace itk { /** - * \class QuadEdgeMeshScalarDataVTKPolyData + * \class QuadEdgeMeshScalarDataVTKPolyDataWriter * * \brief This class saves a QuadMesh into a VTK-legacy file format, * including its scalar data associated with points.