Skip to content

Commit e481462

Browse files
author
Jon Haitz Legarreta
committed
ENH: Set the preferred Doxygen documentation style explictly.
Set the preferred Doxygen documentation style explicityle following the discussion in: http://review.source.kitware.com/#/c/23399/
1 parent 15a0875 commit e481462

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,9 @@ \subsection{Doxygen Documentation System}
271271
Doxygen requires the embedding of simple comments in the code which is in turn
272272
extracted and formatted into documentation.
273273

274+
Note that ITK prefers the backslash (``\\'') style versus the at-sign (``@'')
275+
style to write the documentation commands.
276+
274277
For more information about Doxygen, please visit
275278
\href{http://www.stack.nl/~dimitri/doxygen/}{http://www.stack.nl/~dimitri/doxygen/}
276279

0 commit comments

Comments
 (0)