156
edits
(Added information about the preferred style used in Doxygen) |
(→Doxygen Style Guide: Disallowed →! ...: as valid doxygen comments) |
||
Line 29: | Line 29: | ||
Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project the following rules should be applied: | Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project the following rules should be applied: | ||
* For | * For Doxygen comments use only {{codeline|//!}} and NOT {{codeline|/*! ... */}} | ||
* Use {{codeline|@}} for any Doxygen Special Commands | * Use {{codeline|@}} for any Doxygen Special Commands | ||
Line 37: | Line 35: | ||
<pre> | <pre> | ||
//! | //! Comment with special command and syntax highlighting: | ||
//! @code{.cc} | |||
//! double v = 1.0; | |||
//! @endcode | |||
</pre> | </pre> | ||
[[Category:Development]] | [[Category:Development]] |
edits