Mercredi, décembre 03rd, 2008 | Auteur: M@lgon

Bonjour,

dans cet article, je vais vous présenter Doxygen, un utilitaire permettant de générer une documentation à partir du code source d’un programme :D

Doxygen supporte plusieurs languages : C, C++, Java, Objective C, Python, IDL, VHDL


Mais comment ça marche ?

Ce programme se sert des commentaires suivant une règle précise que vous devrez insérer dans votre code. Voilà un petit exemple :

/*! \class fullDialog
* \brief classe representant la fenêtre plein ecran
*
* Cette classe gère l’affichage du QPixmap, et la gestion des evenements souris et de dessin.
*/
class fullDialog : public QLabel
{
Q_OBJECT

public:
/*!
* \brief Constructeur
*
* Constructeur de la classe fullDialog
*
* \param parent : widget parent
* \param flags : flag de ce widget
*/

fullDialog(QWidget *parent=0, Qt::WFlags flags=0);
}

Un peu long, mais regardez ce que ça donne pour mon logiciel lScreen : http://coindugraphisme3d.free-h.net/doc/html/ Pas mal hein :P

Un petit peu d’effort, mais un excellent résultat. Par exemple des projets tels que KDE ou metacity l’utilise pour réaliser leur documentation ;) (un grand nombre des projets : http://www.stack.nl/~dimitri/doxygen/projects.html )

Comment l’installer ?

sous linux un petit

sudo apt-get install doxygen

sudo apt-get install doxygen-gui

et le voilà en place avec une interface graphique.

Sous windows, téléchargez l’executable ici : http://logiciel.codes-sources.com/logiciels/doxygen-91.aspx (je n’ai pas pu tester ^^ )

Bonne création de documentation ;)

Malgon

Liens externes

Catégorie: Presentation
Vous pouvez suivre les réponses de cette entrée en suivant RSS 2.0 feed. Vous pouvez laisser une réponse, ou trackback depuis votre propre site.

4 Responses

  1. c’est vrai que cette outil est extremement puissant,longue vie à doxygene

  2. Tiens j’ai déjà vu ca quelque part y a pas longtemps :D

  3. Sur logram :p

    Faudra que je fasse une news dessus dès que j’aurais le temps ^^ (qui me manque :( )

  4. Bravo :)

    http://www.elmazzika.com/musique/

Laisser un commentaire


Derniers blogs mis à jour

Concours chez Free-Tools : 1 licence Kentico CMS ASP.Net en jeu ! - Posted to Matt

Depuis le 1er février dernier, nos partenaires & amis de Free Tools ont lancé un petit concours en association avec Kentico..

1er au 30 Sept : Annoncez à -50% sur mx-dev.net ! - Posted to Matt

L'été s'achève en douceur et la rentrée arrive progressivement avec ses projets, ses nouveautés & ses découvertes. Pour cette rentrée 2009, mx-dev.net vous offre 50%..

Music Pro est finit - Posted to MusicPro

Cela faisait pas mal de temps que je n'avais pas blogué un peu. Je n'avais malheureusement pas trop le temps malgré les vacances. Aujourd'hui je ..

Sortie de LinuFx 0.3 - Posted to Malgon Project

Bonjour, LinuFx 0.3 est sorti :D Vraiment trop de nouveauté pour les lister ^^ (plus de 40 commits SVN) Mais on peut noter l'icone du programme et le..

LinuFx : effets spéciaux open-source - Posted to Malgon Project

Bonjour, tout d'abord désolé de ne pas avoir posté de billets depuis un moment (mais en même temps tout le monde s'en fiche :p ) Dans ce..