Discussion :

[mister3957]

Bonjour � tous,


Tout d'abord, je voudrai savoir s'il existait un bon tutoriel sur l'utilisation de Doxygen (surtout l'aspet dot, il me semble qu'on peut changer l'aparence des graphiques, mais j'ai jamais s� le faire).

Ensuite j'aimerai savoir s'il y avait des "standarts" de documentation avec doxygen pour C++... certains documentent tout dans les ent�tes, d'autre ne d�crivent que les ent�tes brievements, le reste est dans les impl�mentations...
En terme de notation �galement, vous utilisez laquelle?

Et pourquoi pas, est-ce qu'il y a d'autres outils similaires?


A bient�t

[Alp]

FranckH a �crit un tuto sur le sujet : http://franckh.developpez.com/tutoriels/outils/doxygen/

Ca doit r�pondre � pas mal de tes questions

[mister3957]

Merci beaucoup, je vais lire �a

[Luc Hermitte]

Et si je puis me permettre, mes modestes commentaires.

Sinon, pour moi, c'est :
- toute la doc doxygen dans les .h (sauf pour les trucs locaux � une seule unit� de traduction qui se retrouvent document�s dans les .cpp) -- maintenir la doc dans les .h � jour est d�j� suffisament couteux en �nergie, inutile de se compliquer plus la vie en sortant la doc des .h ;
- des d�tails d'impl�mentations dans les .cpp (au format pas doxygen) ;
- un fichier .dox par composant pour d�finir les groupes associ�s au composant ;
- et le fichier doxyfile pour tout le projet.

Pour dot, il n'y a pas grand chose � faire.
- Le style UML n'apporte rien � part des boites � 3 tiroirs -- les h�ritages ne sont toujours pas repr�sent�s correctement selon le style UML
- Doxygen ne sait pas reconnaitre les relations impliqu�es par les divers conteneurs standard.

[mister3957]

J'ai pas mal s�ch� sur un truc:

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
8
9
10
11
12
13
 
CMaClasse.h:
 
#ifndef C_MA_CLASSE_H
#define C_MA_CLASSE_H
 
class CMaClasse
{
    void UneFonction();
    #include CMaClasse.inl
}
 
#endif

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
 
CMaClasse.inl:
inline void CMaClasse::UneFonction() {}

J'ai toujours eu l'habitude de coder comme �a mes classes lorsqu'il y avait des m�thodes inline, et j'ai remarqu� que Doxygen ne trouvait pas l'impl�mentation de "UneFonction" tant que l'on ne rajoutait pas le qualificateur "inline" �galement dans la d�finition de la fonction:

Warning: no matching class member found for void CMaClasse::UneFonction(). Possible candidates : void CMaClasse::UneFonction()

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
8
9
10
11
12
13
 
CMaClasse.h:
 
#ifndef C_MA_CLASSE_H
#define C_MA_CLASSE_H
 
class CMaClasse
{
    inline void UneFonction(); // là ça marche, plus de warning
    #include CMaClasse.inl
}
 
#endif

Du coup je me demande si ne pas mettre "inline" dans la d�claration et le mettre dans l'impl�mentation est correct ?

[M�dinoc]

Il y a un probl�me, l�.
Normalement, une fonction inline est suppos�e d�finie de l'une de ces deux fa�ons:

Code C++ :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
8
class CMaClasse
{
	void UneFonction();
};
 
inline void CMaClasse::UneFonction()
{
}

Ou:

Code C++ :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
class CMaClasse
{
	void UneFonction()
	{
	}
};

Mais PAS comme ceci:

Code C++ douteux :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
class CMaClasse
{
	void UneFonction();
	void CMaClasse::UneFonction()
	{
	}
};

[mister3957]

Ha oui mince, j'ai mal fait l'exemple

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
8
9
10
11
12
13
 
CMaClasse.h:
 
#ifndef C_MA_CLASSE_H
#define C_MA_CLASSE_H
 
class CMaClasse
{
    void UneFonction();
}
#include CMaClasse.inl
 
#endif

L� doxygen rale et ne me rajoute pas la fonction dans la documentation, il faut d'abord que je rajoute "inline" dans le prototype de la fonction dans la classe.