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

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

<title>Installera API-dokumentation</title>

<synopsis>
 Hur <app>Devhelp</app> hittar API-dokumentationen.
</synopsis>

<section id="book-format">
 <title>Bokformat</title>
 Se <link xref="book-format"/> för information om API-dokumentationsformatet som <app>Devhelp</app> känner igen.
</section>

<section id="books-locations">
 <title>Bokplatser</title>
 När en bok följer rätt format så behöver dess katalog installeras på en plats där <app>Devhelp</app> kommer att hitta den.
 <app>Devhelp</app> använder <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory-specifikationen</link> för att hitta böckerna. Listan över platser som söks igenom är:
 <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>
 Observera att de två senare består av :-separerade listor av kataloger att söka efter. Dessa miljövariabler ställs vanligen in av skrivbordsmiljön eller distributionen.
 Exempel på platser för indexfiler med <code>$XDG_DATA_HOME</code> på ett typiskt 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> om <app>Devhelp</app> startas med <link href="https://flatpak.org/">Flatpak</link>.</item>
 </list>
 Exempel på plats för en indexfil med <code>$XDG_DATA_DIRS</code> på ett typiskt 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> är ett verktyg för att skapa API-dokumentation som lagts till i C-kod. Det används av GLib, GTK samt GNOME-bibliotek och GNOME-program.
 GTK-Doc installerar API-referensen för en modul till:
 
 <code>$datadir/gtk-doc/html/$module_name/</code>
 
 Det följer bokformatet som stöds av <app>Devhelp</app>. Så genom att använda GTK-Doc kan API-referensen automatiskt visas i <app>Devhelp</app> (så snart den installerats på rätt plats).
</section>
</page>