Este es el comando kgenapidox que se puede ejecutar en el proveedor de alojamiento gratuito de OnWorks utilizando una de nuestras múltiples estaciones de trabajo en línea gratuitas, como Ubuntu Online, Fedora Online, emulador en línea de Windows o emulador en línea de MAC OS.
PROGRAMA:
NOMBRE
kgenapidox - Genera documentación de API en el estilo KDE
VERSIÓN
5.13.0
USO
uso: kgenapidox [-h] [--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR]
[--title TÍTULO] [--man-pages] [--qhp] [--searchengine]
[--api-searchbox] [-o SALIDA] [--qtdoc-dir QTDOC_DIR]
[--qtdoc-link QTDOC_LINK] [--qtdoc-flatten-links]
[--kdedoc-dir KDEDOC_DIR] [--kdedoc-enlace KDEDOC_LINK]
[--doxygen DOXYGEN] [--qhelpgenerator QHELPGENERATOR]
[--doxdatadir DOXDATADIR] [--keep-temp-dirs]
[moduleir]
argumentos opcionales:
-h, --help mostrar este mensaje de ayuda y salir
fuentes:
Moduleledir Ubicación del módulo para el que se creará la documentación de la API;
debe contener un archivo README.md y un src /
subdirectorio predeterminado a la carpeta actual.
--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR
Ubicación de los directorios del diagrama de marco; a "Dependencias"
La página se incluirá en la documentación del marco.
si se proporciona.
opciones de salida:
--title TITLE Cadena que se utilizará para los títulos de las páginas.
--man-pages Genera documentación de página de manual.
--qhp Genera documentación de ayuda comprimida de Qt.
--searchengine Habilita la función del motor de búsqueda de Doxygen.
--api-searchbox Habilita el cuadro de búsqueda de API (solo es útil para
api.kde.org).
-o SALIDA, --salida SALIDA
Lugar donde se generará la documentación.
El valor predeterminado es apidocs.
Documentación de Qt:
--qtdoc-dir QTDOC_DIR
Ubicación de la documentación Qt (local); esto se busca
para archivos de etiquetas para crear enlaces a clases Qt.
--qtdoc-enlace QTDOC_LINK
Anule la ubicación de la documentación de Qt para los enlaces en
los archivos html. Puede ser una ruta o una URL.
--qtdoc-aplanar-enlaces
Ya sea para asumir que todos los archivos html de documentación de Qt son
inmediatamente debajo de QTDOC_LINK (útil si configura
QTDOC_LINK a la documentación en línea de Qt). Ignorado si
QTDOC_LINK no está configurado.
Documentación de KDE:
--kdedoc-dir KDEDOC_DIR
Ubicación de la documentación de KDE (local); este es
buscó archivos de etiquetas para crear enlaces a clases de KDE.
--kdedoc-enlace KDEDOC_LINK
Anule la ubicación de la documentación de KDE para los enlaces en
los archivos html. Puede ser una ruta o una URL.
caminos:
--doxygen DOXYGEN (Ruta a) el ejecutable de doxygen.
--qhelpgenerator QHELPGENERADOR
(Ruta a) el ejecutable qhelpgenerator.
misceláneo:
--doxdatadir DOXDATADIR
Ubicación de los archivos de encabezado HTML y soporte
gráficos.
--keep-temp-dirs No borra directorios temporales, útiles para depurar.
AUTORES
Esta versión de kapidox fue escrito por Aurélien Gâteau [email protected].
Esta página de manual fue creada por Scott Kitterman[email protected]>.
2015-07-11 kgenapidox(1)
Utilice kgenapidox en línea utilizando los servicios de onworks.net
