Doxygen des groupes et des modules de l'indice de
Je suis entrain de créer un Doxygen document pour mon projet. Récemment, j'ai regroupé les classes liées à l'aide \addtogroup
tag. Après cela, j'ai un onglet module dans ma documentation. Il montre tous les modules. Je veux ajouter une description à droite ci-dessous nom du module ci-dessous le nom du module sur la même page. Comment puis-je le faire à l'aide de Doxygen ?
Voici mon tag
/*! \addtogroup test test
* Test Testing a group in doxygen
* @{
*/
Vous devez vous connecter pour publier un commentaire.
Vous devez écrire un dédié .h fichier qui ne contient que des commentaires.
Pour chaque groupe, vous définissez un commentaire comme celui-ci:
Vous pouvez ensuite affecter la définition du groupe (même sur des fichiers différents) comme ceci:
MODIFIER:
Aussi cette est la façon dont il devient.
Voir la Description Détaillée"? Vous pouvez également ajouter un extrait de code et des exemples à l'intérieur de la
@verbatim
et@endverbatim
commandes.@defgroup
dans le même fichier que le@addtogroup
s, ou de ne pas avoir un@defgroup
à tous et juste mettre le texte dans l'une des@addtogroup
blocs (ils fonctionnent de la même que@defgroup
pour cela). Le truc, c'est que pour un texte à afficher en haut du module de la page (et dans le module de page d'index), il doit être brève description (c'est à dire@brief
), tandis que tout le reste sera sous "Description Détaillée" plus bas.