Doxygen is a standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages Fortran. Visit the [[http://www.doxygen.org/|main page]] for more details.

==== Instalation: ====

The following packages must be installed:

<code>
sudo apt-get install doxygen

sudo apt-get install graphviz
</code>

==== Documenting the code: ====

The code must be documented in one of the following options:

1. C-style comment block

<code>
/**
 * ... text ...
 */
</code>

2. Qt style

<code>
/*!
 * ... text ...
 */
</code>

3. C++-like comment lines

<code>
///
/// ... text ...
///
</code>

or

<code>
//!
//!... text ...
//!
</code>

For brief descriptions, the following format must be used:

1.

<code>
/*! brief Brief description.
 *   Brief description continued.
 *
 *  Detailed description starts here.
 */
</code>

2.

<code>
/// Brief description which ends at this dot. Details follow
/// here.
</code>

3.

<code>
/// Brief description.
/** Detailed description. */
</code>

or

<code>
//! Brief description.

//! Detailed description
//! starts here.
</code>

==== Creating the documentation: ====

The documentation can be created by many ways with doxygen. The most general is setting a Doxyfile, i. e., a file which describes the settings to be used by the doxygen documentation system. It can be done by accessing the program repository and typing the command

<code>
doxygen -g Doxyfile
</code>

A standard Doxyfile is created and can be personalized with many options.

To create the documentation file run

<code>
doxygen Doxyfile
</code>

If GENERATE_HTML is set to YES, doxygen will generate HTML output. Then open the index.html file to view the code documentation. For more information about doxygen and personalization issues click [[http://www.stack.nl/~dimitri/doxygen/manual/index.html|here]].

You can download the current Doxyfile used by the research group {{:doxyfile.txt|here}}.