Skip to content

Commit 002ea47

Browse files
committed
DOC: Print backslash mark
Print backslash mark. Fixes: ``` Note that ITK prefers the backslash (" ") style versus the at-sign (“@”) style to write the documentation command ``` and ``` When documenting a class header, if citations are required, use the Doxygen `par References` command to list the references in a separate and clearly visible paragraph ``` Use the `code` command for the at-sign as well for the sake of consistency.
1 parent dbfd078 commit 002ea47

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@ \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 (``\\'') style versus the at-sign (``@'')
278-
style to write the documentation commands.
277+
Note that ITK prefers the backslash (\code{\textbackslash\textbackslash})
278+
style versus the at-sign (\code{@}) style to write the documentation commands.
279279

280280
For more information about Doxygen, please visit
281281
\href{http://www.stack.nl/~dimitri/doxygen/}{http://www.stack.nl/~dimitri/doxygen/}
@@ -361,7 +361,7 @@ \section{Citations}
361361
not use URL shortening services.
362362

363363
When documenting a class header, if citations are required, use the Doxygen
364-
\code{\\par References} command to list the references in a separate and clearly
364+
\code{{\textbackslash}par References} command to list the references in a separate and clearly
365365
visible paragraph.
366366

367367
For instance,

0 commit comments

Comments
 (0)