Table of Contents
Doxygen is a standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages Fortran. Visit the main page for more details.
Instalation:
The following packages must be installed:
sudo apt-get install doxygen sudo apt-get install graphviz
Documenting the code:
The code must be documented in one of the following options:
1. C-style comment block
/** * ... text ... */
2. Qt style
/*! * ... text ... */
3. C++-like comment lines
/// /// ... text ... ///
or
//! //!... text ... //!
For brief descriptions, the following format must be used:
1.
/*! brief Brief description. * Brief description continued. * * Detailed description starts here. */
2.
/// Brief description which ends at this dot. Details follow /// here.
3.
/// Brief description. /** Detailed description. */
or
//! Brief description. //! Detailed description //! starts here.
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
doxygen -g Doxyfile
A standard Doxyfile is created and can be personalized with many options.
To create the documentation file run
doxygen Doxyfile
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 here.
You can download the current Doxyfile used by the research group here.