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.