PsyKroPack
Messages postés3Date d'inscriptionjeudi 6 février 2003StatutMembreDernière intervention17 janvier 2007 17 janv. 2007 à 20:49
Mon avis :
Ca reste très haut niveau, je pensais voir les différentes fonctionnalités de doxygen au final c'est juste une courte présentation de ce dernier. Mais en relisant la description c'est vrai qu'il est indiqué que c'est une courte présentation de doxygen.
Donc en conclusion c tutorial est intéressant pour les personnes ne connaissant pas du tout Doxygen. Pour les autres et ben vous n'y trouverez que peu d'informations.
Je relève toutefois le @code/@endcode que je ne connaissais pas.
Sinon il serait bon de signaler qu'il existe plusieurs manière de commenter son code comme :
"///" pour les commentaires courts : typiquement pour une donnée membre
Enfin voila :)
Bon tutoriel pour débuter avec Doxygen je lui met donc 7
PsyKroPack
Messages postés3Date d'inscriptionjeudi 6 février 2003StatutMembreDernière intervention17 janvier 2007 17 janv. 2007 à 20:36
Je vais jeter un oeil :)
Merci d'avoir corrigé ce petit probleme
Sinon Doxygen est multiplateforme et donc indépendant du soft utilisé. Je l'utilise déja sous Linux, tout ce qui m'interesse c'est d'avoir un aperçu global des fonctionnalités offertes par Doxygen.
Merci pour la réponse rapide !
(P.S : On peut etre sous windows et utiliser des logiciels comme Open Office qui n'est pas compatible avec les "standards" MS)
BunoCS
Messages postés15472Date d'inscriptionlundi 11 juillet 2005StatutModérateurDernière intervention25 mars 2024103 17 janv. 2007 à 20:02
Salut PsyKroPack,
Effectivement, je ne proposais qu'une version PowerPoint, désolé. C'est maintenant corrigé.
Ceci dit, ce tutoriel se base sur les utilitaires version Windows pour la génération de documentation...
PsyKroPack
Messages postés3Date d'inscriptionjeudi 6 février 2003StatutMembreDernière intervention17 janvier 2007 17 janv. 2007 à 16:41
Bonjour,
Cela semble intéressant mais malheureusement, le tutorial est en .ppt ?! Je travaille sous Linux et trouve ca un peu dommage de fournir un tutorial sous un format propriétaire Microsoft. Résultat je ne peux le consulter et donner mon avis sur son contenu :)
Il aurait été judicieux je pense de le mettre en pdf.
PsyKroPack
BunoCS
Messages postés15472Date d'inscriptionlundi 11 juillet 2005StatutModérateurDernière intervention25 mars 2024103 8 janv. 2007 à 08:57
Salut Adn.
Bien sûr que tu peux générer la doc d'une telle fonction, je ne vois pas le soucis. Voici un exemple:
/**
@brief Fonction Test
Cette fonction sert de test pour la génération de doc
*/
void MaClasse::maMethode()
Par contre, attention au doxyfile: si tu le configures pour que Doxygen n'analyse que les headers, il ne traitera pas les fichiers sources...
N'hésites pas à me contacter si tu as d'autres soucis
@+
Buno
adn_
Messages postés17Date d'inscriptionjeudi 18 mars 2004StatutMembreDernière intervention 7 janvier 2007 7 janv. 2007 à 22:55
Salut,
Tout d'abord merci pour le tuto il est bien sympa.
Je voudrais savoir s'il est possible de générer de la doc pour une méthode déclarée ainsi:
(dans un fichier MaClasse.cpp)
void MaClasse::maMethode(){
...
}
par ce qu'avec un paramétrage comme décrit dans le tutorial, ça ne génère rien pour cette méthode.
Merci de me dire si vous avez des info.
++
Adn
BunoCS
Messages postés15472Date d'inscriptionlundi 11 juillet 2005StatutModérateurDernière intervention25 mars 2024103 17 nov. 2006 à 16:32
Salut Didi.
Effectivement, il y a beaucoup de possibilités pour créer une documentation plus ou moins fournie. Ce document se veut être une base pour tous les développeurs voulant utiliser Doxygen et non pas une traduction des nombreux tuto que tu peux trouver. Si tu as des questions précises, je suis à ta disposition.
didi_twist
Messages postés2Date d'inscriptionmardi 10 janvier 2006StatutMembreDernière intervention17 avril 2008 17 nov. 2006 à 11:48
Merci pour le tuto, si jamais tu a le temps de le completter ca m'interresserais, car j'ai vu sur une doc en anglais qu'il y a encore de nombreuses autre possibilitée, sauf que contrairement a ton tuto on comprend pas grand chose a leur doc...
>>ça doit etre ça l'art de faire une doc... Une commande = une explication d'une disaine de ligne avec des termes techniques (tjrs en anglais) c'est assez désespérant!
Alors que ton tuto est simple et claire :
Une commande, le résultat, l'explication et les préscisions en cas de besoin.
Voila en tout cas merci et Bravo !
nightlord666
Messages postés746Date d'inscriptionvendredi 17 juin 2005StatutMembreDernière intervention23 mai 200710 19 avril 2006 à 16:46
Merci pour le tutorial (9/10) !
nightlord666
Messages postés746Date d'inscriptionvendredi 17 juin 2005StatutMembreDernière intervention23 mai 200710 19 avril 2006 à 16:43
Merci pour le tutorial (9/10) !
neodelphi
Messages postés442Date d'inscriptionjeudi 4 avril 2002StatutMembreDernière intervention11 août 2008 26 déc. 2005 à 16:46
Pas mal, assez utile...
C'est tout de même domage de na pas avoirs mis plus d'exemples sur le formatage des sources. La partie installation est peut être trop importante, sous linux une seule ligne de commande suffit à installer doxygen. Je met quand meme 8/10
A+
zeratul67
Messages postés97Date d'inscriptionmardi 9 avril 2002StatutMembreDernière intervention11 mai 2008 26 nov. 2005 à 20:36
Très sympa et instructif :)
Merci pour ce cours
BunoCS
Messages postés15472Date d'inscriptionlundi 11 juillet 2005StatutModérateurDernière intervention25 mars 2024103 25 nov. 2005 à 09:41
Oups...pardon! Copier-Coller malencontreux :(
Effectivement, tu as raison, le compilo C++ perd les pédales. Voici ce qu'il faut faire:
Dans le bloc de commentaires:
@code
// voici un commentaire
void fonction(...)
@endcode
Ensuite, Doxygen l'interprête comme suit:
/* voici un commentaire */
void fonction(...)
D'où mon erreur... j'ai copié ce qu'il ne fallait pas.
Merci de ta remarque fort judicieuse
cs_Kirua
Messages postés3006Date d'inscriptiondimanche 14 avril 2002StatutMembreDernière intervention31 décembre 2008 24 nov. 2005 à 23:24
Ok pour doxygen, mais le compilateur C++ il ne va pas comprendre qu'il ne doit pas interprêter le */, enfin, ça me paraît impossible à vrai dire.
BunoCS
Messages postés15472Date d'inscriptionlundi 11 juillet 2005StatutModérateurDernière intervention25 mars 2024103 24 nov. 2005 à 11:43
Merci de ta réactivité Kirua (et surtout de la détection de la faute d'ortho :°)
En réponse à ta question, Doxygen n'interprête pas le texte qui est inclus entre les balises @code/@endcode. Tu peux donc y placer des commentaires classiques.
Concernant la liste des balises, j'ai voulu citer les plus utiles dans un premier temps. Ensuite, effectivement, je rajouterais les balises permettant d'influencer la présentation finale
cs_Kirua
Messages postés3006Date d'inscriptiondimanche 14 avril 2002StatutMembreDernière intervention31 décembre 2008 24 nov. 2005 à 10:39
j'ai bien aimé ce document. j'avais déjà utilisé doxyen mais jamais les commentaires du style javadoc. juste deux remarques:
- faute d'ortho sur le transparent "balises 2":
"On peut également précisé si le paramètre est entrant et/ou sortant : [in], [out] ou [in,out]"
c'est "préciser". si tu cherches à le présenter en public, faut faire gaffe ;)
- sur le même transparent, tu as un exemple de code, avec un commentaire /* */ dedans, et je comprends pas pq le */ n'est pas interprêté comme la fin du bloc de "doxy doc". Tu sais expliquer ça?
Sinon, c'est chouette. Je pense que même si personne ne le lire, ce serait bien d'introduire, au moins en annexe, une liste exhaustive des balises, même sans explication, car ça se comprend aisément et pr les gens qui téléchargeront ton cours, ce sera bien agréable.
voilà ;)
mindslight
Messages postés87Date d'inscriptionmercredi 1 juin 2005StatutMembreDernière intervention29 octobre 2009 24 nov. 2005 à 08:32
c'est sympa doxygen.
la doc est riche et en plus c'est multiplateforme.
si tu a le temps faire un tour vers ma source que,
j'ai déposée hier "body of the knowledge".
c'est un logiciel de documentation dont le but est de,
partager les library avec d'autre devellopeur.
17 janv. 2007 à 20:49
Ca reste très haut niveau, je pensais voir les différentes fonctionnalités de doxygen au final c'est juste une courte présentation de ce dernier. Mais en relisant la description c'est vrai qu'il est indiqué que c'est une courte présentation de doxygen.
Donc en conclusion c tutorial est intéressant pour les personnes ne connaissant pas du tout Doxygen. Pour les autres et ben vous n'y trouverez que peu d'informations.
Je relève toutefois le @code/@endcode que je ne connaissais pas.
Sinon il serait bon de signaler qu'il existe plusieurs manière de commenter son code comme :
"///" pour les commentaires courts : typiquement pour une donnée membre
Enfin voila :)
Bon tutoriel pour débuter avec Doxygen je lui met donc 7
17 janv. 2007 à 20:36
Merci d'avoir corrigé ce petit probleme
Sinon Doxygen est multiplateforme et donc indépendant du soft utilisé. Je l'utilise déja sous Linux, tout ce qui m'interesse c'est d'avoir un aperçu global des fonctionnalités offertes par Doxygen.
Merci pour la réponse rapide !
(P.S : On peut etre sous windows et utiliser des logiciels comme Open Office qui n'est pas compatible avec les "standards" MS)
17 janv. 2007 à 20:02
Effectivement, je ne proposais qu'une version PowerPoint, désolé. C'est maintenant corrigé.
Ceci dit, ce tutoriel se base sur les utilitaires version Windows pour la génération de documentation...
17 janv. 2007 à 16:41
Cela semble intéressant mais malheureusement, le tutorial est en .ppt ?! Je travaille sous Linux et trouve ca un peu dommage de fournir un tutorial sous un format propriétaire Microsoft. Résultat je ne peux le consulter et donner mon avis sur son contenu :)
Il aurait été judicieux je pense de le mettre en pdf.
PsyKroPack
8 janv. 2007 à 08:57
Bien sûr que tu peux générer la doc d'une telle fonction, je ne vois pas le soucis. Voici un exemple:
/**
@brief Fonction Test
Cette fonction sert de test pour la génération de doc
*/
void MaClasse::maMethode()
Par contre, attention au doxyfile: si tu le configures pour que Doxygen n'analyse que les headers, il ne traitera pas les fichiers sources...
N'hésites pas à me contacter si tu as d'autres soucis
@+
Buno
7 janv. 2007 à 22:55
Tout d'abord merci pour le tuto il est bien sympa.
Je voudrais savoir s'il est possible de générer de la doc pour une méthode déclarée ainsi:
(dans un fichier MaClasse.cpp)
void MaClasse::maMethode(){
...
}
par ce qu'avec un paramétrage comme décrit dans le tutorial, ça ne génère rien pour cette méthode.
Merci de me dire si vous avez des info.
++
Adn
17 nov. 2006 à 16:32
Effectivement, il y a beaucoup de possibilités pour créer une documentation plus ou moins fournie. Ce document se veut être une base pour tous les développeurs voulant utiliser Doxygen et non pas une traduction des nombreux tuto que tu peux trouver. Si tu as des questions précises, je suis à ta disposition.
17 nov. 2006 à 11:48
>>ça doit etre ça l'art de faire une doc... Une commande = une explication d'une disaine de ligne avec des termes techniques (tjrs en anglais) c'est assez désespérant!
Alors que ton tuto est simple et claire :
Une commande, le résultat, l'explication et les préscisions en cas de besoin.
Voila en tout cas merci et Bravo !
19 avril 2006 à 16:46
19 avril 2006 à 16:43
26 déc. 2005 à 16:46
C'est tout de même domage de na pas avoirs mis plus d'exemples sur le formatage des sources. La partie installation est peut être trop importante, sous linux une seule ligne de commande suffit à installer doxygen. Je met quand meme 8/10
A+
26 nov. 2005 à 20:36
Merci pour ce cours
25 nov. 2005 à 09:41
Effectivement, tu as raison, le compilo C++ perd les pédales. Voici ce qu'il faut faire:
Dans le bloc de commentaires:
@code
// voici un commentaire
void fonction(...)
@endcode
Ensuite, Doxygen l'interprête comme suit:
/* voici un commentaire */
void fonction(...)
D'où mon erreur... j'ai copié ce qu'il ne fallait pas.
Merci de ta remarque fort judicieuse
24 nov. 2005 à 23:24
24 nov. 2005 à 11:43
En réponse à ta question, Doxygen n'interprête pas le texte qui est inclus entre les balises @code/@endcode. Tu peux donc y placer des commentaires classiques.
Concernant la liste des balises, j'ai voulu citer les plus utiles dans un premier temps. Ensuite, effectivement, je rajouterais les balises permettant d'influencer la présentation finale
24 nov. 2005 à 10:39
- faute d'ortho sur le transparent "balises 2":
"On peut également précisé si le paramètre est entrant et/ou sortant : [in], [out] ou [in,out]"
c'est "préciser". si tu cherches à le présenter en public, faut faire gaffe ;)
- sur le même transparent, tu as un exemple de code, avec un commentaire /* */ dedans, et je comprends pas pq le */ n'est pas interprêté comme la fin du bloc de "doxy doc". Tu sais expliquer ça?
Sinon, c'est chouette. Je pense que même si personne ne le lire, ce serait bien d'introduire, au moins en annexe, une liste exhaustive des balises, même sans explication, car ça se comprend aisément et pr les gens qui téléchargeront ton cours, ce sera bien agréable.
voilà ;)
24 nov. 2005 à 08:32
la doc est riche et en plus c'est multiplateforme.
si tu a le temps faire un tour vers ma source que,
j'ai déposée hier "body of the knowledge".
c'est un logiciel de documentation dont le but est de,
partager les library avec d'autre devellopeur.
a+