<?xml version="1.0" encoding="utf-8"?>
<!--
SPDX-FileCopyrightText: 2019 Sébastien Wilmet <swilmet@gnome.org>
SPDX-License-Identifier: CC-BY-SA-4.0
-->
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" id="installing-api-documentation" xml:lang="pt-BR">

<info>
  <link type="guide" xref="index"/>

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Rafael Fontenelle</mal:name>
      <mal:email>rafaelff@gnome.org</mal:email>
      <mal:years>2018-2021</mal:years>
    </mal:credit>
  </info>

<title>Instalando a documentação de API</title>

<synopsis>
  <p>Como <app>Devhelp</app> encontra a documentação de API.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Formato de livro</title>
  <p>Veja <link xref="book-format"/> para informações sobre o formato da documentação de API que o <app>Devhelp</app> reconhece.</p>
</section>

<section id="books-locations">
  <title>Locais dos livros</title>
  <p>Quando um livro segue o formato correto, seu diretório precisa ser instalado em um local onde o <app>Devhelp</app> o encontre.</p>
  <p><app>Devhelp</app> usa a <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</link> para encontrar os livros. A lista de locais pesquisados é:</p>
  <list its:translate="no">
    <item><p><code>$XDG_DATA_HOME/devhelp/books/</code></p></item>
    <item><p><code>$XDG_DATA_HOME/gtk-doc/html/</code></p></item>
    <item><p><code>$XDG_DATA_DIRS/devhelp/books/</code></p></item>
    <item><p><code>$XDG_DATA_DIRS/gtk-doc/html/</code></p></item>
  </list>
  <p>Observe que os dois últimos consistem em listas de diretórios a serem procurados. Os valores de diretórios são separados por caracteres <code>:</code>. Estas variáveis de ambiente são normalmente configuradas pelo ambiente gráfico ou pela distribuição.</p>
  <p>Exemplos de locais para indexar arquivos com <code>$XDG_DATA_HOME</code> em um sistema típico:</p>
  <list>
    <item its:translate="no"><p>
      <file>~/.local/share/devhelp/books/glib/glib.devhelp2</file>
    </p></item>
    <item><p><file>~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2</file> se o <app>Devhelp</app> é iniciado com o <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Exemplo de um local para um arquivo de índice com <code>$XDG_DATA_DIRS</code> em um sistema típico:</p>
  <list>
    <item its:translate="no"><p>
      <file>/usr/share/gtk-doc/html/glib/glib.devhelp2</file>
    </p></item>
  </list>
</section>

<section id="gtk-doc">
  <title>GTK-Doc</title>
  <p><link href="https://gitlab.gnome.org/GNOME/gtk-doc">GTK-Doc</link> é 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.</p>
  <p>GTK-Doc instala a referência de API de um módulo para:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Ele segue o formato do livro suportado pelo <app>Devhelp</app>. Portanto, usando o GTK-Doc, a referência de API pode ser pesquisada no <app>Devhelp</app> automaticamente (uma vez instalada no local correto).</p>
</section>
</page>
