15 votes

Doxygen : Regrouper les modules et les pages ?

J'ai une question sur les pages et les groupes dans doxygen. J'ai un projet dans lequel j'ai regroupé des classes, etc. avec la fonction @defgroup y @ingroup cmds. Jusqu'à présent, cela fonctionne bien.

Maintenant, je voudrais ajouter une documentation spéciale au projet avec des pages markdown. Ces pages doivent apparaître dans le module (groupe) dédié. J'ai essayé de créer des pages avec l'option @page y @subpage cmds. Cela fonctionne bien, mais les pages apparaissent en clair dans le menu.

J'ai donc essayé de les ajouter aux groupes avec @ingroup . Mais cela ne fonctionne pas comme je l'avais prévu. Est-il possible d'ajouter des pages aux modules (groupes) ?

Le résultat devrait ressembler à ceci :

Projet
|-- Modules
|-- "Module1"
| | | |-- documentation page1 (du fichier *.md)
| | | |-- documentation de la classe
|-- "Module2"
| | | |-- documentation page2
| | | |-- documentation de la classe

J'espère que vous pourrez m'aider !

0voto

Denise Skidmore Points 1014

Pour regrouper des pages, vous devez utiliser la fonctionnalité de sous-page, pas le groupe.

Créez donc une page pour chaque groupe qui fait référence aux deux sous-pages et au groupe de modules.

/*! \page group1page A documentation page for my group
This page contains the info about group 1 \ref group1_label
\subpage group1page2
\subpage group1page3
*/

http://www.doxygen.nl/manual/grouping.html#subpaging

http://www.doxygen.nl/manual/commands.html#cmdsubpage

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X