Changeset View
Changeset View
Standalone View
Standalone View
doc/developer-notes.md
Show First 20 Lines • Show All 156 Lines • ▼ Show 20 Lines | |||||
/** | /** | ||||
* ... text ... | * ... text ... | ||||
* @param[in] arg1 A description | * @param[in] arg1 A description | ||||
* @param[in] arg2 Another argument description | * @param[in] arg2 Another argument description | ||||
* @pre Precondition for function... | * @pre Precondition for function... | ||||
*/ | */ | ||||
bool function(int arg1, const char *arg2) | bool function(int arg1, const char *arg2) | ||||
``` | ``` | ||||
A complete list of `@xxx` commands can be found at http://www.stack.nl/~dimitri/doxygen/manual/commands.html. | A complete list of `@xxx` commands can be found at http://www.doxygen.nl/manual/commands.html. | ||||
As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this case), you don't | As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this case), you don't | ||||
*need* to provide any commands for a comment to be valid; just a description text is fine. | *need* to provide any commands for a comment to be valid; just a description text is fine. | ||||
To describe a class use the same construct above the class definition: | To describe a class use the same construct above the class definition: | ||||
```c++ | ```c++ | ||||
/** | /** | ||||
* Alerts are for notifying old versions if they become too obsolete and | * Alerts are for notifying old versions if they become too obsolete and | ||||
* need to upgrade. The message is displayed in the status bar. | * need to upgrade. The message is displayed in the status bar. | ||||
Show All 24 Lines | |||||
Not OK (used plenty in the current source, but not picked up): | Not OK (used plenty in the current source, but not picked up): | ||||
```c++ | ```c++ | ||||
// | // | ||||
// ... text ... | // ... text ... | ||||
// | // | ||||
``` | ``` | ||||
A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html, | A full list of comment syntaxes picked up by doxygen can be found at http://www.doxygen.nl/manual/docblocks.html, | ||||
but if possible use one of the above styles. | but if possible use one of the above styles. | ||||
To build doxygen locally to test changes to the Doxyfile or visualize your comments before landing changes: | To build doxygen locally to test changes to the Doxyfile or visualize your comments before landing changes: | ||||
``` | ``` | ||||
ninja doc-doxygen | ninja doc-doxygen | ||||
# output goes to doc/doxygen/html/ | # output goes to doc/doxygen/html/ | ||||
``` | ``` | ||||
▲ Show 20 Lines • Show All 975 Lines • Show Last 20 Lines |