Skip to content

Commit f98424e

Browse files
authored
Merge pull request #5829 from blowekamp/fix-doxygen-group-warnings
DOC: Fix invalid Doxygen \ingroup references across ~66 headers
2 parents c7ac449 + 0f802a8 commit f98424e

69 files changed

Lines changed: 63 additions & 78 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.

Documentation/Doxygen/Modules.dox

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,16 @@
114114
\sa itk::Mesh
115115
*/
116116

117+
/**
118+
\defgroup QEMeshModifierFunctions QuadEdge Mesh Modifier Functions
119+
\ingroup MeshFilters
120+
121+
QuadEdge mesh modifier functions implement small, targeted modifications to
122+
QuadEdge meshes such as Euler operators (e.g., join/split vertex, flip edge).
123+
124+
\sa itk::QuadEdgeMesh
125+
*/
126+
117127
/**
118128
\defgroup IntensityImageFilters Intensity Image Filters
119129
\ingroup ImageFilters
@@ -393,10 +403,6 @@
393403
\ingroup DataProcessing
394404
*/
395405

396-
\defgroup ITKTransform Transforms
397-
\ingroup DataProcessing
398-
*/
399-
400406
/**
401407
\defgroup ImageAdaptors Image Adaptors
402408
\ingroup DataProcessing
@@ -519,6 +525,14 @@
519525
Basic operating system related system objects in ITK.
520526
*/
521527

528+
/**
529+
\defgroup LoggingObjects Logging Objects
530+
\ingroup OSSystemObjects
531+
532+
Objects implementing a logging framework for reporting messages,
533+
warnings, and errors during ITK processing.
534+
*/
535+
522536
/**
523537
\defgroup ThreadSafetyGroup Thread Safety
524538

Modules/Core/Common/include/itkBuildInformation.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ namespace itk
3838
* and other static information) that can be gathered
3939
* at configuration time.
4040
*
41-
* \ingroup Common
4241
* \ingroup ITKCommon
4342
*
4443
*/
@@ -63,7 +62,6 @@ class ITKCommon_EXPORT BuildInformation final : public Object
6362
/**
6463
* \class InformationValueType
6564
* An inner struct to organize dictionary values with descriptions
66-
* \ingroup Common
6765
* \ingroup ITKCommon
6866
*/
6967
class InformationValueType

Modules/Core/Common/include/itkImageConstIterator.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ namespace itk
4949
* the data is arranged in a 1D array as if it were [][][][slice][row][col]
5050
* with Index[0] = col, Index[1] = row, Index[2] = slice, etc.
5151
*
52-
* \ingroup ImageConstIterators
5352
* \par MORE INFORMATION
5453
* For a complete description of the ITK Image Iterators and their API, please
5554
* see the Iterators chapter in the ITK Software Guide. The ITK Software Guide

Modules/Core/Common/include/itkLoggerOutput.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ namespace itk
4444
* \author Hee-Su Kim, Compute Science Dept. Kyungpook National University,
4545
* ISIS Center, Georgetown University.
4646
*
47-
* \ingroup OSSystemObjects
47+
* \ingroup OSSystemObjects LoggingObjects
4848
* \ingroup ITKCommon
4949
*/
5050
class ITKCommon_EXPORT LoggerOutput : public OutputWindow

Modules/Core/Common/include/itkMersenneTwisterRandomVariateGenerator.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ namespace itk::Statistics
110110
* rjwagner at writeme dot com and Cokus at math dot washington dot edu
111111
* when you write.
112112
*
113-
* \ingroup Common
114113
* \ingroup ITKCommon
115114
*
116115
* \sphinx

Modules/Core/Common/include/itkRandomVariateGeneratorBase.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ namespace itk::Statistics
2525
/** \class RandomVariateGeneratorBase
2626
* \brief Defines common interfaces for random variate generators.
2727
*
28-
* \ingroup Common
2928
* \ingroup ITKCommon
3029
*/
3130
class ITKCommon_EXPORT RandomVariateGeneratorBase : public Object

Modules/Core/Common/include/itkStdStreamLogOutput.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace itk
3535
* ISIS Center, Georgetown University.
3636
*
3737
*
38-
* \ingroup OSSystemObjects LoggingObjects
38+
* \ingroup OSSystemObjects
3939
* \ingroup ITKCommon
4040
*/
4141

Modules/Core/FiniteDifference/include/itkFiniteDifferenceImageFilter.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ namespace itk
123123
* ApplyUpdate adds the buffer values to the output image (solution). The
124124
* boolean Halt() (or ThreadedHalt()) method returns a true value to stop iteration.
125125
*
126-
* \ingroup ImageFilter
126+
* \ingroup ImageFilters
127127
* \ingroup LevelSetSegmentation
128128
*
129129
* \sa DenseFiniteDifferenceImageFilter

Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshEulerOperatorSplitFacetFunction.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ namespace itk
2828
* new edge joining h->Destination() to g->Destination(), thus splitting
2929
* the original Left().
3030
*
31-
* \ingroup QuadEdgeMeshModifierFunctions
31+
* \ingroup QEMeshModifierFunctions
3232
* \ingroup ITKQuadEdgeMesh
3333
*/
3434
template <typename TMesh, typename TQEType>

Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshEulerOperatorSplitVertexFunction.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace itk
3232
*
3333
* \sa QuadEdgeMeshEulerOperatorJoinVertexFunction
3434
*
35-
* \ingroup QuadEdgeMeshModifierFunctions
35+
* \ingroup QEMeshModifierFunctions
3636
* \ingroup ITKQuadEdgeMesh
3737
*/
3838
template <typename TMesh, typename TQEType>

0 commit comments

Comments
 (0)