Skip to content

DOC: Define itkref and itksubref Doxygen reference macros #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
hjmjohnson wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −2
Draft

DOC: Define itkref and itksubref Doxygen reference macros #235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions SoftwareGuide/SoftwareGuideConfiguration.tex.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,18 @@
\itkFullVersiontrue

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

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

% Deprecated spellings of \itkref / \itksubref, kept for ITK branches that
% still use them in their Software Guide example blocks.
\newcommand{\doxygen}[1]{\itkref{#1}}
\newcommand{\subdoxygen}[2]{\itksubref{#1}{#2}}

% Define command for the standard comment introducing classes with similar functionalities
\newcommand{\relatedClasses}{
\textbf{The following classes provide similar functionality:}}
Loading