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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Daniel Mustieles</mal:name>
      <mal:email>daniel.mustieles@gmail.com</mal:email>
      <mal:years>2018-2021</mal:years>
    </mal:credit>
  </info>

<title>Instalar documentación de la API</title>

<synopsis>
  <p>Cómo encuentra <app>Devhelp</app> la documentación de la API.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Formato de libro</title>
  <p>Consulte en <link xref="book-format"/> la información sobre qué formato de la documentación de la API reconoce <app>Devhelp</app>.</p>
</section>

<section id="books-locations">
  <title>Ubicaciones de los libros</title>
  <p>Una vez que el libro sigue el formato correcto se debe instalar su carpeta en una ubicación donde <app>Devhelp</app> pueda encontrarlo.</p>
  <p><app>Devhelp</app> usa la <link href="https://specifications.freedesktop.org/basedir-spec/latest/">especificación XDG de carpetas base</link> para buscar los libros. La lista de ubicaciones en las que busca es:</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>Tenga en cuenta que las dos últimas son listas de carpetas separadas por <code>:</code> en las que buscar. Normalmente estas variables de entorno las configura el entorno de escritorio o la distribución.</p>
  <p>Ejemplos de ubicaciones para archivos índice con <code>$XDG_DATA_HOME</code> en un sistema habitual:</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> si se ejecuta <app>Devhelp</app> con <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Ejemplo de ubicación de un archivo de índice con <code>$XDG_DATA_DIRS</code> en un sistema habitual:</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> es una herramienta para generar documentación de la API a partir de comentarios al código en C. Se usa en GLib, GTK y en bibliotecas y aplicaciones de GNOME.</p>
  <p>GTK-Doc instala la referencia de la API de un módulo en:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Sigue el formato soportado por <app>Devhelp</app>. Por lo tanto, usando GTK-Doc se puede examinar la referencia de la API en <app>Devhelp</app> automáticamente (una vez instalada en la ubicación correcta).</p>
</section>
</page>
