doxygen
This is an old revision of the document!
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.
doxygen.1525292743.txt.gz · Last modified: by jeferson