<?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="devhelp-hu">

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Úr Balázs</mal:name>
      <mal:email>ur dot balazs at fsf dot hu</mal:email>
      <mal:years>2018, 2021.</mal:years>
    </mal:credit>
  </info>

<title>Az API-dokumentáció telepítése</title>

<synopsis>
  <p>Hogyan találja meg a <app>Devhelp</app> az API-dokumentációt.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Könyvformátum</title>
  <p>A <app>Devhelp</app> által felismert API-dokumentáció formátumról szóló információkért nézze meg a <link xref="book-format"/> fejezetet.</p>
</section>

<section id="books-locations">
  <title>Könyvek helyei</title>
  <p>Miután a könyv a megfelelő formátumot követi, a könyvtárát olyan helyre kell telepíteni, ahol a <app>Devhelp</app> megtalálja.</p>
  <p>A <app>Devhelp</app> az <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG alapkönyvtár specifikációját</link> használja a könyvek kereséséhez. A keresett helyek listája:</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>Vegye észre, hogy a két utóbbi a keresendő könyvtárak listájából áll. A könyvtárak értékeit <code>:</code> karakterek választják el egymástól. Ezeket a környezeti változókat általában az asztali környezet vagy a disztribúció állítja be.</p>
  <p>Példák a <code>$XDG_DATA_HOME</code> útvonallal rendelkező indexfájlok helyeire egy tipikus rendszeren:</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>, ha a <app>Devhelp</app> alkalmazást <link href="https://flatpak.org/">Flatpak</link> használatával indították.</p></item>
  </list>
  <p>Példa egy <code>$XDG_DATA_DIRS</code> útvonallal rendelkező indexfájl helyére egy tipikus rendszeren:</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>A <link href="https://gitlab.gnome.org/GNOME/gtk-doc">GTK-Doc</link> egy olyan eszköz, amely API-dokumentációt állít elő a C kódhoz hozzáadott megjegyzésekből. A GLib, a GTK és a GNOME programkönyvtárak és alkalmazások használják.</p>
  <p>A GTK-Doc egy modul API-hivatkozását ide telepíti:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>A <app>Devhelp</app> által támogatott könyvformátumot követi. Így a GTK-Doc használatával az API-hivatkozás automatikusan böngészhető a <app>Devhelp</app> alkalmazásban (miután a megfelelő helyre lett telepítve).</p>
</section>
</page>
