Skip to content

Commit

Permalink
DOC: Remove itk prefix to class names in Doxygen class command
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jhlegarreta committed Oct 10, 2023
1 parent 80446b1 commit 2dd28a4
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
Expand Up @@ -23,7 +23,7 @@

namespace itk
{
/** \class itkTreeIteratorClone
/** \class TreeIteratorClone
* \brief itkTreeIteratorClone class
* \ingroup DataRepresentation
* \ingroup ITKDeprecated
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkFloatingPointExceptions.h
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Transform/include/itkTransformBase.h
Expand Up @@ -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.
*
Expand Down
Expand Up @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion Modules/Numerics/FEM/include/itkFEMLoadNoisyLandmark.h
Expand Up @@ -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
*
Expand Down

0 comments on commit 2dd28a4

Please sign in to comment.