kgenapidox - Online na nuvem

PROGRAMA:

NOME

kgenapidox - Gera documentação API no estilo KDE

VERSÃO

5.13.0

USO

uso: kgenapidox [-h] [--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR]
[--title TITLE] [--man-pages] [--qhp] [--searchengine]
[--api-searchbox] [-o SAÍDA] [--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]
[moduledir]

argumentos opcionais:
-h, --help mostra esta mensagem de ajuda e sai

fontes:
moduledir Localização do módulo para o qual construir a documentação da API;
deve conter um arquivo README.md e um src /
subdiretório. O padrão é a pasta atual.
--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR
Localização dos diretórios do diagrama do framework; a "Dependências"
a página será incluída na documentação do framework
se fornecido.

opções de saída:
--title TITLE String a ser usada para títulos de página.
--man-pages Gera a documentação da página do manual.
--qhp Gera documentação de ajuda compactada do Qt.
--searchengine Habilita o recurso de mecanismo de pesquisa do Doxygen.
--api-searchbox Habilita a caixa de pesquisa API (útil apenas para
api.kde.org).
-o SAÍDA, --saída SAÍDA
Local onde será gerada a documentação.
O padrão é apidocs.

Documentação Qt:
--qtdoc-dir QTDOC_DIR
Localização da documentação Qt (local); isto é pesquisado
para arquivos de tag para criar links para classes Qt.
--qtdoc-link QTDOC_LINK
Substituir a localização da documentação Qt para os links em
os arquivos html. Pode ser um caminho ou URL.
--qtdoc-flatten-links
Assumir que todos os arquivos html da documentação Qt são
imediatamente sob QTDOC_LINK (útil se você definir
QTDOC_LINK para a documentação online do Qt). Ignorado se
QTDOC_LINK não está definido.

Documentação do KDE:
--kdedoc-dir KDEDOC_DIR
Localização da documentação (local) do KDE; isto é
procurou por arquivos de tag para criar links para classes do KDE.
--kdedoc-link KDEDOC_LINK
Substituir a localização da documentação do KDE para os links em
os arquivos html. Pode ser um caminho ou URL.

caminhos:
--doxygen DOXYGEN (Caminho para) o executável doxygen.
--qhelpgenerator QHELPGENERATOR
(Caminho para) o executável qhelpgenerator.

diversos:
--doxdatadir DOXDATADIR
Localização dos arquivos de cabeçalho HTML e suporte
gráficos.
--keep-temp-dirs Não exclui diretórios temporários, úteis para depuração.

AUTORES

Esta versão do Kapidox foi escrito por Aurélien Gâteau [email protegido].

Esta página de manual foi criada por Scott Kitterman[email protegido]>.

2015-07-11 kgenapidox(1)

Use o kgenapidox online usando os serviços onworks.net