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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Piotr Drąg</mal:name>
      <mal:email>piotrdrag@gmail.com</mal:email>
      <mal:years>2018-2020</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Aviary.pl</mal:name>
      <mal:email>community-poland@mozilla.org</mal:email>
      <mal:years>2018-2020</mal:years>
    </mal:credit>
  </info>

<title>Instalowanie dokumentacji API</title>

<synopsis>
  <p>Jak <app>Devhelp</app> znajduje dokumentację API.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Format książki</title>
  <p><link xref="book-format"/> zawiera informacje o formacie dokumentacji API rozpoznawanym przez program <app>Devhelp</app>.</p>
</section>

<section id="books-locations">
  <title>Położenia książek</title>
  <p>Kiedy książka używa już właściwego formatu, jej katalog musi zostać zainstalowany w położeniu, w którym <app>Devhelp</app> ją znajdzie.</p>
  <p><app>Devhelp</app> używa <link href="https://specifications.freedesktop.org/basedir-spec/latest/">Specyfikacji podstawowych katalogów XDG</link> do wyszukiwania książek. Lista przeszukiwanych położeń:</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>Zauważ, że dwa ostatnie składają się z list katalogów do wyszukiwania. Katalogi są rozdzielone znakiem <code>:</code>. Te zmienne środowiskowe są zwykle konfigurowane przez środowisko pulpitu lub dystrybucję.</p>
  <p>Przykłady położeń plików indeksów ze zmienną <code>$XDG_DATA_HOME</code> w typowym systemie:</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>, jeśli <app>Devhelp</app> został uruchomiony za pomocą pakietu <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Przykład położenia pliku indeksu ze zmienną <code>$XDG_DATA_HOME</code> w typowym systemie:</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> to narzędzie do tworzenia dokumentacji API z komentarzy dodanych do kodu w języku C. Jest używane przez biblioteki GLib, GTK i programy GNOME.</p>
  <p>GTK-Doc instaluje referencje API modułu do:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Używa formatu książki obsługiwanego przez <app>Devhelp</app>. W ten sposób używając GTK-Doc można automatycznie przeglądać referencje API w programie <app>Devhelp</app> (po zainstalowaniu ich w odpowiednim położeniu).</p>
</section>
</page>
