Ich habe mit Doxygen eine Dokumentation für mein SDK erstellt. Es enthält die Liste der Dateien, Namespaces, Klassen, Typen usw. - alles, was ich als Doxygen-Kommentare in den Code eingefügt habe. Jetzt möchte ich einige allgemeine Informationen über SDK (Art der Einführung) schreiben, die sich nicht direkt auf ein Codeelement beziehen. Ich möchte diese Einführung auf der Startseite der Dokumentation platzieren. Wie kann ich das machen?
102
Antworten:
Schauen Sie sich den
mainpage
Befehl an.Schauen Sie sich auch diese Antwort auf einen anderen Thread an: So fügen Sie benutzerdefinierte Dateien in Doxygen ein . Darin heißt es , dass es drei Erweiterungen sind die Klassen als zusätzliche Dokumentationsdateien doxygen:
.dox
,.txt
und.doc
. Dateien mit diesen Erweiterungen werden nicht im Dateiindex angezeigt, können jedoch verwendet werden, um zusätzliche Informationen in Ihre endgültige Dokumentation aufzunehmen. Dies ist sehr nützlich für die Dokumentation, die erforderlich ist, aber nicht wirklich für die Aufnahme in Ihren Quellcode geeignet ist (z. B. eine FAQ).Daher würde ich empfehlen, eine
mainpage.dox
(oder ähnlich benannte) Datei in Ihrem Projektverzeichnis zu haben, um Ihnen das SDK vorzustellen. Beachten Sie, dass Sie in diese Datei einen oder mehrere Kommentarblöcke im C / C ++ - Stil einfügen müssen.quelle
.md
und.markdown
) werden ebenfalls als zusätzliche Dokumentationsdateien betrachtet. Ich bevorzuge sie,.dox
weil sie keine umgebenden Codekommentare benötigen und mit einem Markdown-Editor gut bearbeitet werden können - ohne Nachteile.Ab Version 1.8.8 gibt es auch die Option
USE_MDFILE_AS_MAINPAGE
. Stellen Sie also sicher, dass Sie Ihre Indexdatei, z. B. README.md , hinzufügenINPUT
und als Wert für diese Option festlegen:quelle
USE_MDFILE_AS_MAINPAGE
hat bei mir nicht funktioniert. Gemäß der Dokumentation müssen Sie{#mainpage}
nach dem Titel des Abschriften-Dokuments einfügen. Das hat funktioniert.INPUT = README.md
damals benutztINPUT += src
(um @ Lesters Vorschlag zu folgen) und dasUSE_MDFILE_AS_MAINPAGE = README.md
und es hat wie ein Zauber funktioniert. Version:$ doxygen --version
kehrt1.8.11
zu mir zurück.\mainpage
innen (kann dies in einem Kommentar tun (siehe diesen Link zu Kommentaren in MarkDown). Dies hat immer noch den Bereich "Verwandte Seiten" mit einem Platzhalter (leer) erstellt. Das ist ärgerlich, aber Zumindest habe ich die HauptseiteBeachten Sie, dass Sie mit Doxygen Release 1.8.0 auch Markdown-formatierte Seiten hinzufügen können. Damit dies funktioniert, müssen Sie Seiten mit einer
.md
oder einer.markdown
Erweiterung erstellen und der Konfigurationsdatei Folgendes hinzufügen:Weitere Informationen finden Sie unter http://www.doxygen.nl/manual/markdown.html#md_page_header .
quelle
dox=md
als hinzuzufügenEXTENSION_MAPPING
und in umzubenennen..dox
Die Konfiguration sieht also folgendermaßen aus:INPUT += your_page.dox EXTENSION_MAPPING += dox=md
Die folgende Syntax kann beim Hinzufügen einer Hauptseite und verwandter Unterseiten für Sauerstoff hilfreich sein:
Das Erstellen von Gruppen wie folgt hilft auch beim Entwerfen von Seiten:
Ein Beispiel finden Sie hier
quelle
Fügen Sie eine beliebige Datei in die Dokumentation ein, die Ihren Inhalt enthält, z. B. toc.h :
Und in deinem
Doxyfile
:Beispiel (auf Russisch):
scale-tech.ru/luckyBackupW/doc/html/index.html (über web.archive.org)
scale-tech.ru/luckyBackupW/doc/html/toc_8h_source.html (über web.archive.org)
quelle
Ich habe all das mit v 1.8.13 ohne Erfolg versucht. Was für mich (unter macOS) funktionierte, war die Verwendung des Tags doxywizard-> Expert, um die
USE_MD_FILE_AS_MAINPAGE
Einstellung zu füllen .Es wurden die folgenden Änderungen an meiner Doxy-Datei vorgenommen:
Beachten Sie den Zeilenabschluss für
INPUT
, ich habe gerade Leerzeichen als Trennzeichen verwendet, wie in der Dokumentation angegeben. AFAICT Dies ist die einzige Änderung zwischen der nicht funktionierenden und der funktionierenden Version der Doxy-Datei.quelle