Skip to content

ENH: Fix Doxygen documentation paragraph #168

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

Merged
thewtex merged 2 commits into from
Dec 7, 2021
Merged

ENH: Fix Doxygen documentation paragraph #168

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa77a56
DOC: Fix Doxygen special command markup and provide example
jhlegarreta Dec 1, 2021
7db4436
DOC: Fix Doxygen link
jhlegarreta Dec 1, 2021
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
7 changes: 4 additions & 3 deletions SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,11 +274,12 @@ \subsection{Doxygen Documentation System}
Doxygen requires the embedding of simple comments in the code which is in turn
extracted and formatted into documentation.

Note that ITK prefers the backslash (\code{\textbackslash\textbackslash})
style versus the at-sign (\code{@}) style to write the documentation commands.
Note that ITK prefers the backslash (\code{\textbackslash}) style versus the
at-sign (\code{@}) style to write the documentation commands (e.g.
\code{\textbackslash{}class}).

For more information about Doxygen, please visit
\href{http://www.stack.nl/~dimitri/doxygen/}{http://www.stack.nl/~dimitri/doxygen/}
\href{https://www.doxygen.nl/index.html}{https://www.doxygen.nl/index.html}.

\subsection{vnl Math Library}
\label{subsec:vnlMathLibrary}
Expand Down