Editing C++ style guide
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 396: | Line 396: | ||
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 Doxygen comments use only {{codeline|//!}} and NOT {{codeline|/*! ... */}} | * For Doxygen comments use only {{codeline|//!}} and NOT {{codeline|/*! ... */}} | ||
* Use {{codeline|@}} for any [https://www.stack.nl/~dimitri/doxygen/manual/commands.html Doxygen Special Commands] | * Use {{codeline|@}} for any [https://www.stack.nl/~dimitri/doxygen/manual/commands.html Doxygen Special Commands] | ||
* Use as little formatting as possible. Restrict to [https://www.stack.nl/~dimitri/doxygen/manual/markdown.html Markdown] and avoid HTML-markup. | * Use as little formatting as possible. Restrict to [https://www.stack.nl/~dimitri/doxygen/manual/markdown.html Markdown] and avoid HTML-markup. | ||
* Leave a blank line between the Doxygen comment and function definition. | * Leave a blank line between the Doxygen comment and function definition. | ||
Line 406: | Line 404: | ||
<syntaxhighlight lang="cpp"> | <syntaxhighlight lang="cpp"> | ||
//! | //! @brief Some cool function. | ||
//! | //! | ||
//! Long comment with **bold** special commands. | //! Long comment with **bold** special commands. | ||
Line 421: | Line 419: | ||
//! @endcode | //! @endcode | ||
void | void some_function (double some_param, int another_param) | ||
some_function (double some_param, int another_param) | |||
{ | { | ||
// ... | // ... |