[C]Gestion de documentation : doxygen ? [Résolu]

[boboss123]

Bonjour,

J'ai un projet en langage C qui commence à être assez gros et je cherche donc un moyen pour que quelqu'un qui reprend le code après moi puisse s'y retrouver facilement.
=> j'ai donc penser à utiliser doxygen (y a t-il d'autres outils plus efficaces ?)

J'ai commencé à voir comment fonctionnait doxygen (sous windows xp) mais je ne sais pas pourquoi lorsque j'active la génération de diagramme via GraphViz, aucun diagramme apparait (alors que j'ai coché toutes les cases).
=> j'ai activer le mode d'extraction "all entites" car je n'ai pas encore documenté mes fonctions : ça vient de ça ? comment fait-il pour savoir qu'elle fonction a appel tel autre fonction ?

Connaissez vous un projet avec une bonne doc histoire de voir les toutes les possibilités que peut offrir doxygen ?


merci d'avance

[alexrtz]

Envoyé par boboss123

je ne sais pas pourquoi lorsque j'active la génération de diagramme via GraphViz, aucun diagramme apparait (alors que j'ai coché toutes les cases).

Je pense que ça vient plutôt d'un problème d'installation de Graphviz.
Le chemin des binaires Graphviz est-il dans ton PATH ?
Peux-tu mettre en pièce jointe le fichier généré par l'interface graphique de Doxygen ?

Envoyé par boboss123

=> j'ai activer le mode d'extraction "all entites" car je n'ai pas encore documenté mes fonctions : ça vient de ça ?

Nope, et tu pourras le laisser activé même quand tu auras documenté tes fonctions.

Envoyé par boboss123

comment fait-il pour savoir qu'elle fonction a appel tel autre fonction ?

Il parcourt le code

[mala92]

Envoyé par boboss123

Connaissez vous un projet avec une bonne doc histoire de voir les toutes les possibilités que peut offrir doxygen ?

Il y en a pas mal, donc certains d'Apache, comme L'API Reference de Xerces. Ca te montre ce qu'est une doc "classique". Par contre tu peux faire des choses encore plus poussées.

[boboss123]

Bonjour,

Merci pour vos réponses

Envoyé par mala92

Par contre tu peux faire des choses encore plus poussées.

=> tu as des exemples (ce que j'aimerais c'est d'avoir une vue d'ensemble de tout ce qui est possible de faire) ?

Envoyé par rurouni alex

Je pense que ça vient plutôt d'un problème d'installation de Graphviz.
Le chemin des binaires Graphviz est-il dans ton PATH ?

=> lorsqu'on installe doxygen pour windows xp, ça installe automatiquement Graphviz ? ... car dans "C:\Program Files", je ne vois pas de dossier Graphviz et je n'ai pas l'impression qu'il y ai Graphviz dans le PATH


Actuellement, les programmes qui nécessitent une bonne doc sont écrits en C mais il est possible que dans le futur que je doive aussi faire du java : est-ce que doxygen se rapproche de javadoc (car je n'ai pas envie de devoir apprendre l’utilisation de deux outils différents pour générer mes doc) ? doxygen mieux que javadoc ou ça fait à peu prêt la même chose ?
=> un outils javadoc pour langage C ça existe ?

[alexrtz]

Envoyé par boboss123

=> lorsqu'on installe doxygen pour windows xp, ça installe automatiquement Graphviz ?

Pas d'après mes souvenirs.

Envoyé par boboss123

est-ce que doxygen se rapproche de javadoc ?

Yaisse (je te conseille de lire çà)

Envoyé par boboss123

=> un outils javadoc pour langage C ça existe ?

Yaisse, ça s'appelle Doxygen

[boboss123]

oki, merci pour les infos

[boboss123]

rebonjour,

J'ai un problème pour générer ma doc : est-il possible d'afficher les fonctions locales (car actuellement, ça ne m'affiche que les fonctions externes) ?

Merci d'avance

[mala92]

Envoyé par boboss123

J'ai un problème pour générer ma doc : est-il possible d'afficher les fonctions locales (car actuellement, ça ne m'affiche que les fonctions externes) ?

Ca veut dire quoi ?

Toutes fonctions (interne externe, méthode de classe ...) documentées a sa documentation de générée.

[boboss123]

bonjour,

J'ai trouvé le problème (mais pas trouvé la solution) :
Mon projet contient des dossiers et sous-dossier. Dans mon IDE, je rentre les différents PATH pour que la compilation puisse se faire.
J'ai deux "include serach path" de défini :
- "."
et
- "../myLib/include"


=> Doxygen ne retrouve donc pas ces petits (il manque certains #define qui activent mes fonctions) : comment fait-on pour définir mes PATH dans Doxygen (je n'ai pas trouvé l'option) ?

[boboss123]

voici un petit projet d'exemple pour vous faire voir le problème : http://cjoint.com/?BDeoqdscY6C

[mala92]

je ne vois pas de problème.
Avec l'IHM sous Windows c'est plus facile.

Quand je regarde ta doc générée, il trouve tous les .h

Tu as ton fichier docygen à la racine, tu as mis :
RECURSIVE = YES

Donc, tous les *.h,*.h sont lus.

[boboss123]

Bonjour,

La doc est correcte pour les .h mais pas pour les .c (voir fichier module1.c)

J'ai enfin réussit à trouver la solution, il faut rajouter ceci pour définir les bon PATH pour les includes :

Code :

INCLUDE_PATH           = Application Lib/include