<?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="gl">

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Fran Diéguez</mal:name>
      <mal:email>frandieguez@gnome.org</mal:email>
      <mal:years>2022</mal:years>
    </mal:credit>
  </info>

<title>Instalando documentación de API</title>

<synopsis>
  <p>Como atopa a documentación de APIs <app>Devhelp</app></p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Formato de libro</title>
  <p>Vexa <link xref="book-format"/> para obter máis información sobre o formato de documentación que recoñece <app>Devhelp</app>.</p>
</section>

<section id="books-locations">
  <title>Localizacións de libros</title>
  <p>Se un libro segue o formato correcto, o seu cartafol precisa instalarse nunha localización onde <app>Devhelp</app> o poida atopar.</p>
  <p><app>Devhelp</app> usa a  <link href="https://specifications.freedesktop.org/basedir-spec/latest/">Especificación de cartafol Base de XDG</link> para atopar os libros. A lista de localizacións é:</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>Teña en conta que os dous últimos consisten en listas de cartafoles onde buscar. Os valores de cartafoles están separados por caracteres. Esas variábeis de ambiente configúranse normalmente polo ambiente de escritorio ou distribución.</p>
  <p>Exemplos de localizacións de ficheiros de índices con <code>$XDG_DATA_HOME</code> nun 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 <app>Devhelp</app> se inicia con <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Exemplo dunha localización dun ficheiro de índice con <code>$XDG_DATA_DIRS</code> nun 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> é unha ferramenta para xerar documentación de APIs desde os comentarios engadidos ao código C. Úsano as aplicacións e bibliotecas de GNOME Glib, GTK.</p>
  <p>GTK-Doc instala a referencia de API dun módulo en:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Segue o formato de libro admitido por <app>Devhelp</app>. Polo que usando GTK-Doc, a referencia de API pode explorarse con <app>Devhelp</app> automaticamente (en canto se instale no lugar correcto).</p>
</section>
</page>
