GTK-Doc é utilizado para documentar código C. É tipicamente utilizado para documentar a API pública de bibliotecas, tais como o GTK + e bibliotecas Gnome, mas também pode ser usada para documentar código de aplicação.
Note que GTK-Doc não estava originalmente destinado a ser um instrumento de documentação para uso geral, para que ele possa ser um pouco estranho para configurar e usar. Para um instrumento de documentação para uso geral mais polido você pode querer olhar para Doxygen (http://www.doxygen.org/). No entanto GTK-Doc tem algum código especial para documentar os sinais e propriedades de widgets GTK + e classes gobject que outras ferramentas não podem ter.
GTK-Doc permite que a documentação a ser escrito em duas maneiras:
a) incorporado dentro do código fonte em comentários especialmente formatados.
ou
b) Adicionado aos arquivos de 'modelo' que gera gtk-doc após a digitalização de todos os arquivos de cabeçalho e analisar as declarações.
A partir destes comentários de código fonte e arquivos de modelo GTK-Doc gera um documento XML Docbook (ou SGML), que é então transformada em HTML. A documentação HTML gerado pode ser navegado em um navegador web comum ou usando o navegador API Devhelp especial (ver http://developer.imendio.com/wiki/Devhelp).
What é novo nesta versão:
- gtk-doc suporta um subconjunto de remarcação (títulos e listas) - veja
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc não gera devhelp arquivos antigos mais. Isso reduz doc
- tempo de geração e trabalha para devhelp & gt;. = 0,11 (foi lançado em 2005)
- mudanças para fora da fonte de compilação dir causou quebra para projetos usando
- DOC_SOURCE_DIR com um caminho relativo (por builddir). Recomenda-se usar
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- Alterações
- 590.927: AM_SILENT_RULES de apoio para etapas doc-build
- 617.121: / * & lt; privado & gt; * / Declarações em enums ainda são exibidos
- 627.758: uma forma de ignorar um símbolo
- 639.145: sintaxe abreviada para posições
- 644.291: quebras de Enum analisador de colocação dos '')
- 646870: não mais em EXTRA_DIST HTML_IMAGES
- 648289:. Gtkdoc-mkdb não compila
- 648331:. Especificar opções compatíveis para 'destaque' consistentemente
- 649.269: gtkdoc-scanobj deve definir algumas de suas próprias CFLAGS / LDFLAGS
- 650.407: Prédios docs enquanto distchecking produz milhares de € oNo uma declaração founda € ?? avisos, em seguida, falhar.
- 652.746: Documentação de estruturas em caixa simples quebrado
- 652.764: autotools Atualizar config um pouco
- 655.711: resumir saída depscan por pacote
- 656.453: Melhorias de desempenho (PATCH)
- 656.658: gtk-doc.make: meta de instalação não instala docs quando a construção em um diretório separado
- 656.773: gtk-doc não consegue encontrar um símbolo declarado como 'char * const'
- 656.946: gtk-doc incapaz de lidar com 'short int externo'
- 657.377: srcdir = builddir constrói descartar conteúdo de tmpl
- Contribuintes
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David Nea ?? como
- Javier JardA³n
- Jorge González
- Mario BlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Will Thompson
- Yaakov Selkowitz
Requisitos :
- Perl v5
- & libxslt libxml2 2.3.6
- DocBook XSL Stylesheets
- DocBook XML DTD
- DocBook SGML DTD
- Jade v1.1 ou OpenJade 1.3.1
- DocBook DSSSL Stylesheets
Comentários não encontrado