Skip to content

Commit 4d75072

Browse files
N-Dekkerhjmjohnson
authored andcommitted
DOC: Update documentation of GetNameOfClass macro calls
Made the documentation of the `GetNameOfClass()` member functions more specific, by referring to `LightObject`. Using Notepad++, Replace in Files: Find what: /\*\* .+ \*/\r\n itkOverrideGetNameOfClassMacro Replace with: /\*\* \\see LightObject::GetNameOfClass\(\) \*/\r\n itkOverrideGetNameOfClassMacro Find what: /\*\* .+ \*/\r\n itkVirtualGetNameOfClassMacro Replace with: /\*\* \\see LightObject::GetNameOfClass\(\) \*/\r\n itkVirtualGetNameOfClassMacro Filters: itk*.hxx;itk*.h;itk*.cxx [v] Match case (*) Regular expression Follow-up to pull request #4373 commit 2c264ea "STYLE: Replace itkTypeMacro calls with `itkOverrideGetNameOfClassMacro`" commit fa1f39a "STYLE: Replace itkTypeMacroNoParent with itkVirtualGetNameOfClassMacro"
1 parent 88bfbfd commit 4d75072

1,464 files changed

Lines changed: 1516 additions & 1516 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Modules/Bridge/VTK/include/itkVTKImageExport.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class ITK_TEMPLATE_EXPORT VTKImageExport : public VTKImageExportBase
6464
using ConstPointer = SmartPointer<const Self>;
6565
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
6666

67-
/** Run-time type information (and related methods). */
67+
/** \see LightObject::GetNameOfClass() */
6868
itkOverrideGetNameOfClassMacro(VTKImageExport);
6969

7070
/** Method for creation through the object factory. */

Modules/Bridge/VTK/include/itkVTKImageExportBase.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
4646
using Pointer = SmartPointer<Self>;
4747
using ConstPointer = SmartPointer<const Self>;
4848

49-
/** Run-time type information (and related methods). */
49+
/** \see LightObject::GetNameOfClass() */
5050
itkOverrideGetNameOfClassMacro(VTKImageExportBase);
5151

5252
/** Returns the user data to set for the vtkImageImport callbacks. */

Modules/Bridge/VTK/include/itkVTKImageImport.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
6767
/** Method for creation through the object factory. */
6868
itkNewMacro(Self);
6969

70-
/** Run-time type information (and related methods). */
70+
/** \see LightObject::GetNameOfClass() */
7171
itkOverrideGetNameOfClassMacro(VTKImageImport);
7272

7373
/** Convenient type alias from the output image. */

Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class ITK_TEMPLATE_EXPORT ImageToVTKImageFilter : public ProcessObject
5858
/** Method for creation through the object factory. */
5959
itkNewMacro(Self);
6060

61-
/** Run-time type information (and related methods). */
61+
/** \see LightObject::GetNameOfClass() */
6262
itkOverrideGetNameOfClassMacro(ImageToVTKImageFilter);
6363

6464
/** Some type alias. */

Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class ITK_TEMPLATE_EXPORT VTKImageToImageFilter : public VTKImageImport<TOutputI
6262
/** Method for creation through the object factory. */
6363
itkNewMacro(Self);
6464

65-
/** Run-time type information (and related methods). */
65+
/** \see LightObject::GetNameOfClass() */
6666
itkOverrideGetNameOfClassMacro(VTKImageToImageFilter);
6767

6868
/** Some type alias. */

Modules/Compatibility/Deprecated/include/itkBarrier.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class ITKDeprecated_EXPORT Barrier : public LightObject
5757
/** Method for creation through the object factory. */
5858
itkNewMacro(Self);
5959

60-
/** Run-time type information (and related methods). */
60+
/** \see LightObject::GetNameOfClass() */
6161
itkOverrideGetNameOfClassMacro(Barrier);
6262

6363
/** Creates a new system variable used to implement the barrier. The

Modules/Compatibility/Deprecated/include/itkConditionVariable.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class ITKDeprecated_EXPORT ConditionVariable : public LightObject
7070
/** Method for creation through the object factory. */
7171
itkNewMacro(Self);
7272

73-
/** Run-time type information (and related methods). */
73+
/** \see LightObject::GetNameOfClass() */
7474
itkOverrideGetNameOfClassMacro(ConditionVariable);
7575

7676
/** Suspend execution of this thread until the condition is signaled. The

Modules/Compatibility/Deprecated/include/itkFastMutexLock.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class ITKDeprecated_EXPORT FastMutexLock : public Object
7171
/** Method for creation. */
7272
itkNewMacro(Self);
7373

74-
/** Run-time type information. */
74+
/** \see LightObject::GetNameOfClass() */
7575
itkOverrideGetNameOfClassMacro(FastMutexLock);
7676

7777
/** Lock the itkFastMutexLock. */

Modules/Compatibility/Deprecated/include/itkImageTransformer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class ITK_TEMPLATE_EXPORT ImageTransformer : public ProcessObject
7171
/** Smart Pointer type to a DataObject. */
7272
using DataObjectPointer = DataObject::Pointer;
7373

74-
/** Run-time type information (and related methods). */
74+
/** \see LightObject::GetNameOfClass() */
7575
itkOverrideGetNameOfClassMacro(ImageTransformer);
7676

7777
/** Some convenient type alias. */

Modules/Compatibility/Deprecated/include/itkMutexLock.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ class ITKDeprecated_EXPORT MutexLock : public Object
130130
/** Method for creation. */
131131
itkNewMacro(Self);
132132

133-
/** Run-time information. */
133+
/** \see LightObject::GetNameOfClass() */
134134
itkOverrideGetNameOfClassMacro(MutexLock);
135135

136136
/** Lock the itkMutexLock. */

0 commit comments

Comments
 (0)