Difference between revisions of "Doxygen notes"
Jump to navigation
Jump to search
m (Add section "Headers, Classes and Routines" relating to Doxygen code documenting.) |
m (Doxygen Groups : comment blocks for multiple functions) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 21: | Line 21: | ||
In-body routine comments . . . | In-body routine comments . . . | ||
* https://stackoverflow.com/questions/11193019/doxygen-in-body-comments | * https://stackoverflow.com/questions/11193019/doxygen-in-body-comments | ||
| + | |||
| + | == [[#top|^]] Groups == | ||
| + | |||
| + | Need to learn whether white space is permitted in names passed to Doxygen's @defgroup command . . . | ||
| + | |||
| + | * https://www.doxygen.nl/manual/grouping.html | ||
| + | |||
| + | Single comment block for multiple functions, Doxygen groups . . . | ||
| + | |||
| + | * https://stackoverflow.com/questions/37284399/doxygen-single-comment-block-for-multiple-functions | ||
<!-- EOF --> | <!-- EOF --> | ||
Latest revision as of 19:16, 7 January 2026
2023-09-26 Doxygen notes
Looking for Doxygen reference showing supported Doxygen keywords or commands, e.g. @param, @brief.
Link to one of Doxygen's special commands:
Ah and it turns out the above link to Doxygen's online manual section named "commands.html" is the list of commands:
^ Headers, Classes and Routines
- https://pages.cs.wisc.edu/~jignesh/cs564/notes/Doxygen.pdf Professor Jignesh University of Wisconsin intro tutorial
In-body routine comments . . .
^ Groups
Need to learn whether white space is permitted in names passed to Doxygen's @defgroup command . . .
Single comment block for multiple functions, Doxygen groups . . .