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]