Le générateur de documentation de code source doxygen est sorti en version 1.5.0 le 17 octobre dernier.
C'est une bonne occasion de présenter très brièvement ce qui devrait faire partie de toute boîte à outils d'un bon programmeur.
Doxygen est donc un logiciel permettant de documenter facilement son code par un système de commentaire-tags. Les utilisateurs de
javadoc, par exemple, se retrouveront facilement dans la manière de procéder, cependant on dénombre près de 170 tags par défaut pour doxygen auquel s'ajoute un système permettant d'ajouter ses propres tags afin de répondre aux besoins du projet.
En plus de la documentation des sources (prototype des fonctions, des classes), on peut obtenir les informations suivantes :
- Liste des fichiers inclus;
- Documentation des structures de données;
- Hiérarchie des classes;
- Différents types de graphiques : diagrammes de classe, de collaboration, d'appels, d'inclusion, etc;
- Un index de tous les identifiants;
- Des fichiers sources annotés.
La documentation produite est généralement au format HTML à cause de sa facilité d'emploi, cependant il est possible d'obtenir des fichiers LATEX, PostScript, PDF, XML, man et même Word et CHM.
Doxygen a été écrit en grande partie par Dimitri van Heesch qui trouvait, à l'époque, la documentation générée pour Qt très jolie et
doc++ trop limité pour réaliser un travail similaire.
Aujourd'hui doxygen supporte C/C++, Java, (Corba et Microsoft) Java, Python, IDL, C#, Objective-C et en partie D et PHP.
Doxygen est distribué sous
licence GPL, un binaire est disponible pour Windows 95 à XP et pour Mac OS X mais toute bonne distribution doit le mettre à disposition (nécessite la libqt).