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

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

<title>Installera API-dokumentation</title>

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

<links type="section"/>

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

<section id="books-locations">
  <title>Bokplatser</title>
  <p>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.</p>
  <p><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:</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>Observera att de två senare består av listor av kataloger att söka efter. Katalogvärden separeras av tecknet <code>:</code>. Dessa miljövariabler ställs vanligen in av skrivbordsmiljön eller distributionen.</p>
  <p>Exempel på platser för indexfiler med <code>$XDG_DATA_HOME</code> på ett typiskt system:</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> om <app>Devhelp</app> startas med <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Exempel på plats för en indexfil med <code>$XDG_DATA_DIRS</code> på ett typiskt system:</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> är ett verktyg för att skapa API-dokumentation från kommentarer som lagts till i C-kod. Det används av GLib, GTK samt GNOME-bibliotek och GNOME-program.</p>
  <p>GTK-Doc installerar API-referensen för en modul till:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>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).</p>
</section>
</page>
