Namespaces dokumentieren, die mehrere Dateien umfassen doxygen

Question

Namespaces dokumentieren, die mehrere Dateien umfassen doxygen

8

Überlegen Sie, ich habe 2 Header-Dateien.

%Vor%

& amp; & amp;

%Vor%

Wie soll ich damit umgehen, wenn ich mit Doxygen dokumentiere?

c++ namespaces doxygen

rhubarb 19.08.2010, 19:47

quelle

2 Antworten

1

Finden Sie den besten Platz für die Dokumentation, egal ob in einer dieser Dateien oder in einer anderen. Verwenden Sie einen Kommentarblock mit Doxigens Namespace-Tag:

%Vor%

Docs hier: Ссылка

ssube 19.08.2010 19:58

quelle

Tags und Links c++ namespaces doxygen

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Erstellen eines generischen Parsers zum Konvertieren einer Textdatei in eine Datenstruktur in C #

score 4 · Accepted Answer

Vielleicht auch nicht.

Stellen Sie sich zum Beispiel vor, Sie hätten "<root>/utility/header1.hpp" , dessen Inhalt in namespace utility und "<root>/utility/header2.hpp" enthalten ist.

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

Aber ich würde zumindest empfehlen, einige Out-of-the-Way-Dateien zu erstellen, um sie an einem vernünftigen Ort zu halten (und nicht zufällig mit einer Klasse gemischt werden.)