Documenter les espaces de noms couvrant plusieurs fichiers doxygen

Question

Considérons que j'ai 2 fichiers d'en-tête.

// HEADER 1 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class This {...}; 
} 

& &

// HEADER 2 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class That {...}; 
} 

Comment dois-je gérer cela lors de la documentation avec Doxygen?

Answer 1

Peut-être ni l'un ni l'autre. Par exemple, imaginez que vous avez "<root>/utility/header1.hpp" qui a son contenu dans namespace utility et "<root>/utility/header2.hpp" qui fait également.

Vous pouvez ajouter un fichier: "<root>/utility.hpp" qui documente l'espace de noms de l'utilitaire. Vous pouvez mettre ceci au sommet #error Documentation only. pour vous assurer que ce n'est pas accidentellement inclus.

Mais je recommande au moins faire un peu hors sentiers battus fichier pour le garder dans un endroit sain d'esprit (et non mélangés au hasard avec une certaine classe.)

Answer 2

Trouver le meilleur endroit pour la documentation, que ce soit dans un de ces fichiers ou dans un autre entièrement. Utilisez un bloc de commentaire avec l'étiquette d'espace de noms de Doxygen:

/** 
* @namespace Foo 
* Documentation for Foo here. More docs for Foo here, 
* and down here. 
*/ 

Docs ici: http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace