Doxygen
Syntax tips
- to comment before the object, “
/ / /” for single line comment or “/** */” for multiline comments - to comment after the object (eg on the same line), “
/ / / <” for single line comment - put a '%' sign before a name to prevent automatic link to a class or namespace name
- to put a link to function, write its full signature including const, eg
ImageReader::loadImage(unsigned int, image::Image&) const
