DOC: Rename \doxygen/\subdoxygen aliases to \itkref/\itksubref#6416
Merged
hjmjohnson merged 2 commits intoJun 11, 2026
Merged
Conversation
github-actions
Bot
added
type:Infrastructure
hjmjohnson
force-pushed
the
doxygen-itkref-rename
branch
from
c04ecf0 to
9d6416a
Compare
hjmjohnson
changed the title
hjmjohnson
force-pushed
the
doxygen-itkref-rename
branch
from
9d6416a to
8d38f85
Compare
github-actions
Bot
removed
the
area:Segmentation
hjmjohnson
changed the title
Member
Author
|
@albert-github would you mind reviewing this, please? |
This comment was marked as resolved.
This comment was marked as resolved.
albert-github
left a comment
albert-github
left a comment
Contributor
There was a problem hiding this comment.
Looks in principle OK just some remarks as noted in the comments etc.
Seen the shear size of the PR I think a doxygen run would also be beneficial to run on the code.
hjmjohnson
force-pushed
the
doxygen-itkref-rename
branch
from
8d38f85 to
0c477a6
Compare
github-actions
Bot
added
the
type:Documentation
albert-github
left a comment
albert-github
left a comment
Contributor
There was a problem hiding this comment.
Was still in my cache ....
Member
Author
|
Companion PR for the Software Guide LaTeX side: InsightSoftwareConsortium/ITKSoftwareGuide#235 defines |
Member
Author
|
Ran the verification Doxygen pass @albert-github suggested: warning output is byte-identical between this branch and Method and timing
|
albert-github
approved these changes
Jun 11, 2026
Introduce \itkref and \itksubref as the in-tree spellings of the class and namespaced-class cross-reference aliases, and convert all uses in Modules and Examples. The historical \doxygen and \subdoxygen aliases are retained as deprecated synonyms so out-of-tree code and external tools that still emit them continue to resolve; \subdoxygen was previously undefined, so this also gives those uses a definition.
The deprecated \doxygen/\subdoxygen aliases now render an inline "error: deprecated ... alias" marker ahead of the still-working reference, steering remote modules and out-of-tree consumers to Utilities/ITKMigrationPreparation/update_doxygen_for_itkv6.py.
hjmjohnson
force-pushed
the
doxygen-itkref-rename
branch
from
0c477a6 to
1acdf7e
Compare
dzenanz
approved these changes
Jun 11, 2026
Member
Author
|
@greptileai review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Renames the Doxygen class cross-reference aliases
\doxygen→\itkrefand\subdoxygen→\itksubreftoolkit-wide, keeping the old names as deprecated synonyms for out-of-tree code and external tools. Split out of #6411 (merged) so that PR stayed a focused warning-clear; now rebased ontomain, the diff shows only the rename. Companion: InsightSoftwareConsortium/ITKSoftwareGuide#235 defines the new LaTeX macros for the Software Guide pipeline and must merge first.What this changes
In
Utilities/Doxygen/DoxygenConfig.cmake:\itkref{1}=\ref \1— in-tree spelling of the single-class reference.\itksubref{2}=\ref itk::\1::\2— in-tree spelling of the namespaced-class reference (\itksubref{Statistics}{Histogram}→itk::Statistics::Histogram).\doxygen{1}and\subdoxygen{2}as deprecated synonyms (marked with a comment).Conversions across 250 files:
\doxygen{...}→\itkref{...}— 816 uses (221 files; 221 inExamples/, 20 inModules/).\subdoxygen{...}{...}→\itksubref{...}{...}— 85 uses (31Examples/files).Mechanical, comment-only change (the aliases appear only in Doxygen doc comments).
pre-commit run --all-filesis clean.Why / notes
Reviewer request on #6411 (albert-github): the
\doxygenalias name is too generic.\itkref/\itksubrefread as ITK cross-references and free the old names.\subdoxygenwas previously never defined inDoxygenConfig.cmakedespite being used in-tree (Examples) and by remote modules (e.g. BioCell\subdoxygen{bio}{Cell}); defining it as a deprecated synonym additionally makes those existing uses resolve instead of being unknown commands. Backwards compatibility is preserved so no in-repo or out-of-tree documentation breaks.