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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Mario Blättermann</mal:name>
      <mal:email>mario.blaettermann@gmail.com</mal:email>
      <mal:years>2018</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Stephan Woidowski</mal:name>
      <mal:email>swoidowski@t-online.de</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Christian Kirbach</mal:name>
      <mal:email>christian.kirbach@gmail.com</mal:email>
      <mal:years>2020.</mal:years>
    </mal:credit>
  </info>

<title>Installieren der API-Dokumentation</title>

<synopsis>
  <p>So findet <app>Devhelp</app> die API-Dokumentation.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Buchformat</title>
  <p>Lesen Sie <link xref="book-format"/> für Informationen zum API-Dokumentationsformat, das <app>Devhelp</app> erkennt.</p>
</section>

<section id="books-locations">
  <title>Buchorte</title>
  <p>Sobald ein Buch dem richtigen Format folgt, muss sein Ordner an einem Ort installiert werden, an dem <app>Devhelp</app> es finden wird.</p>
  <p><app>Devhelp</app> verwendet die <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG-Basisverzeichnisspezifikation</link>, um die Bücher zu finden. Die Liste der durchsuchten Standorte lautet:</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>Beachten Sie, dass die beiden letztgenannten Ordner aus einer Liste von Ordnern bestehen, nach denen gesucht werden soll. Ordnerwerte werden durch <code>:</code>-Zeichen getrennt. Diese Umgebungsvariablen werden normalerweise von der Arbeitsumgebung oder der Distribution eingerichtet.</p>
  <p>Beispiele für Speicherorte zum Indexieren von Dateien mir <code>$XDG_DATA_HOME</code> auf einem typischen System sind:</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>, wenn <app>Devhelp</app> mit <link href="https://flatpak.org/">Flatpak</link> gestartetwird.</p></item>
  </list>
  <p>Beispiel für einen Speicherort zu einer Indexdatei mit <code>$XDG_DATA_DIRS</code> auf einem typischen 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> ist ein Werkzeug zum Erstellen von API-Dokumentation aus Kommentaren, die C-Code hinzugefügt wurden. Es wird von GLib-, GTK- und GNOME-Bibliotheken und -Anwendungen verwendet.</p>
  <p>GTK-Doc installiert die API-Referenz eines Moduls nach:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Es folgt dem Buchformat, das von <app>Devhelp</app> unterstützt wird. Mit GTK-Doc kann die API-Referenz in <app>Devhelp</app> also automatisch durchsucht werden (sobald sie einmal am richtigen Ort installiert ist).</p>
</section>
</page>
