Beyond Linux® From Scratch (Edição systemd ) - Versão 12.0

Capítulo 11. Utilitários Gerais

GTK-Doc-1.33.2

Introdução a GTK-Doc

O pacote GTK-Doc contém um documentador de código. Isso é útil para extrair comentários especialmente formatados a partir do código para criar a documentação da API. Esse pacote é opcional; se não estiver instalado, [então] os pacotes não construirão a documentação. Isso não significa que você não terá nenhuma documentação. Se GTK-Doc não estiver disponível, [então] o processo de instalação copiará qualquer documentação pré-construída para seu sistema.

Esse pacote é conhecido por construir e funcionar corretamente usando uma plataforma LFS 12.0.

Informação do Pacote

Dependências do GTK-Doc

Exigidas

docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7 e libxslt-1.1.38

Recomendada

Pygments-2.16.1 em tempo de execução

Opcionais

Para testes: dblatex ou fop-2.9 (suporte a "PDF" "XML"), GLib-2.76.4, Which-2.21 e módulos "Python" lxml-4.9.3, parameterized e yelp-tools

[Nota]

Nota

Os módulos opcionais "Python" acima podem ser facilmente instalados com o comando pip3.

Instalação do GTK-Doc

Instale GTK-Doc executando os seguintes comandos: 

autoreconf -fiv          &&
./configure --prefix=/usr &&
make

A suíte de teste travará se o pacote (ou uma versão anterior) ainda não estiver instalado.

Agora, como o(a) usuário(a) root: 

make install

Para testar os resultados, emita: make check. Alguns testes falharão dependendo dos pacotes instalados opcionalmente.

Conteúdo

Aplicativos Instalados: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan e gtkdoc-scangobj
Bibliotecas Instaladas: Nenhuma
Diretórios Instalados: /usr/share/gtk-doc e /usr/share/cmake/GtkDoc

Descrições Curtas

gtkdoc*

esses são todos shell, ou scripts Python usados pelos scripts do pacote Makefile para gerar documentação para o pacote sendo construído