@MLXXXp’s suggestion is good - Arduboy2’s documentation is demonstrates many of the core Doxygen keywords (e.g.
/brief), as well as some of the more ‘detailed’ ones (e.g.
/param), and also demonstrates an exceptional level of detail/coverage.
There’s also my sequel library prototype,
which demonstrates a very minimalist use of Doxygen comments.
(So minimalist that if I hadn’t told you they generate valid ‘brief’ and ‘detailed’ Doxygen descriptions you might not even notice they weren’t ordinary comments.)
(There’s a good example here.)
Unfortunately I don’t have pregenerated Doxygen for that,
but I can generate some upon request.
And the Doxygen comments I (and I would presume @FManga) provided for Femto’s Java API.
(There’s a good example here).
The generated output should be somewhere, but I’m not sure quite where,
so I’ll point you to the old copy that I generated myself.
Note especially that there are code examples included with the documentation.
Also note that Doxygen can be set to recognise markdown, as well as HTML tags like
so presentation can be very flexible.
One last thing I’d like to mention quickly (though I think I’ve mentioned it before),
is that I think it’s better to use single-line Doxygen comments (e.g.
//!) rather than multiline comments.
Aside from the fact they look more uniform, I think they’re easier to add to and shuffle around because you don’t have to worry about aligning asterisks or dealing with start and end markers (
Also you can just add an extra
/ to your normal single-line comments and then worry about adding Doxygen-specific keywords/directives later.
* \brief Brief description.
* Brief description continued.
* Detailed description starts here.
/// \brief Brief description.
/// Brief description continued.
/// Detailed description starts here.