Aller au contenu principal

Doxygen

Générateur de documentation supportant plusieurs langages de programmation.

Format​

Le format « Doxygen » permet de générer automatiquement de la documentation à partir de commentaires dans le code source de plusieurs langages de programmation.

Ce format comportant plusieurs syntaxes, c'est celle des triples barres obliques « /// » qui doit être utilisée.

Fichiers​

Tous les fichiers doivent avoir un en-tête :

/// @file Fichier.ext
/// @brief Description du fichier.
/// @authors Prénom Nom, Prénom Nom, ...

Structures et Classes​

Toutes les déclarations de structure et de classe doivent avoir un en-tête :

/// @brief Description de la classe.
/// @tparam Modele Description du paramètre modèle.
template <typename Modele>
class Classe {
  // ...
};

Données membres​

Toutes les données membres doivent être suivies d'une description :

char donneeMembre; ///< Description de la donnée membre.

Méthodes et Fonctions​

Toutes les méthodes et fonctions doivent avoir un en-tête :

/// @brief Description de la méthode.
/// @param parametreA Description du paramètre A.
/// @param parametreB Description du paramètre B.
/// @return Description du retour.
int methode(bool parametreA, float parametreB) {
  // ...
  return 42;
}