+ Répondre à la discussion
Affichage des résultats 1 à 12 sur 12
  1. #1
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut [C]Gestion de documentation : doxygen ?

    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

  2. #2
    Membre Expert Avatar de alexrtz
    Inscrit en
    juin 2003
    Messages
    635
    Détails du profil
    Informations personnelles :
    Âge : 31

    Informations forums :
    Inscription : juin 2003
    Messages : 635
    Points : 1 170
    Points
    1 170

    Par défaut

    Citation Envoyé par boboss123 Voir le message
    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 ?

    Citation Envoyé par boboss123 Voir le message
    => 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.

    Citation Envoyé par boboss123 Voir le message
    comment fait-il pour savoir qu'elle fonction a appel tel autre fonction ?
    Il parcourt le code
    "Je suis incapable d'expliquer ce qui se passa ensuite : je lâchai quelque chose, quelque chose à quoi je m'agrippais depuis toujours sans m'en rendre compte. Je m'enfonçais dans une obscurité chaude, moelleuse et protectrice, tandis qu'un loup montait la garde par mes propres yeux."

  3. #3
    Expert Confirmé
    Homme Profil pro
    Développeur informatique
    Inscrit en
    décembre 2011
    Messages
    1 255
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : décembre 2011
    Messages : 1 255
    Points : 2 570
    Points
    2 570

    Par défaut

    Citation Envoyé par boboss123 Voir le message
    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.

  4. #4
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut

    Bonjour,

    Merci pour vos réponses

    Citation Envoyé par mala92 Voir le message
    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) ?



    Citation Envoyé par rurouni alex Voir le message
    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 ?

  5. #5
    Membre Expert Avatar de alexrtz
    Inscrit en
    juin 2003
    Messages
    635
    Détails du profil
    Informations personnelles :
    Âge : 31

    Informations forums :
    Inscription : juin 2003
    Messages : 635
    Points : 1 170
    Points
    1 170

    Par défaut

    Citation Envoyé par boboss123 Voir le message
    => lorsqu'on installe doxygen pour windows xp, ça installe automatiquement Graphviz ?
    Pas d'après mes souvenirs.


    Citation Envoyé par boboss123 Voir le message
    est-ce que doxygen se rapproche de javadoc ?
    Yaisse (je te conseille de lire çà)

    Citation Envoyé par boboss123 Voir le message
    => un outils javadoc pour langage C ça existe ?
    Yaisse, ça s'appelle Doxygen
    "Je suis incapable d'expliquer ce qui se passa ensuite : je lâchai quelque chose, quelque chose à quoi je m'agrippais depuis toujours sans m'en rendre compte. Je m'enfonçais dans une obscurité chaude, moelleuse et protectrice, tandis qu'un loup montait la garde par mes propres yeux."

  6. #6
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut

    oki, merci pour les infos

  7. #7
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut

    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

  8. #8
    Expert Confirmé
    Homme Profil pro
    Développeur informatique
    Inscrit en
    décembre 2011
    Messages
    1 255
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : décembre 2011
    Messages : 1 255
    Points : 2 570
    Points
    2 570

    Par défaut

    Citation Envoyé par boboss123 Voir le message
    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.

  9. #9
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut

    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) ?

  10. #10
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut

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

  11. #11
    Expert Confirmé
    Homme Profil pro
    Développeur informatique
    Inscrit en
    décembre 2011
    Messages
    1 255
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : décembre 2011
    Messages : 1 255
    Points : 2 570
    Points
    2 570

    Par défaut

    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.

  12. #12
    Membre éprouvé
    Inscrit en
    septembre 2009
    Messages
    1 169
    Détails du profil
    Informations forums :
    Inscription : septembre 2009
    Messages : 1 169
    Points : 468
    Points
    468

    Par défaut

    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

+ Répondre à la discussion
Cette discussion est résolue.

Liens sociaux

Règles de messages

  • Vous ne pouvez pas créer de nouvelles discussions
  • Vous ne pouvez pas envoyer des réponses
  • Vous ne pouvez pas envoyer des pièces jointes
  • Vous ne pouvez pas modifier vos messages
  •