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
software/doxygen.txt · Last modified: 2013/09/19 16:40 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki