Skip to content

Commit c139163

Browse files
jhlegarretadzenanz
jhlegarreta
authored and
dzenanz
committed
DOC: Use Doxygen automatic class links in module descriptions
Use Doxygen automatic class links in module descriptions: use qualified class names, and take advantage of the commit to fix the spelling of some class names. Fix the `itk::QuadEdgeMeshFunctionBase` class name in its Doxygen class documentation so that the - class detailed description is displayed correctly in the ITK Doxygen documentation, - links in the module descriptions point to the proper class
1 parent 4b5842f commit c139163

File tree

11 files changed

+34
-31
lines changed

11 files changed

+34
-31
lines changed

‎CMake/ITKGroups.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ set(group_list
1616

1717
set(Core_documentation "This group of modules contain the toolkit framework used
1818
by other modules. There are common base classes for data objects and process
19-
objects, basic data structures such as Image, Mesh, QuadEdgeMesh, and
20-
SpatialObjects, and common functionality for operations such as finite
19+
objects, basic data structures such as itk::Image, itk::Mesh, itk::QuadEdgeMesh, and
20+
ik::SpatialObject, and common functionality for operations such as finite
2121
differences, image adaptors, or image transforms.")
2222

2323
set(Compatibility_documentation "This group contains modules that ease the transition to ITKv4 and Deprecated classes.")

‎Modules/Core/Common/itk-module.cmake

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
set(DOCUMENTATION "This module contains the central classes of the ITK
2-
toolkit. They include, basic data structures \(such as Points, Vectors,
3-
Images, Regions\) the core of the process objects \(such as base
4-
classes for image filters\) the pipeline infrastructure classes, the support
5-
for multi-threading, and a collection of classes that isolate ITK from
2+
toolkit. They include, basic data structures \(such as points, vectors,
3+
images, regions: itk::Point, itk::Vector, itk::Image, itk::Region)
4+
the core of the process objects \(such as base classes for image
5+
filters\) the pipeline infrastructure classes, the support for
6+
multi-threading, and a collection of classes that isolate ITK from
67
platform specific features. It is anticipated that most other ITK modules will
78
depend on this one.")
89

‎Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshFunctionBase.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@
2424
namespace itk
2525
{
2626
/**
27-
* \class MeshFunctionBase
27+
* \class QuadEdgeMeshFunctionBase
2828
* \ingroup QEMeshModifierFunctions
2929
* \brief Base class for mesh function object modifiers.
3030
*
31-
* MeshFunctionBase is the base class for itkQE function objects specialised
31+
* QuadEdgeMeshFunctionBase is the base class for itkQE function objects specialised
3232
* in Mesh "small" (reduced in range) modification.
3333
* Subclasses of itk::FunctionBase cannot modify their InputType since
3434
* the signature of their Evaluate( const InputType& ) method guarantees it.
@@ -39,8 +39,8 @@ namespace itk
3939
* But for small modifications (think of the Euler operators) that an
4040
* algorithm needs to apply many times, this systematic duplication can
4141
* be daunting.
42-
* MeshFunctionBase thus offers a lightweight alternative to itk Filter.
43-
* Subclasses of MeshFunctionBase, which should override Evaluate(), are
42+
* QuadEdgeMeshFunctionBase thus offers a lightweight alternative to itk Filter.
43+
* Subclasses of QuadEdgeMeshFunctionBase, which should override Evaluate(), are
4444
* function objects that apply reduced and localised modifications
4545
* (geometry, or connectivity) on the InputType mesh.
4646
*

‎Modules/Core/QuadEdgeMesh/itk-module.cmake

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,22 @@ But itk::FunctionBase could not be inherited since its
3636
itk::FunctionBase::Evaluate method promises to leave its argument (the mesh we
3737
want to modify in our case) untouched.
3838
39-
Hence the itk::MeshFunctionBase class was created whose main difference with
40-
itk::FunctionBase is that its itk::MeshFunctionBase::Evaluate method allows
41-
to modify the considered mesh.
39+
Hence the itk::QuadEdgeMeshFunctionBase class was created whose main
40+
difference with itk::FunctionBase is that its
41+
itk::QuadEdgeMeshFunctionBase::Evaluate method allows to modify the considered
42+
mesh.
4243
4344
When considering a new QuadEdgeMesh method there are four possible \"slots\"
4445
to implement it:
45-
- The QuadEdgeMesh method.
46+
- The itk::QuadEdgeMesh class.
4647
- A derived class from itk::FunctionBase when the method leaves the mesh
4748
constant.
48-
- A derived class from itk::MeshFunctionBase when the method modifies the
49+
- A derived class from itk::QuadEdgeMeshFunctionBase when the method modifies the
4950
mesh (typically in the case of Euler operators).
5051
- As a classic ITKMesh filter.
5152
5253
The choice of the slot is a mere matter of trade-off and in order to keep
53-
QuadEdgeMesh tiny and humanly readable key decision factors can be the
54+
itk::QuadEdgeMesh tiny and humanly readable key decision factors can be the
5455
occurrence of the calls and the human level complexity of the code.
5556
5657
With those criteria in mind the following choices were made:

‎Modules/Core/SpatialObjects/itk-module.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
set(DOCUMENTATION "SpatialObjects are intended to represent regions in space.
2-
The basic functionality of a SpatialObject is to answer the question of
3-
whether a physical point is inside or outside of the SpatialObject. They are
2+
The basic functionality of an itk::SpatialObject is to answer the question of
3+
whether a physical point is inside or outside of the itk::SpatialObject. They are
44
commonly used for representing masks in an analytical form, as well as
55
approximations of shape by combining them into hierarchical structures similar
66
to scene graphs.")

‎Modules/Filtering/FastMarching/itk-module.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
set(DOCUMENTATION "This module contains implementations of generalized versions
22
of the Fast Marching filter. These implementations cover the use of Fast
3-
Marching in both itk::Images and itk::QuadEdgeMeshes.")
3+
Marching in both itk::Image and itk::QuadEdgeMesh objects.")
44

55
itk_module(ITKFastMarching
66
ENABLE_SHARED

‎Modules/IO/ImageBase/itk-module.cmake

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
set(DOCUMENTATION "This module contains base classes for IO, helper classes for
2-
IO, and classes that function as an ImageSource in an ITK pipeline. Classes for
2+
IO, and classes that function as an ImageSource in an ITK pipeline. Classes for
33
specific file formats, found in other modules in the IO group, should inherit
4-
from ImageIOBase or StreamingImageIOBase. For an image source or sink in the ITK
4+
from itk::ImageIOBase or itk::StreamingImageIOBase. For an image source or sink in the ITK
55
pipeline that handles all available file formats, see ImageFileReader,
6-
ImageFileWriter, ImageSeriesReader, or ImageSeriesWriter. Convenience classes
7-
for reading series of files include ArchetypeSeriesFileNames,
8-
NumericSeriesFileNames, and RegularExpressionSeriesFileNames.")
6+
itk::ImageFileWriter, itk::ImageSeriesReader, or itk::ImageSeriesWriter. Convenience classes
7+
for reading series of files include itk::ArchetypeSeriesFileNames,
8+
itk::NumericSeriesFileNames, and itk::RegularExpressionSeriesFileNames.")
99

1010
itk_module(ITKIOImageBase
1111
ENABLE_SHARED

‎Modules/IO/MeshBase/itk-module.cmake

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
set(DOCUMENTATION "This module contains base classes for IO, helper classes for
2-
IO, and classes that function as an MeshSource in an ITK pipeline. Classes for
2+
IO, and classes that function as an itk::MeshSource in an ITK pipeline. Classes for
33
specific file formats, found in other modules in the IO group, should inherit
4-
from MeshIOBase. For a mesh source or sink in the ITK
5-
pipeline that handles all available file formats, see MeshFileReader,
6-
or MeshFileWriter.")
4+
from itk::MeshIOBase. For a mesh source or sink in the ITK
5+
pipeline that handles all available file formats, see itk::MeshFileReader,
6+
or itk::MeshFileWriter.")
77

88
itk_module(ITKIOMeshBase
99
ENABLE_SHARED

‎Modules/Numerics/Statistics/itk-module.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ statistical algorithms, and a classification for general statistical analysis
33
and classification problems. This includes, for examples, classes for
44
calculating histograms, calculating sample statistics, creating decision rules,
55
or for performing statistical pattern classification. Statistics are calculated
6-
on a Sample, which contains MeasurementVector's.")
6+
on an itk::Sample, which contains measurement vectors.")
77

88
itk_module(ITKStatistics
99
ENABLE_SHARED

‎Modules/Video/Core/itk-module.cmake

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ set(DOCUMENTATION "This module contains base classes for processing data that
22
possesses a temporal element. The classes contained in this module extend the
33
traditional data object and process objects to handle time properly and also
44
contain convenience classes for passing temporal regions and dealing with ITK
5-
images over time in the form of VideoStreams and VideoToVideoFilters.")
5+
images over time in the form of itk::VideoStream and itk::VideoToVideoFilter
6+
objects.")
67

78
itk_module(ITKVideoCore
89
ENABLE_SHARED

0 commit comments

Comments
 (0)