Dies ist der Befehl kgenapidox, der beim kostenlosen Hosting-Anbieter OnWorks mit einer unserer zahlreichen kostenlosen Online-Workstations wie Ubuntu Online, Fedora Online, dem Windows-Online-Emulator oder dem MAC OS-Online-Emulator ausgeführt werden kann
PROGRAMM:
NAME/FUNKTION
kgenapidox – API-Dokumentation im KDE-Stil generieren
VERSION
5.13.0
ANWENDUNG
Verwendung: kgenapidox [-h] [--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR]
[--title TITEL] [--man-pages] [--qhp] [--searchengine]
[--api-searchbox] [-o OUTPUT] [--qtdoc-dir QTDOC_DIR]
[--qtdoc-link QTDOC_LINK] [--qtdoc-flatten-links]
[--kdedoc-dir KDEDOC_DIR] [--kdedoc-link KDEDOC_LINK]
[--doxygen DOXYGEN] [--qhelpgenerator QHELPGENERATOR]
[--doxdatadir DOXDATADIR] [--keep-temp-dirs]
[Modulverzeichnis]
optionale Argumente:
-h, --help Diese Hilfemeldung anzeigen und beenden
Quellen:
moduledir Speicherort des Moduls, für das die API-Dokumentation erstellt werden soll;
es sollte eine README.md-Datei und eine src/ enthalten
Unterverzeichnis. Standardmäßig wird der aktuelle Ordner verwendet.
--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR
Speicherort der Framework-Diagrammverzeichnisse; a „Abhängigkeiten“
Seite wird in die Framework-Dokumentation aufgenommen
falls vorhanden.
Ausgabeoptionen:
--title TITLE String, der für Seitentitel verwendet werden soll.
--man-pages Erzeugt eine Manpage-Dokumentation.
--qhp Generiert eine komprimierte Qt-Hilfedokumentation.
--searchengine Aktiviert die Suchmaschinenfunktion von Doxygen.
--api-searchbox Aktiviert die API-Suchbox (nur nützlich für
api.kde.org).
-o AUSGABE, --output AUSGABE
Ort, an dem die Dokumentation erstellt wird.
Der Standardwert ist apidocs.
Qt-Dokumentation:
--qtdoc-dir QTDOC_DIR
Ort der (lokalen) Qt-Dokumentation; das wird gesucht
für Tag-Dateien, um Links zu Qt-Klassen zu erstellen.
--qtdoc-link QTDOC_LINK
Überschreiben Sie den Speicherort der Qt-Dokumentation für die Links in
die html-Dateien. Kann ein Pfad oder eine URL sein.
--qtdoc-flatten-links
Ob alle Qt-Dokumentations-HTML-Dateien angenommen werden sollen
sofort unter QTDOC_LINK (nützlich, wenn Sie einstellen
QTDOC_LINK zur Online-Qt-Dokumentation). Ignoriert, wenn
QTDOC_LINK ist nicht festgelegt.
KDE-Dokumentation:
--kdedoc-dir KDEDOC_DIR
Speicherort der (lokalen) KDE-Dokumentation; das ist
nach Tag-Dateien gesucht, um Links zu KDE-Klassen zu erstellen.
--kdedoc-link KDEDOC_LINK
Überschreiben Sie den Speicherort der KDE-Dokumentation für die Links in
die html-Dateien. Kann ein Pfad oder eine URL sein.
Wege:
--doxygen DOXYGEN (Pfad zur) ausführbaren Datei von doxygen.
--qhelpgenerator QHELPGENERATOR
(Pfad zu) der ausführbaren Datei qhelpgenerator.
Sonstiges:
--doxdatadir DOXDATADIR
Speicherort der HTML-Header-Dateien und Unterstützung
Grafik.
--keep-temp-dirs Löscht keine temporären Verzeichnisse, was zum Debuggen nützlich ist.
AUTOREN
Diese Version von Kapidox wurde geschrieben von Aurélien Gâteau [E-Mail geschützt] .
Diese Manpage wurde von Scott Kitterman erstellt[E-Mail geschützt] >.
2015-07-11 Kgenapidox(1)
Nutzen Sie kgenapidox online über die Dienste von onworks.net
