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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>scootergrisen</mal:name>
      <mal:email/>
      <mal:years>2020</mal:years>
    </mal:credit>
  </info>

<title>Installation af API-dokumentation</title>

<synopsis>
  <p>Sådan finder <app>Devhelp</app> API-dokumentationen.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Bogformat</title>
  <p>Se <link xref="book-format"/> for information om API-dokumentationsformatet som <app>Devhelp</app> genkender.</p>
</section>

<section id="books-locations">
  <title>Bøgernes placeringer</title>
  <p>Når en bog følger det rette format, så skal dens mappe være installeret på en placering hvor <app>Devhelp</app> kan finde den.</p>
  <p><app>Devhelp</app> bruger <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</link> til at finde bøgerne. Listen over placeringer som søges er:</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>Bemærk, at de to sidste består af lister med mapper, som der skal ledes efter. Miljøvariablerne adskilles af <code>:</code>-tegn. Miljøvariablerne er normalt sat op af skrivebordsmiljøet eller distributionen.</p>
  <p>Eksempler på placeringer til indeksfiler med <code>$XDG_DATA_HOME</code> på et typisk 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> hvis <app>Devhelp</app> startes med <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Eksempel på en placering til en indeksfil med <code>$XDG_DATA_DIRS</code> på et typisk 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> er et værktøj til at generere API-dokumentation fra kommentarer, som er tilføjet til C-kode. Det bruges af GLib-, GTK- og GNOME-biblioteker og -programmer.</p>
  <p>GTK-Doc installerer API-referencen for et modul i:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Den følger bogformatet som understøttes af <app>Devhelp</app>. Så ved at bruge GTK-Doc kan API-referencen automatisk gennemses i <app>Devhelp</app> (altså når den er installeret i den rette placering).</p>
</section>
</page>
