Présentation simplifié de Doxygen

Installation

  • Ubuntu : lancer dans un terminal sudo apt-get install doxygen doxygen-gui doxygen-doc graphviz
  • Windob : télécharger
  • Utilisation

    lancer l'application : sous ubuntu dans un terminal "doxywizard", sous windob double clicker sur le lien.

    Alors à ce point là nous allons avoir un petit problème entre ceux qui sont sous linux et ceux qui sont sous windows, notamment pour l'encodage des caractères. Mais nous pouvons pour une plus grande cohérence de la doc enregistrer la configuration et la récupérer. Des tests sont donc à effectuer pour voir si avec une même configuration tout marche bien sur les différents systèmes.
    Pour commencer nous utiliserons l'option "Wizard..." avec comme options :

    onglet project
  • project name : "Editeurweb"
  • project version : 0.1
  • sélectionner le répertoir contenant vos sources
  • sélectionner le répertoir où la doc sera générée
  • onglet mode
  • Entities only
  • C++
  • onglet output
  • html : with frames and a navigation tree
  • onglet diagrams
  • No diagrams
  • Balises à utiliser dans nos sources

    Je vous rappel que nous commentons que les .h pour notre doc (donc bien documenté) et nous gardons les .cpp pour de petits commentaires internes. Donc les commentaires dans le .cpp doivent être de la forme // ou /*...*/ pour que doxygen ne les prennent pas en compte.

    Exemple
    #ifndef class_h
    #define class_h

    /*!
    * \file class.h
    * \brief courte description du fichier [optionnel]
    * \author nom des auteurs séparé par un espace
    * \date 00.00.0000
    *
    * longue description du fichier [optionnel]
    */

    #les includes

    /*!
    * \class nom de la classe
    * \brief courte description de la class
    *
    * longue description de la classe [optionnel]
    */
    class
    {
    private:
    attributs; /*!< courte description*/


    public:
    /*!
    * \brief Constructeur
    *
    * Constructeur de la classe class
    *
    * \param parametre : description paramètre
    */
    Class();

    /*!
    * \brief Destructeur
    *
    * Destructeur de la classe class
    */
    virtual ~class();

    /*!
    * \brief Description courte de la méthode
    *
    * Description longue de la méthode
    *
    * \param nomParam : description du paramètre
    * \return valeur de retour [optionnel]
    */
    void add(machin machin);
    }
    #endif

    Merci de me fair remonter les bugs éventuels ou l'ajout de nouvelles balises pour la cohérence des docs.

    EN SAVOIR PLUS