Aperçu

La première partie constitue un manuel d'utilisation :

La section Installation explique comment télécharger, compiler et installer Doxygen pour votre plateforme.
La section Mise en route vous indique comment générer rapidement votre première documentation.
La section Documentation du code montre les différentes manières de documenter le code.
La section Prise en charge de Markdown montre le formatage Markdown pris en charge par Doxygen.
La section Listes montre comment créer des listes.
La section Regroupement montre comment regrouper des éléments.
La section Inclure des tableaux montre comment insérer des tableaux dans la documentation.
La section Inclure des formules montre comment insérer des formules dans la documentation.
La section Graphiques et diagrammes décrit les diagrammes et graphiques que Doxygen peut générer.
La section Préprocesseur explique comment Doxygen gère les définitions de macro.
La section Génération automatique de liens montre comment placer des liens vers des fichiers, des classes et des membres dans la documentation.
La section Formats de sortie montre comment générer les différents formats de sortie pris en charge par Doxygen.
La section Recherche montre différentes manières de rechercher dans la documentation HTML.
La section Indexation et recherche externes montre comment utiliser les outils de recherche et d'indexation externes.
La section Documentation supplémentaire explique comment créer des pages de documentation non liées à l'API.
La section Personnalisation de la sortie explique comment personnaliser la sortie générée par Doxygen.
La section Commandes personnalisées montre comment définir et utiliser des commandes personnalisées dans vos commentaires.
La section Liens vers la documentation externe explique comment laisser Doxygen créer des liens vers la documentation générée en externe.
La section Questions fréquemment posées donne des réponses aux questions fréquemment posées.
La section Dépannage vous indique ce qu'il faut faire lorsque vous rencontrez des problèmes.

La deuxième partie constitue un manuel de référence :

La section Fonctionnalités présente un aperçu de ce que Doxygen peut faire.
La section Utilisation de Doxygen montre comment utiliser le programme Doxygen.
La section Utilisation de Doxywizard montre comment utiliser le programme Doxywizard.
La section Configuration montre comment affiner Doxygen, afin qu'il génère la documentation souhaitée.
La section Commandes spéciales montre un aperçu des commandes spéciales qui peuvent être utilisées dans la documentation.
La section Commandes HTML présente un aperçu des commandes HTML qui peuvent être utilisées dans la documentation.
La section Commandes XML présente un aperçu des commandes XML de style C# qui peuvent être utilisées dans la documentation.
La section en charge des emojis présente une introduction sur la manière dont les emojis peuvent être utilisés dans la documentation.

La troisième partie fournit des informations aux développeurs :

La section Internes de Doxygen donne un aperçu global de la structure interne de Doxygen.
La section Sortie du module Perl montre comment utiliser la sortie PerlMod.
La section Internationalisation explique comment ajouter la prise en charge de nouveaux langages de sortie.

Licence Doxygen

La permission d'utiliser, de copier, de modifier et de distribuer ce logiciel et sa documentation est accordée par la présente sous les termes de la licence publique générale GNU. Aucune déclaration n'est faite quant à l'adéquation de ce logiciel à quelque fin que ce soit. Il est fourni « tel quel » sans garantie expresse ou implicite. Voir la licence publique générale GNU pour plus de détails.

Les documents produits par Doxygen sont des œuvres dérivées des données utilisées dans leur production ; ils ne sont pas concernés par cette licence.

Exemples d'utilisateurs

Doxygen prend en charge un certain nombre de formats de sortie, le HTML étant le plus populaire. J'ai rassemblé quelques bons exemples de projets réels utilisant Doxygen.

Ces exemples font partie d'une liste plus large de projets qui utilisent Doxygen. Si vous connaissez d'autres projets, faites-le moi savoir et je les ajouterai.

Travaux futurs

Bien que Doxygen soit déjà utilisé avec succès par un grand nombre d'entreprises et de projets open source, il y a toujours place à l'amélioration.

Vous pouvez également soumettre des demandes d'amélioration dans le bug tracker.

Remerciements

Merci à :

Malte Zöckler et Roland Wunderling, auteurs de DOC++. La première version de Doxygen empruntait du code à une ancienne version de DOC++. Bien que j'ai réécrit pratiquement tout le code depuis, DOC++ m'a quand même donné un bon départ dans l'écriture de Doxygen.
Toutes les personnes de Qt Software, pour avoir créé une magnifique boîte à outils d'interface graphique.
Steffen Schümann pour avoir créé ghc::filesystem qui est utilisé par Doxygen.
Michael McTernan pour avoir créé mscgen qui est maintenant intégré dans Doxygen.
Mon frère Frank pour avoir dessiné les logos.
Harm van der Heijden pour avoir ajouté la prise en charge de l'aide HTML.
Wouter Slegers pour avoir enregistré le domaine www.doxygen.org.
Martin Kreis pour avoir ajouté la prise en charge VHDL.
Parker Waechter pour avoir ajouté le générateur de sortie RTF.
Joerg Baumann, pour avoir ajouté des blocs de documentation conditionnels, des liens PDF et le générateur de configuration.
Tim Mensch pour avoir ajouté la commande todo.
Christian Hammond pour avoir repensé le site Web.
Ken Wong pour avoir fourni le code de l'arborescence HTML.
Talin pour avoir ajouté la prise en charge des commentaires de style C# avec le balisage XML.
Petr Prikryl pour avoir coordonné le support d'internationalisation. Tous les responsables de la maintenance des langues pour avoir fourni des traductions dans de nombreuses langues.
beaucoup, beaucoup d'autres pour leurs suggestions, correctifs et rapports de bogues.

Liens sponsorisés

(sans rapport avec doxygen)

Heers