Dokumentieren von Namespaces, die mehrere Dateien umfassen doxygen

Question

Betrachten Sie, ich habe 2 Header-Dateien.

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

& &

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

Wie soll ich damit umgehen, wenn sie mit Doxygen zu dokumentieren?

Answer 1

Vielleicht auch nicht.

Zum Beispiel, stellen Sie sich vor, Sie haben "<root>/utility/header1.hpp", die ihren Inhalt in namespace utility und "<root>/utility/header2.hpp" hat, die auch tut.

Sie könnten eine Datei hinzufügen: "<root>/utility.hpp", die den Namespace des Dienstprogramms dokumentiert. Sie können dies an die Spitze setzen #error Documentation only. um sicherzustellen, dass es nicht versehentlich enthalten ist.

Aber ich würde zumindest mache einig out-of-the-Art-Datei zu halten es in einer gesunden Stelle (und nicht gemischt in zufällig mit einiger Klasse.) Empfehle

Answer 2

Finden Sie den besten Ort für die Dokumentation, ob es in einer dieser Dateien oder in einer anderen liegt. Verwenden Sie einen Kommentarblock mit Doxygen Namespace tag:

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

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