Documentation du code avec Doxygen

$ sudo apt-get install doxygen doxygen-gui doxygen-doc

$ sudo apt-get install graphviz

$ doxywizard &

// Un commentaire privé sur une seule ligne

/*
 * Un commentaire privé sur plusieurs lignes
 */

#define NB 42 //!< Un nombre NB

/**
 * Une fonction foo
 */
void foo();

/**
 * @file        exemple.h
 * @brief       Contient la déclaration de la classe Exemple
 * @details     La classe \c Exemple permet de montrer l'utilisation des \em tags \b Doxygen
 * @author      Thierry vaira <thierr.vaira@gmail.com>
 * @version     0.1
 * @date        2020
 * @copyright   GNU Public License.
 */

$ cd ./doc/latex/
$ make

$ doxygen -w html header.html footer.html stylesheet.css

HTML_HEADER            =
HTML_FOOTER            = ./custom/customfooter.html
HTML_STYLESHEET        = ./custom/customdoxygen.css
HTML_EXTRA_FILES       = lasalle-logo.png

$ doxygen -w latex header.tex footer.tex doxygen.sty

LATEX_HEADER           = ./custom/customheader.tex
LATEX_FOOTER           =
LATEX_EXTRA_STYLESHEET =

EXTRA_PACKAGES         = custompackage
LATEX_EXTRA_FILES      = ./custom/custompackage.sty

\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{custompackage}

...

/**
 * @def NB
 * @brief Définit le nombre 42 !
*/
#define NB 42 //!< Un nombre NB

/**
 * @enum TEnum
 * @brief Description du type énuméré ...
 *
 * @var TEnum Val1
 * @brief Description de Val1 ...
 */
enum TEnum //! Un type énuméré ...
{
    Val1,
    Val2    //!< Description de Val2 ...
};

/**
 * @struct Etat
 * @brief Structure ...
 *
 */
struct Etat
{
    bool present; //!< Membre définissant ...
};

/**
 * @class       Exemple exemple.h "exemple.h"
 * @brief       La déclaration de la classe Exemple
 * @details     La classe \c Exemple permet de montrer l'utilisation des \em tags \b Doxygen
 * @author      Thierry vaira <tvaira@free.fr>
 * @version     0.1
 * @date        2020
 * @note        Une note à l'attention de ceux qui lisent les notes
 * @pre         Initialisez d'abord le système
 * @post        L'objet est initialisé ou pas
 * @bug         La copie est impossible ou illégale
 * @warning     Une mauvaise utilisation peut faire planter votre application (c'est votre faute)
 * @attention   Il faut toujours faire attention
 * @remark      Une remarque à faire ?
 * @copyright   GNU Public License.
 */
class Exemple
{
};

class Exemple
{
    private:
        int a; //!< a est ...
};

/**
 * @brief Constructeur par défaut de la classe Exemple.
 *
 * @see   Exemple::Exemple(int a)
 */
Exemple::Exemple() : a(0)
{
}

/**
 * @brief Constructeur de la classe Exemple.
 * @overload
 * @param a la valeur initiale de l'attribut a
 *
 * @see   Exemple::Exemple(int a)
 * @see   https://doc.qt.io/qt-5/qdatetime.html
 */
Exemple::Exemple(int a) : a(a)
{
    QDateTime maintenant = QDateTime::currentDateTime();
    qDebug() << Q_FUNC_INFO << maintenant.toString("dd/MM/yyyy") << maintenant.toString("hh:mm:ss") << "a" << a << this;
}

/**
 * @brief Accesseur de l'attribut a
 * @callergraph
 * @return a la valeur de l'attribut a
 * @retval int la valeur de l'attribut a
 */
int Exemple::getA() const
{
    return a;
}

/**
 * @brief Mutateur de l'attribut a
 * @callgraph
 * @param a ...
 * @exception range_error Si a est négatif
 */
void Exemple::setA(int a)
{
    if(a < 0 || a > NB)
        throw range_error("erreur plage");
    this->a = a;
    qDebug() << Q_FUNC_INFO << "a" << getA();
}

/**
 * @brief Montre le sens des paramètres
 * @param[in]       a1  ...
 * @param[out]      a2  ...
 * @param[in,out]   a3  ...
 */
void Exemple::copy(const int &a1, int &a2, int *a3)
{
    /**
     * @todo Implémenter la méthode
     */
}

/**
 * @file exemple.h
 * @brief La déclaration de la classe Exemple
 * si besoin auteur, version et date
 */

/**
 * @file exemple.cpp
 * @brief La définition de la classe Exemple
 * si besoin auteur, version et date
 */

/**
 * @file main.cpp
 *
 * @brief Programme principal ...
 * @details Crée et affiche la fenêtre principale de l'application ...
 * @author ...
 * @author ...
 * @version ...
 *
 * @param argc
 * @param argv[]
 * @return int
 *
 */

/*
 * ...
 * Instanciation :
 * \code{.cpp}
 * Exemple exemple1;
 * Exemple exemple2(5);
 * \endcode
 * \n

int main()
{
    //! [Test]
    Exemple exemple1;
    Exemple exemple2(5);
    //! [Test]

    return 0;
}

/**
 * @brief Constructeur par défaut de la classe Exemple.
 *
 * \b Tests :
 * @snippet ./test.cpp Test
 *
 */
Exemple::Exemple() : a(0)
{
}

 /**
  * ...
  * ...
  * @example test.cpp
  * @brief Test d'utilisation de la classe Exemple
  *
  */
class Exemple
{
};

/**
 *   \dot
 *  digraph example {
 *      node [shape=box, fontname=Helvetica, fontsize=12, color=black];
 *      a [ label="QObject" ];
 *      b [ label="Exemple" URL="\ref Exemple" fillcolor=lightblue,style=filled];
 *      a -> b [ arrowhead="normal", fillcolor=white,style=filled,dir=back ];
 *  }
 *  \enddot
 */

/**
  * ...
  * \image html screenshot.png
  */

/*! \mainpage Page principale du projet XXX
 *
 * \tableofcontents
 *
 * \section section_intro Introduction
 *
 *
 * Bla bla ....
 *
 * \section section_tdm Table des matières
 * - \ref page_README
 * - \ref page_changelog
 * - \ref page_install
 * - \ref page_about
 * - \ref page_licence
 *
 */

/*! \page page_install Installation
 *
 * \todo rédiger le manuel d'installation
 *
 */

...

\if todo
- \ref todo
\endif

\page page_README README

[TOC]

# Projet {#projet}

## Présentation {#presentation}


## Base de données {#bdd}

~~~ {.sql}

~~~

## Recette {#recette}


## Exemples {#exemples}

\snippet ./test.cpp Test

## Informations {#informations}

\author Thierry Vaira <<thierr.vaira@gmail.com>>
\date 2020
\version 0.1
\see https://svn.riouxsvn.com/projet