Il s'agit de la commande kgenapidox qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
kgenapidox - Générer la documentation de l'API dans le style KDE
VERSION
5.13.0
UTILISATION
utilisation : kgenapidox [-h] [--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR]
[--title TITRE] [--man-pages] [--qhp] [--searchengine]
[--api-searchbox] [-o SORTIE] [--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]
[moduleir]
arguments facultatifs :
-h, --help affiche ce message d'aide et quitte
sources:
moduledir Emplacement du module pour lequel créer la documentation de l'API ;
il doit contenir un fichier README.md et un src/
sous-répertoire.Par défaut dans le dossier actuel.
--dependency-diagram-dir DEPENDENCE_DIAGRAM_DIR
Emplacement des répertoires du diagramme-cadre ; une "Dépendances"
page sera incluse dans la documentation du framework
si fourni.
options de sortie :
--title TITLE Chaîne à utiliser pour les titres de page.
--man-pages Génère la documentation de la page de manuel.
--qhp Génère la documentation d'aide compressée de Qt.
--searchengine Active la fonction de moteur de recherche de Doxygen.
--api-searchbox Activer la boîte de recherche de l'API (utile uniquement pour
api.kde.org).
-o SORTIE, --sortie SORTIE
Emplacement où la documentation sera générée.
La valeur par défaut est apidocs.
Documentation QT :
--qtdoc-dir REP_QTDOC
Emplacement de la documentation Qt (locale) ; c'est recherché
pour les fichiers de balises pour créer des liens vers les classes Qt.
--qtdoc-link QTDOC_LINK
Remplacer l'emplacement de la documentation Qt pour les liens dans
les fichiers html. Peut être un chemin ou une URL.
--qtdoc-flatten-liens
S'il faut supposer que tous les fichiers html de la documentation Qt sont
immédiatement sous QTDOC_LINK (utile si vous définissez
QTDOC_LINK vers la documentation Qt en ligne). Ignoré si
QTDOC_LINK n'est pas défini.
Documentation KDE :
--kdedoc-dir KDEDOC_DIR
Emplacement de la documentation (locale) de KDE ; c'est
recherché des fichiers de balises pour créer des liens vers les classes KDE.
--kdedoc-link KDEDOC_LINK
Remplacer l'emplacement de la documentation de KDE pour les liens dans
les fichiers html. Peut être un chemin ou une URL.
chemins:
--doxygen DOXYGEN (Chemin vers) l'exécutable doxygen.
--qhelpgenerator QHELPGENERATEUR
(Chemin vers) l'exécutable qhelpgenerator.
divers:
--doxdatadir DOXDATADIR
Emplacement des fichiers d'en-tête HTML et prise en charge
graphique.
--keep-temp-dirs Ne supprime pas les répertoires temporaires, utile pour le débogage.
AUTEURS
Cette version de kapidox a été écrit par Aurélien Gâteau [email protected].
Cette page de manuel a été créée par Scott Kitterman[email protected]>.
2015-07-11 kgénapidox(1)
Utilisez kgenapidox en ligne en utilisant les services onworks.net
