Default page

Your IP: 216.73.216.10
Server IP: 157.245.101.34
Server: Linux skvinfotech-website 5.4.0-131-generic #147-Ubuntu SMP Fri Oct 14 17:07:22 UTC 2022 x86_64
Server Software: Apache/2.4.41 (Ubuntu)
PHP Version: 7.4.33
Buat File | Buat Folder

Dir : ~/proc/self/root/usr/share/help/es/devhelp/

Edit File: installing-api-documentation.page

<?xml version="1.0" encoding="utf-8"?>

<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">

<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</mal:years>
 </mal:credit>
 </info>

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

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

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

<section id="books-locations">
 <title>Ubicaciones de los libros</title>
 Una vez que el libro sigue el formato correcto se debe instalar su carpeta en una ubicación donde <app>Devhelp</app> pueda encontrarlo.
 <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:
 <list its:translate="no">
 <item><code>$XDG_DATA_HOME/devhelp/books/</code></item>
 <item><code>$XDG_DATA_HOME/gtk-doc/html/</code></item>
 <item><code>$XDG_DATA_DIRS/devhelp/books/</code></item>
 <item><code>$XDG_DATA_DIRS/gtk-doc/html/</code></item>
 </list>
 Tenga en cuenta que las dos últimas son listas de carpetas separadas por :- en las que buscar. Normalmente estas variables de entorno las configura el entorno de escritorio o la distribución.
 Ejemplos de ubicaciones para archivos índice con <code>$XDG_DATA_HOME</code> en un sistema habitual:
 <list>
 <item its:translate="no">
 <file>~/.local/share/devhelp/books/glib/glib.devhelp2</file>
 </item>
 <item><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>.</item>
 </list>
 Ejemplo de ubicación de un archivo de índice con <code>$XDG_DATA_DIRS</code> en un sistema habitual:
 <list>
 <item its:translate="no">
 <file>/usr/share/gtk-doc/html/glib/glib.devhelp2</file>
 </item>
 </list>
</section>

<section id="gtk-doc">
 <title>GTK-Doc</title>
 <link href="https://www.gtk.org/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 y en bibliotecas y aplicaciones de GNOME.
 GTK-Doc instala la referencia de la API de un módulo en:
 
 <code>$datadir/gtk-doc/html/$module_name/</code>
 
 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).
</section>
</page>