Rafael Fontenelle
rafaelff@gnome.org
2018-2020
Instalando a documentação de API
Como Devhelp encontra a documentação de API.
Locais dos livros
Quando um livro segue o formato correto, seu diretório precisa ser instalado em um local onde o Devhelp o encontre.
Devhelp usa a XDG Base Directory Specification para encontrar os livros. A lista de locais pesquisados é:
$XDG_DATA_HOME/devhelp/books/
$XDG_DATA_HOME/gtk-doc/html/
$XDG_DATA_DIRS/devhelp/books/
$XDG_DATA_DIRS/gtk-doc/html/
Observe que os dois últimos consistem em listas de diretórios separados por “:” a serem procurados. Essas variáveis de ambiente são normalmente configuradas pelo ambiente ou distribuição da área de trabalho.
Exemplos de locais para indexar arquivos com $XDG_DATA_HOME em um sistema típico:
~/.local/share/devhelp/books/glib/glib.devhelp2
~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2 se o Devhelp é iniciado com o Flatpak.
Exemplo de um local para um arquivo de índice com $XDG_DATA_DIRS em um sistema típico:
/usr/share/gtk-doc/html/glib/glib.devhelp2
GTK-Doc
GTK-Doc é uma ferramenta para gerar documentação de API a partir de comentários adicionados ao código C. É usado pelas bibliotecas e aplicativos GLib, GTK e GNOME.
GTK-Doc instala a referência de API de um módulo para:
$datadir/gtk-doc/html/$module_name/
Ele segue o formato do livro suportado pelo Devhelp. Portanto, usando o GTK-Doc, a referência de API pode ser pesquisada no Devhelp automaticamente (uma vez instalada no local correto).