Meine Frage bezieht sich darauf, wie typedef in der Vorlagenklasse mit Doxygen kommentiert werden kann. Ich werde ein Beispiel geben, um meine Frage zu veranschaulichen:
%Vor%Nach der Verwendung von Doxygen zur Verarbeitung der obigen Codes kann ich eine HTML-Seite erhalten, um die Definition der Klasse Base anzuzeigen. Für die Typedef-Klasse Coordinate wird sie jedoch nicht auf derselben Seite mit Base angezeigt. Tatsächlich sind alle typedef-Typen in der grundlegenden Namespace-Seite zusammen mit allen Klassen in diesem Namespace aufgelistet. Ich habe mich gefragt, ob es möglich ist, die Coordinate-Klasse auf der Basis-HTML-Seite anzuzeigen. Auf diese Weise wird die Verbindung zwischen Base und Coordinate sehr viel enger. Vielen Dank!
Der Typdef ist Teil eines Namespaces, daher müssen Sie den Namespace dokumentieren, damit er angezeigt wird, d. h.
%Vor% Alternativ könnten Sie @relates verwenden, aber dies wird das Mitglied unter Related Functions der Base-Klasse setzen:
Sie können diesen Titel beispielsweise in Ähnliche Mitglieder ändern, indem Sie eine Layoutdatei mit doxygen -l erstellen und dann die beiden Vorkommen des Elements related im generierten DoxygenLayout.xml wie folgt bearbeiten:
Im Handbuch habe ich Folgendes gelesen:
Wiederholen wir das, weil es oft übersehen wird: Um globale Objekte (Funktionen, typedefs, enum, macros usw.) zu dokumentieren, müssen Sie die Datei dokumentieren, in der sie definiert sind. Mit anderen Worten, es muss mindestens ein
geben /*! \file */ oder a
/** @file */ -Zeile in dieser Datei.
Es gibt den Befehl Siehe auch ( @sa ), der zum Generieren von Querverweisen nützlich ist zu anderen Entitäten.
Die anderen Antworten funktionieren, aber wenn Ihr typedef so eng mit der Base -Klasse verbunden ist, dass sie auf derselben Doxygen-Seite erscheinen sollen, sollten Sie vielleicht ein neues namespace (innerhalb von Fundamental ), die nur Base und Ihre typedef. enthalten. Dann erzeugt doxygen eine Seite für diese namespace , die Base und Ihre typedef.
Das Definieren einer file -Dokumentation wird dasselbe tun, aber dies könnte ein logischeres Layout für Ihren Code sein.