FARSIGHT Doxygen

From FarsightWiki
Jump to: navigation, search

Doxygen

Doxygen is a documentation system multiple programming languages. We use Doxygen to document FARSIGHT (COMING SOON).

http://www.stack.nl/~dimitri/doxygen/

Comment Format

For a detailed description (more than one line):

/** 
 *  A test class. A detailed class description. 
 *  This is a JavaDoc style.  Other alternatives (i.e. QT style) are available.
 */ 

For a brief description (one line span only):

/// Brief description.
/** Detailed description. */

For alternative styles and more information, click on the link: http://www.stack.nl/~dimitri/doxygen/docblocks.html