Skip to content

Commit a0d0b4c

Browse files
committed
DOC: Link groups in Doxygen in module description
Create links to referenced groups when generating the Doxygen documentation from the module description. Doxygen grouping documentation: https://www.doxygen.nl/manual/grouping.html
1 parent 4b5842f commit a0d0b4c

File tree

12 files changed

+23
-20
lines changed

12 files changed

+23
-20
lines changed

CMake/ITKGroups.cmake

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ create a processing pipeline.")
3232

3333
set(Registration_documentation "This group of modules address the registration
3434
problem: find the spatial transformation between two images. This is a high
35-
level group that makes use of many lower level modules such as ITKTransform,
36-
ITKOptimizers, ITKFiniteDifference, and ITKFEM.")
35+
level group that makes use of many lower level modules such as
36+
\ref ITKTransform, \ref ITKOptimizers, \ref ITKFiniteDifference, and
37+
\ref ITKFEM.")
3738

3839
set(Segmentation_documentation "This group of modules address the segmentation
3940
problem: partition the image into classified regions (labels). This is a high
40-
level group that makes use of many lower level modules such as ITKQuadEdgeMesh
41-
and ITKNarrowBand.")
41+
level group that makes use of many lower level modules such as
42+
\ref ITKQuadEdgeMesh and \ref ITKNarrowBand.")
4243

4344
set(Numerics_documentation "This group of modules are basic numerical tools and
4445
algorithms that have general applications outside of imaging.")

Modules/Filtering/AnisotropicSmoothing/itk-module.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ set(DOCUMENTATION "This module contains filters that implement variations of
22
anisotropic smoothing. This is an image denoising technique that strives for
33
preserving edges on the images while smoothing regions of uniform intensity.
44
This type of filtering is convenient as a preprocessing stage of segmentation
5-
algorithms. You may find useful as well the filters in the ITKCurvatureFlow
6-
module and the ITKSmoothingModule.")
5+
algorithms. You may find useful as well the filters in the \ref ITKCurvatureFlow
6+
module and the \ref ITKSmoothingModule.")
77

88
itk_module(ITKAnisotropicSmoothing
99
COMPILE_DEPENDS

Modules/Filtering/GPUAnisotropicSmoothing/itk-module.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ implement variations of anisotropic smoothing. This is an image denoising
33
technique that strives for preserving edges on the images while smoothing regions
44
of uniform intensity. This type of filtering is convenient as a preprocessing
55
stage of segmentation algorithms. You may find useful as well the filters in the
6-
ITKGPUSmoothingModule.")
6+
\ref ITKGPUSmoothingModule.")
77

88
itk_module(ITKGPUAnisotropicSmoothing
99
DEPENDS

Modules/Filtering/GPUSmoothing/itk-module.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set(DOCUMENTATION "This module contains the GPU implementation of the
22
most common image smoothing filters. For example, Gaussian and Median
33
filters. You may also find it interesting to look at the
4-
ITKAnisotropicSmoothing group of filters.")
4+
\ref ITKAnisotropicSmoothing group of filters.")
55

66
itk_module(ITKGPUSmoothing
77
DEPENDS

Modules/Filtering/Smoothing/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 includes the most common image smoothing
22
filters. For example, Gaussian and Median filters. You may also find it
3-
interesting to look at the ITKAnisotropicSmoothing group of filters.")
3+
interesting to look at the \ref ITKAnisotropicSmoothing group of filters.")
44

55
itk_module(ITKSmoothing
66
ENABLE_SHARED

Modules/Registration/Common/itk-module.cmake

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ registration procedure. There are classes to perform multi-resolution image
66
registration and also classes to registrations other that image-to-image
77
registrations, e.g. point set-to-image or point set-to-point set
88
registrations. Transforms used in the registration can be found in
9-
ITKTransform, and optimizers can be found in ITKOptimizers. To compare the
10-
moving image to the fixed image with the image metric, an interpolator is
11-
required-- these can be found in ITKImageFunction.")
9+
\ref ITKTransform, and optimizers can be found in \ref ITKOptimizers. To
10+
compare the moving image to the fixed image with the image metric, an
11+
interpolator is required-- these can be found in \ref ITKImageFunction.")
1212

1313
if(BUILD_EXAMPLES)
1414
set(EXAMPLE_TEST_CASE_DEPENDANCIES

Modules/Segmentation/Classifiers/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 algorithms to classify pixels in an
22
image. It can be used, for example, to identify pixel membership within a set
33
of tissue types. Different algorithms are available including Bayesian
44
classification, Gaussian models, and K-means clustering. After tissue labels
5-
have been assigned, they can be modified and applied with the ITKLabelMap.")
5+
have been assigned, they can be modified and applied with the
6+
\ref ITKLabelMap.")
67

78
itk_module(ITKClassifiers
89
DEPENDS

Modules/Segmentation/ConnectedComponents/itk-module.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set(DOCUMENTATION "This module contains modules to identify and modify connected
22
components. Theses algorithms are commonly applied to binary or label map
3-
images. See also ITKClassifiers, ITKLabelMap, and
4-
ITKBinaryMathematicalMorphology.")
3+
images. See also \ref ITKClassifiers, \ref ITKLabelMap, and
4+
\ref ITKBinaryMathematicalMorphology.")
55

66
itk_module(ITKConnectedComponents
77
DEPENDS

Modules/Segmentation/KLMRegionGrowing/itk-module.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set(DOCUMENTATION "This module contains classes to perform energy-based region
22
growing for multiband images. Since this is based on G. Koepfler, C. Lopez and
33
J. M. Morel's work, the acronym KLM is added to quality the region growing
4-
method. See also ITKRegionGrowing.")
4+
method. See also \ref ITKRegionGrowing.")
55

66
itk_module(ITKKLMRegionGrowing
77
ENABLE_SHARED

Modules/Segmentation/LabelVoting/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 filters that perform label voting, i.e.
22
they count the number of pixels with a given label within a neighborhood and
33
determine the output pixel based on the count. The operations on label images
44
are similar to filtering on scalar images. See also
5-
ITKBinaryMathematicalMorphology, ITKConnectedComponents, and ITKLabelMap.")
5+
\ref ITKBinaryMathematicalMorphology, \ref ITKConnectedComponents, and
6+
\ref ITKLabelMap.")
67

78
itk_module(ITKLabelVoting
89
DEPENDS

Modules/Segmentation/MarkovRandomFieldsClassifiers/itk-module.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set(DOCUMENTATION "This module contains classes to perform Markov Random Field
22
classification of image pixels. An initial label image, perhaps generated by
3-
ITKClassifiers, is improved by iteratively accounting for the spatial coherence
4-
of the labels.")
3+
\ref ITKClassifiers, is improved by iteratively accounting for the spatial
4+
coherence of the labels.")
55

66
itk_module(ITKMarkovRandomFieldsClassifiers
77
ENABLE_SHARED

Modules/Segmentation/RegionGrowing/itk-module.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set(DOCUMENTATION "This module contains classes to perform the region growing
22
approach to image segmentation. A seed pixel is iteratively propagated to a
33
region identifying a tissue type by testing if connected pixels pass a criteria.
4-
See also ITKKLMRegionGrowing.")
4+
See also \ref ITKKLMRegionGrowing.")
55

66
itk_module(ITKRegionGrowing
77
ENABLE_SHARED

0 commit comments

Comments
 (0)