Skip to content

Commit 1ff52e0

Browse files
committed
DOC: Define \itkref and \itksubref Doxygen reference macros
Companion to InsightSoftwareConsortium/ITK#6416, which renames the \doxygen/\subdoxygen spellings in the ITK Software Guide example blocks. The old names remain as aliases for ITK branches that still use them.
1 parent 7510e24 commit 1ff52e0

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

SoftwareGuide/SoftwareGuideConfiguration.tex.in

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,18 @@
1515
\itkFullVersiontrue
1616

1717
% Define command to make reference to on-line Doxygen documentation
18-
\newcommand{\doxygen}[1]{
18+
\newcommand{\itkref}[1]{
1919
\href{https://www.itk.org/Doxygen/html/classitk_1_1#1.html}{\code{itk::#1}}}
2020

2121
% Define command to make reference to on-line Doxygen documentation
22-
\newcommand{\subdoxygen}[2]{
22+
\newcommand{\itksubref}[2]{
2323
\href{https://www.itk.org/Doxygen/html/classitk_1_1#1_1_1#2.html}{\code{itk::#1::#2}}}
2424

25+
% Deprecated spellings of \itkref / \itksubref, kept for ITK branches that
26+
% still use them in their Software Guide example blocks.
27+
\newcommand{\doxygen}[1]{\itkref{#1}}
28+
\newcommand{\subdoxygen}[2]{\itksubref{#1}{#2}}
29+
2530
% Define command for the standard comment introducing classes with similar functionalities
2631
\newcommand{\relatedClasses}{
2732
\textbf{The following classes provide similar functionality:}}

0 commit comments

Comments
 (0)