Discussion :

[Bktero]

Salut !

J'ai trouvé d'endroit super adapté pour parler de Doxygen, si vous en connaissez un, dites-le moi et je déplacerai ce message.

J'ai un code comme ceci :

Code :

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

1
2
3
4
5
6
class A
{
public:
    void f();
    int a;
};

J'ai activé tout ce que j'ai trouvé dans Doxygen pour qu'il me mette des warnings sur ce qui n'est pas documenté. Et pourtant rien (ou presque)... Je suis en version 1.8.3.

Prenons cet autre code :

Code :

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/**
 * A
 */
class A
{
public:
    void f();
    int a;
 
    /**
     * Nawak
     */
    void g(int a);
};

Il me génère un warning : warning: parameters of member A::g are not (all) documented. Ce warning disparait si la classe n'est pas documentée...

Moi, j'aimerai déjà qu'il émette un warning quand une classe n'est pas documentée. Ensuite, qu'il mette des warnings pour les méthodes non documentées dans une classe non documentée. J'ai regardé cette discussion stackoverflow (https://stackoverflow.com/questions/...is-within-a-na) et je n'arrive pas à avoir les mêmes warnings. Je n'ai pas ceux sur les absences de documentation, seulement ceux pour les documentations présentes mais incomplètes...

Des gens qui ont déjà eu des problèmes comme ça ?

Merci !

[Bktero]

J'ai résolu le problème par hasard. Je vous passe le cheminement et je donne la solution directement :

Code :

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

1
2
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO

Si vous mettez 'YES', alors vous n'avez pas de warnings...

Voilà voilà

[koala01]

Salut,

Tout ce que je peux te dire, c'est que le message auquel tu fais référence date d'il y a 8 ans...

A l'époque, on devait en être à la version 1.3/1.4 maxi

Pour le reste, je vois trois solutions:
Soit, c'est voulu de la part du développeur, et tu devrais faire un "change request" pour demander qu'il réactive (sur option) les warning sur les manques de documentation au sein des classes.

Après tout, le but d'un développeur est de fournir quelque chose d'utile aux utilisateurs, et, si "assez de monde" marque un intérêt particulier pour une feature particulière, il va essayer de l'implémenter / la remettre en fonction.

Soit c'est un bug, et le mieux est encore d'en faire le rapport / de le réactiver parce que "toujours présent" sur ta version.

Soit, enfin, le bug a été corrigé (il me semble qu'il en est à la version de patch 13, soit dix corrections au delà de ta version à toi, ce qui tend à donner une bonne chance à cette possibilité). Et le mieux à faire est peut-être -- tout simplement -- de mettre ta version à jour

Quoi qu'il en soit, je dirais que "ca passe par le site du projet"

EDIT: d'ailleurs, la dernière solution semble confirmée par le changelog pour 1.8.13, car on peut y lire:

Check for undocumented params warnings if members detailed documentation is not written [view]