Default page

Your IP: 216.73.216.91
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

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

<mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
 <mal:name>Charles Monzat</mal:name>
 <mal:email>charles.monzat@numericable.fr</mal:email>
 <mal:years>2018.</mal:years>
 </mal:credit>
 </info>

<title>Installing API documentation</title>

<synopsis>
 How <app>Devhelp</app> finds the API documentation.
</synopsis>

<section id="book-format">
 <title>Book format</title>
 
 See <link xref="book-format"/> for information on the API documentation
 format that <app>Devhelp</app> recognizes.
 
</section>

<section id="books-locations">
 <title>Books locations</title>
 
 Once a book follows the right format, its directory needs to be installed
 at a location where <app>Devhelp</app> will find it.
 
 
 <app>Devhelp</app> uses the
 <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</link>
 to find the books. The list of locations searched is:
 
 <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>
 
 Note that the two latter consist of :-separated lists of directories to
 look for. Those environment variables are normally set up by the desktop
 environment or distribution.
 
 
 Examples of locations to index files with <code>$XDG_DATA_HOME</code> on a
 typical system:
 
 <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>
 if <app>Devhelp</app> is launched with
 <link href="https://flatpak.org/">Flatpak</link>.
 </item>
 </list>
 
 Example of a location to an index file with <code>$XDG_DATA_DIRS</code> on
 a typical system:
 
 <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> is a tool to
 generate API documentation from comments added to C code. It is used by
 GLib, GTK and GNOME libraries and applications.
 
 
 GTK-Doc installs the API reference of a module into:
 
 
 <code>$datadir/gtk-doc/html/$module_name/</code>
 
 
 It follows the book format supported by <app>Devhelp</app>. So by using
 GTK-Doc, the API reference can be browsed in <app>Devhelp</app>
 automatically (once installed in the right location, that is).
 
</section>
</page>