Bonjour,
j'essaie de me mettre a Doxygen pour documenter mon code. Le resultat est nickel, mais il y a un truc qui m'echappe, c'est qu'apparemment il ne permet pas de documenter des variables qui ne sont pas membres d'une classe. Si on prend l'exemple de mon fichier main.cpp :
j'ai des variables globales declarées en debut de fichier, avec une description derriere (en anglais s'il vous plait :-) )
et idem a l'interieur de ma fonction main.
Code : Sélectionner tout - Visualiser dans une fenêtre à part
1
2
3
4 float precision; /**<precision of the resultat*/ float incertitude; /**<accuracy of the data, in %. if it's <0, the accuracy is read in the data file*/ int nbData; /**<number of data in the data file*/
Or, les variables globales sont listées dans la doc, mais la description saute
les variables interieure a la fonction main disparaisse. pourtant, doxygen reconnait bien ces descriptions, puisque dans la page qu'il genere qui contient le code coloré, ces descriptions n'apparaissent pas (au meme tire que tout ce qui concerne Doxygen).
toutes les docs que je trouve ne parle que des classes, des fonctions et de leur parametres, pas des autres variables.. pourtant, il me semble tout aussi important d'expliquer ce qu'elles sont !!
si quelqu'un a une idée, il aura tout ma gratitude.
Partager