From aa77a5694999116a4694dfdd771bf19c81feecb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Tue, 30 Nov 2021 20:28:44 -0500 Subject: [PATCH 1/2] DOC: Fix Doxygen special command markup and provide example Fix Doxygen special command markup: use a single backslash. Provide an example of the use of such commands. --- SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex index bdd7aa48..d1b174a4 100644 --- a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex +++ b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex @@ -274,8 +274,9 @@ \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/} From 7db443691175abe573702fadfaf97b9d4737dc8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Tue, 30 Nov 2021 20:31:22 -0500 Subject: [PATCH 2/2] DOC: Fix Doxygen link Fix Doxygen link. --- SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex index d1b174a4..ace41c95 100644 --- a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex +++ b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex @@ -279,7 +279,7 @@ \subsection{Doxygen Documentation System} \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}