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 400: | Line 400: | ||
* 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. | ||
* Do NOT use the {{codeline|@brief}} command, the first sentence will automatically be used as the summary description. | * Do NOT use the {{codeline|@brief}} command, the first sentence will automatically be used as the summary description. | ||
* The first sentence should describe briefly what the function does and | * The first sentence should describe briefly what the function does and and with a period. | ||
* Leave a blank line between the Doxygen comment and function definition. | * Leave a blank line between the Doxygen comment and function definition. | ||