Skip to content

Commit aa77a56

Browse files
committed
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.
1 parent e943f7b commit aa77a56

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,9 @@ \subsection{Doxygen Documentation System}
274274
Doxygen requires the embedding of simple comments in the code which is in turn
275275
extracted and formatted into documentation.
276276

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

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

0 commit comments

Comments
 (0)