Discussion :

[master57]

Voila,
j aimerais utiliser Doxygen mais pas moyen de le faire marcher.
Quelqu un aurait il un tutorial ?(bien explique pas comme celui du site officiel)

@+

[karmaki]

j aimerais utiliser Doxygen mais pas moyen de le faire marcher.

C'est quoi le problème ? normalement, il n'y a pas grand chose à faire pour une première utilisation...

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

doxygen -g projet.dox

pour générer un fichier de configuration avec les valeurs par défaut, puis

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

doxygen projet.dox

pour générer la doc. Par défaut, il prend les fichiers source du répertoire courant je crois, mais on peut bien sur le changer.
Pour faire figurer dans la doc même ce qui n'est pas documenté :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

EXTRACT_ALL            = YES

dans projet.dox.
Pour documenter, il y a plein de manière (voir la doc). Les plus simples sont de mettre des commentaires avant l'élément :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
/** commentaire à la C : commence par 2 étoiles */
int ma_fct_a documenter (...) ...
/// commentaire à la C++ : commence par 3 slashs
int une_autre_fonction

Tous les éléments de configuration sont bien expliqué dans le fichier de configuration généré.

Bonne doc.
Anne.