# GTK-Doc-Handbuch

1.24.1

Benutzerhandbuch für Entwickler mit Anweisungen für die Benutzung von GTK-Doc.

Chris Lyttle

     chris@wilddev.net

Dan Mueth

     d-mueth@uchicago.edu

Stefan Sauer (Kost)

     ensonic@users.sf.net

GTK-Doc-Projekt

    gtk-doc-list@gnome.org

2000, 2005 Dan Mueth und Chris Lyttle
2007-2019 Stefan Sauer (Kost)

Das vorliegende Dokument kann gemäß den Bedingungen der GNU Free Documentation License (GFDL), Version 1.1 oder jeder späteren, von der Free Software Foundation veröffentlichten Version ohne unveränderbare Abschnitte sowie ohne Texte auf dem vorderen und hinteren Buchdeckel kopiert, verteilt und/oder modifiziert werden. Eine Kopie der GFDL finden Sie unter diesem Link oder in der mit diesem Handbuch gelieferten Datei COPYING-DOCS.

Bei vielen der von Firmen zur Unterscheidung ihrer Produkte und Dienstleistungen verwendeten Namen handelt es sich um Marken. An den Stellen, an denen derartige Namen in einer GNOME-Dokumentation vorkommen und wenn die Mitglieder des GNOME-Dokumentationsprojekts über diese Marken informiert wurden, sind die Namen in Großbuchstaben oder mit großen Anfangsbuchstaben geschrieben.

1.33.0
1. Oktober 2020
mc Gtk4-Version
1.32.1
15. August 2019
ss Entwicklerversion
1.32
15. August 2019
ss Korrekturveröffentlichung
1.31
05. August 2019
ss Größere Umbauten und weitere Tests
1.30
08. Mai 2019
ss Weitere Tests
1.29
28. August 2018
ss Fehlerbehebungen
1.28
24. März 2018
ss Fehlerbehebungen
1.27
07. Dezember 2017
> ss Detailanpassungen der Python-Portierung
1.26.1
11. August 2017
ss Alle Werkzeuge von Perl/Bash nach Python portiert
1.25
21. März 2015
ss Fehlerbehebungen, Test-Cleanups
1.24
29. Mai 2015
ss Fehlerbehebungen
1.23
17. Mai 2015
ss Fehlerbehebungen
1.22
7. Mai 2015
ss Fehlerbehebungen, veraltete Funktionen verworfen
1.21
17. Juli 2014
ss Fehlerbehebungen, veraltete Funktionen verworfen
1.20
16. Februar 2014
ss Fehlerberhebungen, Unterstützung für Markdown, Layoutverbesserungen
1.19
05. Juni 2013
ss Fehlerbehebungen
1.18
14. September 2011
ss Fehlerbehebungen, Verbesserte Geschwindigkeit, Unterstützung für markdown
1.17
26. Februar 2011
sk Dringende Bugfix-Aktualisierung
1.16
14. Januar 2011
sk Bugfixes, Layoutverbesserungen
1.15
21. Mai 2010
sk Bug- und Regressionsfixes
1.14
28. März 2010
sk Bugfixes und Leistungsverbesserungen
1.13
18. Dezember 2009
sk Aktualisierung eines beschädigten Tarballs
1.12
18. Dezember 2009
sk Neue Features und Bugfixes
1.11
16. November 2008
mal Migration auf die GNOME doc-utils
Mario Blättermann mario.blaettermann@gmail.com
2009-2013 2016 2018 2021 Mario Blättermann
Christian Kirbach christian.kirbach@gmail.com
2013 2015-2024 Christian Kirbach
Jürgen Benvenuti gastornis@posteo.org
2024 Jürgen Benvenuti

## Einführung

Dieses Kapitel führt in GTK-Doc ein und gibt einen Überblick darüber, worum es sich dabei handelt und wie es benutzt wird.

### Was ist GTK-Doc?

GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as GLib-based libraries, but it can also be used to document application code.

### Wie funktioniert GTK-Doc?

GTK-Doc works by reading specially-formatted comment blocks placed inside the source files to document symbols such as functions, macros, structs, enums, etc. (though note that for most kind of symbols GTK-Doc will only document the symbols that are declared in header files; for example it won't produce output for static functions).

GTK-Doc also reads template files where documentation can be added there as well.

GTK-Doc consists of a number of programs, each performing a different step in the process.

The main steps are:

1. Schreiben der Dokumentation. Der Autor ergänzt die Quelldateien um die Dokumentation für jede Funktion, jedes Makro usw.

2. Informationen über den Code sammeln. gtkdoc-scan analysiert die Header-Dateien des Code und sucht nach Funktionsdeklarationen, Macros, enum (Aufzählung), struct (Strukturen) und »unions«. Es erstellt die Datei `<module>-decl-list.txt`, welche eine Liste der Deklarationen enthält, und platziert diese in Abschnitte entsprechend der Header-Dateien, in der sie sind. Bei erster Ausführung wird diese Datei nach `<module>-sections.txt` kopiert. Der Autor kann die Abschnitte und die Reihenfolge der Deklarationen in gewünschter Reihenfolge neu anordnen. Die zweite erstellte Datei ist `<module>-decl.txt`. Diese Datei enthält alle Deklarationen, die vom Scanner gefunden wurden. Wenn aus irgendeinem Grund einige Symbole in der Dokumentation erscheinen sollen, wenn die volle Deklaration nicht vom Scanner gefunden werden kann oder die Deklaration anders erscheinen soll, kann man Entitäten ähnlich derer in`<module>-decl.txt` innerhalb `<module>-overrides.txt` platzieren.

   gtkdoc-scangobj kann ebenso dazu verwendet werden, dynamisch eine Bibliothek über irgendeine GObject-Subklasse anzufragen, die sie exportiert. Es speichert Informationen über jede Objektposition in der Klassenhierarchie und über alle GObjekt-Eigenschaften und -Signale, die es bietet.

   gtkdoc-scanobj should not be used anymore. It was needed in the past when GObject was still GtkObject inside GTK.

3. Generating the XML and HTML/PDF. gtkdoc-mkdb turns the template files into XML files in the `xml/` subdirectory. If the source code contains documentation for symbols, using the special comment blocks, it gets merged in here. If there are no tmpl files used it only reads docs from sources and introspection data.

   gtkdoc-mkhtml konvertiert die XML-Dateien in HTML-Dateien im Unterordner `html/`. Ebenso konvertiert gtkdoc-mkpdf die XML-Dateien in ein PDF-Dokument namens `<package>.pdf`.

   Dateien in `xml/` und `html/`-Ordnern werden immer überschrieben. Niemand sollte diese direkt bearbeiten.

4. Fixing up cross-references between documents. After installing the HTML files, gtkdoc-fixxref can be run to fix up any cross-references between separate documents. For example, the GTK documentation contains many cross-references to types documented in the GLib manual.

   When creating the source tarball for distribution, gtkdoc-rebase turns all external links into web-links. When installing distributed (pregenerated) docs the same application will try to turn links back to local links (where those docs are installed).

### GTK-Doc bekommen

#### Erfordernisse

Python 2/3 - Die Hauptskripte wurden in Python geschrieben.

xsltproc - der xslt-Verarbeiter von libxslt xmlsoft.org/XSLT/

docbook-xsl - die docbook xsl-Stilvorlagen sourceforge.net/projects/docbook/files/docbook-xsl

source-highlight, highlight oder vim - optional - für Syntax-Hervorhebung von Beispielen

### Info zu GTK-Doc

In der Vergangenheit wurde GTK-Doc zur Erstellung von Vorlagendateien aus dem Quellcode verwendet. Diese Vorlagendateien konnten von Entwicklern zur Eingabe der API-Dokumentation verwendet werden. Jedoch war dieser Ansatz eher unbequem, weil die erzeugten Dateien unter Versionskontrolle gehalten werden mussten. Ab GTK-Doc 1.9 wurde es möglich, sämtliche API-Informationen in Quellcode-Kommentaren zu platzieren, wodurch die Unterstützung für Vorlagen obsolet wurde. In der Version 1.26 wurde die Vorlagenunterstützung gänzlich entfernt.

(FIXME)

(Autoren, Webseiten, Mailingliste, Lizenz, Zukunftspläne, Vergleich mit ähnlichen Systemen)

### Über dieses Handbuch

(FIXME)

(wofür es bestimmt ist, wo Sie es erhalten können, Lizenz)

## Einrichtung in einem Projekt

Dieses Kapitel beschreibt die notwendigen Schritte, um GTK-Doc in Ihr Projekt zu integrieren. Im einzelnen sind dies folgende Schritte:

- Vorbereitung der Ordnerstruktur und Erstellung der erforderlichen Konfigurationsdateien für Ihre GTK-Doc-Dokumentation (siehe Einrichten des Grundgerüsts der Dokumentation).

- Anpassen des Erstellungssystems, sodass Ihre Dokumentation durch die Werkzeuge von GTK-Doc erstellt wird. Es werden mehrere Erstellungssysteme unterstützt. In diesem Handbuch beschreiben wir die Integration von GTK-Doc in Autotools, CMake und einfache Makefiles.

- Hinzufügen GTK-Doc-spezifischer Dateien zur Versionsverwaltung, wobei zu entscheiden ist, welche Dateien ignoriert werden sollen (siehe Integration in Versionsverwaltungssysteme).

In den folgenden Abschnitten wird ein fiktives Projekt namens `meep` angenommen, an dem wir arbeiten. Das Projekt enthält zwei Pakete (oder Module), eine Bibliothek namens `libmeep` und eine Endbenutzer-Anwendung namens `meeper`.

### Einrichten des Grundgerüsts der Dokumentation

Üblicherweise wir die Dokumentation in einem Ordner namens `docs` in der obersten Ebene Ihres Projektordners platziert. Wir unterscheiden stets zwischen der für Entwickler bestimmten Referenzdokumentation und dem Benutzerhandbuch, das sich an Endbenutzer richtet. Es ist wiederum üblich, dass für beide Werke getrennte Ordner verwendet werden. Wir legen die Referenzdokumentation in einem Ordner namens `reference` und das Benutzerhandbuch in `help`. Nach der oben gennanten Konvention würde dann die Dokumentation für unser `libmeep`-Paket in `docs/reference/libmeep` platziert werden. Bei Paketen, die nur eine Bibliothek oder Anwendung enthalten, kann die Dokumentation auch direkt in `docs/reference` abgelegt werden. Es ist nicht obligatorisch, genau nach diesem Schema vorzugehen, aber wenn Sie von dieser Ordnerstruktur abweichen, müssen Sie die Konfiguration Ihres Erstellungssystems entsprechend anpassen.

In den folgenden Abschnitten gehen wir für unser meep-Projekt von einer Ordnerstruktur aus, die die oben genannten Konventionen berücksichtigt.

Beispielhafte Ordnerstruktur des meep-Projekts

    meep/
      docs/
        reference/  # reference documentation
          libmeep/
          meeper/
        help/       # optional: user manual
          meeper/
      src/
        libmeep/
        meeper/

### Integration in Autotools

Für die Integration von GTK-Doc in ein Autotools-basiertes Projekt sind die folgenden Schritte auszuführen:

- Stellen Sie sicher, dass gtkdocize einmal vor dem `configure`-Skript ausgeführt wird. Falls es ein `autogen.sh`-Skript gibt, passen Sie es so an, dass es nach GTK-Doc sucht und einen gtkdocize-Aufruf hinzufügt.

  Der Hauptzweck von gtkdocize ist die Erstellung der `gtk-doc.make`-Steuerdatei und der Makro-Definitionsdatei `gtk-doc.m4` für das Erstellungssystem, entweder durch Kopieren oder Verlinken im Projekt.

- Fügen Sie die notwendigen autoconf-Makros zu `configure.ac` hinzu, um GTK-Doc in Ihrem Erstellungssystem zu aktivieren, sodass die Konfiguration von GTK-Doc über das erzeugte `configure`-Skript erfolgt.

  Unter anderem wird die Option `--enable-gtk-doc` mit dem `configure`-Skript registriert.

- Erstellen Sie ein automake-Skript für jede Anwendung oder Bibliothek in Ihrem Projekt. In dem in dieser Dokumentation verwendeten Beispiel wird dieser Schritt sowohl auf `meeper` als auch `libmeep` angewendet.

In den folgenden Abschnitten führen wir die oben beschriebenen Schritte in umgekehrter Reihenfolge aus. Wir beginnen mit den automake-Skripten und arbeiten uns bis hinauf zu `configure.ac` und `autogen.sh`. Dann zeigen wir, wie GTK-Doc im Erstellungssystem aktiviert und wie die Dokumentation erstellt wird.

#### Integration in automake

Kopieren Sie zunächst die Datei `Makefile.am` aus dem `examples`-Unterordner der gtkdoc-Quellen in den API-Dokumentationsordner Ihres Projekts ( `./docs/reference/<package>`). Eine lokale Kopie sollte beispielsweise unter `/usr/share/doc/gtk-doc-tools/examples/Makefile.am` verfügbar sein. Falls Sie mehrere Dokumentationspakete haben, müssen Sie dies für jedes davon wiederholen.

Vergessen Sie nicht, jedes `Makefile.am` zum Makro `AC_CONFIG_FILES` in `configure.ac` hinzuzufügen. Für `docs/reference/libmeep/Makefile.am` müssen Sie den Eintrag `docs/reference/libmeep/Makefile` zu `AC_CONFIG_FILES` hinzufügen.

Beispielhafte Ordnerstruktur mit `Makefiles.am`

    meep/
      docs/
        reference/  # reference documentation
          libmeep/
            Makefile.am
          meeper/
            Makefile.am
        help/       # optional: user manual
          meeper/
      src/
        libmeep/
        meeper/

Im nächsten Schritt passen Sie die kopierten Makefiles an und geben Werte für die verschiedenen Parameter in jedem `Makefile.am` an. Allen Einstellungen ist ein Kommentar vorangestellt, der den jeweiligen Zweck beschreibt. Die meisten Einstellungen sind zusätzliche Flags, die an verschiedene Werkzeuge übergeben werden. Jedes der Werkzeuge hat eine Variable der Form `<WERKZEUGNAME>_OPTIONEN`. Alle Werkzeuge unterstützen `--help` zur Auflistung der unterstützten Parameter.

In der folgenden Liste werden einige der relevantesten Optionen erläutert. Im Beispiel für `Makefile.am` finden Sie weitere Optionen.

- `DOC_MODULE` stellt den Namen des Pakets bereit, das dokumentiert werden soll (z.B. `meeper` oder `libmeep`).

- `DOC_SOURCE_DIR` gibt den Ort des Quellordners an, wo GTK-Doc nach Ihrer API-Dokumentation suchen soll. Üblicherweise ist das `DOC_SOURCE_DIR=$(top_srcdir)/src` oder einer von dessen Unterordnern.

- `HFILE_GLOB` und `CFILE_GLOB` werden für Abhängigkeiten verwendet. Jed Option akzeptiert ein file-glob (z.B. `HFILE_GLOB=$(top_srcdir)/src/*.c`). Die Dokumentation wird neu erstellt, wenn sich eine der Dateien ändert.

- Mit `EXTRA_HFILES` können Sie zusätzliche einzuschließende Header-Dateien angeben, wenn nach API-Dokumentation gesucht wird, falls diese nicht unter `DOC_SOURCE_DIR` zu finden ist (z.B. `EXTRA_HFILES=$(top_srcdir}/contrib/extra.h`).

- Mit `IGNORE_HFILES` können Sie zu ignorierende Header-Dateien angeben, wenn nach API-Dokumentation gesucht wird. Verwenden Sie dabei den Basisnamen der Datei oder des Ordners (z.B. `IGNORE_HFILES=gtkdebug.h gtkintl.h private_code_folder`).

- In `HTML_IMAGES` können Sie Bilder angeben, die in den `html/`-Ordner der erzeugten Dokumentation kopiert werden. Falls Ihre API-Dokumentation Bilder enthält, müssen diese zu dieser Option hinzugefügt werden (z.B. `HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png`).

- In `content_files` können Sie zusätzliche Dateien angeben, die in `$(DOC_MAIN_SGML_FILE)` einbezogen werden sollen (z.B. `content_files=running.xml building.xml changes-2.0.xml`).

- In `expand_content_files` geben Sie Dateien an, in denen gtk-doc Abkürzungen wie `#GtkWidget` expandiert werden (z.B. `expand_content_files=running.xml`).

#### Integration in autoconf

Die Integration in autoconf ist recht einfach. Es ist nur ein Schritt zwingend erforderlich sowie ein weiterer optional (aber empfehlenswert). Zunächst fügen Sie das Makro `GTK_DOC_CHECK` zu Ihrem `configure.ac` Skript hinzu. Dadurch werden verschiedene Konfigurationsoptionen zur Aktivierung von GTK-Doc registriert sowie Standardargumente für gtkdocize gesetzt.

Achten Sie darauf, dass das `GTK_DOC_CHECK`-Makro nicht eingerückt ist. Es muss zwingend am Anfang der Zeile stehen und sollte nicht mit einem Leerzeichen beginnen.

Danach fügen Sie `AC_CONFIG_MACRO_DIR(m4)` zu Ihrer `configure.ac`-Datei hinzu. Dies ist nicht zwingend erforderlich, aber hilft gtkdocize dabei, die Makrodefinition (e.g `gtk-doc.m4`), welche das Makro `GTK_DOC_CHECK` enthält, in den Makro-Ordner Ihres Projekts zu kopieren. Wenn Sie diesen Schritt auslassen, könnte das Makro GTK_DOC_CHECK möglicherweise nicht gefunden werden, und Sie müssten den Ort der Makro-Definitionsdatei explizit für aclocal angeben.

Minimale Integration in autoconf

    # recommended: set m4 directory
    AC_CONFIG_MACRO_DIR(m4)
    # optional: register gtk-doc in configure
    GTK_DOC_CHECK([1.28])

Das obige Beispiel funktioniert, aber es erfordert, dass alle Entwickler gtk-doc installiert haben. Eine bessere Lösung ist die optional Erstellung der Dokumentation, wie das nächste Beispiel zeigt:

Integration mit optionaler Abhängigkeit zu gtk-doc

    m4_ifdef([GTK_DOC_CHECK], [
    # recommended: set m4 directory
    AC_CONFIG_MACRO_DIR(m4)
    # optional: register gtk-doc in configure
    GTK_DOC_CHECK([1.28])
    ],[
    AM_CONDITIONAL([ENABLE_GTK_DOC], false)
    ])

Das erste Argument wird zur Überprüfung von der Version von GTK-Doc während des configure-Durchlaufs benutzt. Das zweite, optionale Argument wird von gtkdocize verwendet. Das Makro GTK_DOC_CHECK fügt verschiedene Schalter für configure hinzu:

1. --with-html-dir=PATH : Pfad zur installierten Dokumentation

2. --enable-gtk-doc : gtk-doc zur Erstellung der Dokumentation verwenden [Vorgabe=no]

3. --enable-gtk-doc-html : Erstellung der Dokumentation im HTML-Format [Vorgabe=yes]

4. --enable-gtk-doc-pdf : Erstellung der Dokumentation im PDF-Format [Vorgabe=no]

GTK-Doc ist standardmäßig deaktiviert! Denken Sie daran, die Option `'--enable-gtk-doc'` beim nächsten Durchlauf von `configure` zu übergeben. Anderenfalls wird die vorher erstellte Dokumentation installiert. Dies ergibt für Benutzer durchaus Sinn, aber nicht für Entwickler.

Nachdem alle Änderungen auf `configure.ac` angewendet wurden, aktualisieren Sie die Datei `configure`. Dies geschieht durch erneutes Ausführen von `autogen.sh`.

#### Integration in autogen

Die meisten Projekte dürften über ein `autogen.sh`-Skript verfügen, welches die Build-Infrastruktur nach dem Auschecken aus einem Versionsverwaltungssystem wie SVN oder Git erzeugt. GTK-Doc liefert ein Werkzeug namens gtkdocize mit, das zum Kopieren der für GTK-Doc erforderlichen Dateien in den Quellordner verwendet werden kann.

Es sollte vor autoreconf, autoheader, automake oder autoconf ausgeführt werden.

Ausführen von gtkdocize durch autogen.sh

    gtkdocize || exit 1

Bedingtes Ausführen von gtkdocize durch autogen.sh

    GTKDOCIZE=$(which gtkdocize 2>/dev/null)
    if test $? -ne 0; then
      echo "No gtk-doc support found. You can't build the docs."
    else
      $GTKDOCIZE || exit 1
    fi

Beim Ausführen von gtkdocize wird `gtk-doc.make` in die Wurzel Ihres Projekts oder in jeden anderen durch die Option `--docdir` festgelegten Ordner kopiert.

gtkdocize überprüft das `configure.ac`-Skript daraufhin, ob `GTK_DOC_CHECK` enthalten ist. Dieses Makro kann verwendet werden, um weitere Parameter an gtkdocize zu übergeben, den zweiten Parameter im `GTK_DOC_CHECK`-Makro.

Alternativ können zusätzliche Argumente auch über die Umgebungsvariable `GTKDOCIZE_FLAGS` an gtkdocize übergeben werden, oder durch direktes Anfügen an gtkdocize in `autogen.sh`.

#### Aufruf von GTK-Doc aus dem Erstellungssystem heraus

Nach den bisher absolvierten Schritten ist es Zeit für den Build-Vorgang. Zunächst muss `autogen.sh` erneut ausgeführt werden. Falls dieses Skript auch den configure-Aufruf enthält, sollten Sie die Option `--enable-gtk-doc` hinzufügen. Anderenfalls führen Sie danach `configure` manuell aus, ebenfalls mit dieser Option.

Der erste Durchlauf von make erstellt verschiedene zusätzliche Dateien in den Dokumentationsordnern. Die bedeutendsten davon sind: `<package>.types`, `<package>-docs.xml` (früher .sgml), `<package>-sections.txt`.

Erstellung der Dokumentation

    ./autogen.sh --enable-gtk-doc
    make

Nun können Sie Ihren Browser auf `docs/reference/<package>/index.html` stellen. Mit dieser initialen Einrichtung werden Sie allerdings nur ein sehr simples Dokument sehen. Im nächsten Kapitel erläutern wir, wie Sie API-Dokumentation mittels spezieller Kommentarblöcke in Ihren Code einbauen können. Das Kapitel danach führt in zusätzliche Dateien ein und zeigt, wie die Master-Vorlage bearbeitet wird, um zusätzliche Kapitel und Abschnitte zu Ihren Dokumentationsdateien hinzuzufügen.

### Integration in CMake-Erstellungssysteme

GTK-Doc stellt nun ein `GtkDocConfig.cmake`-Modul (und das korrespondierende `GtkDocConfigVersion.cmake`-Modul) bereit. Dadurch steht Ihnen der Befehl `gtk_doc_add_module` zur Verfügung, den Sie in die Datei `CMakeLists.txt` integrieren können.

Das folgende Beispiel zeigt, wie dieser Befehl eingesetzt wird.

Beispiel zur Verwendung von GTK-Doc mit CMake

    find_package(GtkDoc 1.25 REQUIRED)

    # Create the doc-libmeep target.
    gtk_doc_add_module(
       libmeep ${CMAKE_SOURCE_DIR}/libmeep
          XML meep-docs.xml
          LIBRARIES libmeep
    )

    # Build doc-libmeep as part of the default target. Without this, you would
    # have to explicitly run something like `make doc-libmeep` to build the docs.
    add_custom_target(documentation ALL DEPENDS doc-libmeep)

    # Install the docs. (This assumes you're using the GNUInstallDirs CMake module
    # to set the CMAKE_INSTALL_DOCDIR variable correctly).
    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html
            DESTINATION ${CMAKE_INSTALL_DOCDIR})

### Integration in Klartext-Makefiles oder andere Erstellungssysteme

Für den Fall, dass jemand nicht automake und damit `gtk-doc.mak` einsetzen will, muss man die gtkdoc-Werkzeuge in eigenen Makefiles (oder andere Werkzeugen) in der richtigen Reihenfolge aufrufen.

Schritte zur Erstellung der Dokumentation

    DOC_MODULE=meep
    // sources have changed
    gtkdoc-scan --module=$(DOC_MODULE) <source-dir>
    gtkdoc-scangobj --module=$(DOC_MODULE)
    gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=<source-dir>
    // xml files have changed
    mkdir html
    cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
    gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html

Man muss sich `Makefile.am` und `gtk-doc.mak` anschauen, um die zusätzlich notwendigen Optionen herauszusuchen.

### Integration in Versionsverwaltungssysteme

Als Faustregel gilt, dass alle von Ihnen bearbeiteten Dateien auch unter Versionsverwaltung stehen sollten. In typischen Projekten sind das folgende Dateien: `<package>.types`, `<package>-docs.xml` (früher .sgml), `<package>-sections.txt`, `Makefile.am`.

Dateien in den Ordnern `xml/` und `html/` sollten nicht unter Versionsverwaltung gestellt werden, ebenso keine der `.stamp`-Dateien.

## Dokumentieren des Codes

GTK-Doc benutzt Quellcode-Kommentare mit einer speziellen Syntax für Code-Dokumentation. Weiterhin werden Informationen über Ihre Projektstruktur aus anderen Quellen geholt. Im nächsten Abschnitt finden Sie umfassende Informationen über die Syntax der Kommentare.

Der Scanner von GTK-Doc kann mit den meisten C-Kopfdateien umgehen. Im Falle von Warnungen des Scanners, die wie ein Spezialfall aussehen, kann man GTK-Doc anweisen, diese zu überspringen.

GTK-Doc-Kommentarblock

    #ifndef __GTK_DOC_IGNORE__
    /* unparseable code here */
    #endif

Einschränkungen

Beachten Sie, dass GTK-Doc zwar `#ifndef(__GTK_DOC_IGNORE__)` unterstützt, aber nicht `#if !defined(__GTK_DOC_IGNORE__)` oder andere Kombinationen.

### Kommentare zur Dokumentation

Ein mehrzeiliger Kommentar, der mit einem zusätzlichen »*« beginnt, markiert einen Kommentarblock, der von den Werkzeugen in GTK-Doc verarbeitet wird.

GTK-Doc-Kommentarblock

    /**
     * identifier:
     * documentation ...
     */

Der »identifier« ist eine Zeile mit dem Namen des Objekts, auf das sich der Kommentar bezieht. Die Syntax kann abhängig von der Art des Objekts variieren.

Der Block »documentation« ist ebenfalls für jeden Symboltyp unterschiedlich. Symboltypen mit Parametern wie Funktionen oder Makros haben eine Parameterbeschreibung, auf die eine leere Zeile folgt (keine echte Leerzeile, sondern ein »*«). Danach folgt eine detaillierte Beschreibung. Alle Zeilen (außerhalb von Programmlistings und CDATA-Abschnitten), die nur ein » *« (Leerzeichen-Asterisk) enthalten, werden in Absatzumbrüche umgewandelt. Falls Sie keinen Absatzumbruch wünschen, verwenden Sie stattdessen ein » * «, d.h. setzen Sie ein Leerzeichen jeweils davor und dahinter. Dies ist in vorformatiertem Text nützlich (Code-Auflistungen).

Beim Dokumentieren von Code beschreiben Sie zwei Aspekte:

- Was es ist: Der Name für eine Klasse oder Funktion kann manchmal irreführend sein für Personen, die einen anderen Hintergrund haben.

- Was es ist: Berichtet über normale Anwendungsfälle. Stellen Sie es ins Verhältnis mit der anderen API.

Ein Vorteil von Hypertext gegenüber Klartext ist die Möglichkeit, Verknüpfungen im Dokument zu verwenden. Das Schreiben eines korrekten Markups für eine solche Verknüpfung kann allerdings langatmig sein, deshalb stellt GTK-Doc eine Reihe von praktischen Abkürzungen bereit.

- Verwenden Sie function(), um einen Bezug zu Funktionen oder Makros herzustellen, die Argumente akzeptieren.

- Verwenden Sie @param, um einen Bezug zu Parametern herzustellen. Verwenden Sie dies auch, wenn es um einen Bezug zu Parametern anderer Funktionen geht, bezogen auf jene, die Sie gerade beschreiben.

- Benutzen Sie %constant, um einen Bezug auf eine Konstante herzustellen, z.B. %G_TRAVERSE_LEAFS.

- Verwenden Sie #symbol, um auf andere Symboltypen zu verweisen, z.B. »structs« und »enums« und Makros, die keine Argumente benötigen.

- Verwenden Sie #Object::signal, um auf ein GObject-Signal zu verweisen.

- Verwenden Sie #Object:property, um auf eine GObject-Eigenschaft zu verweisen.

- Verwenden Sie #Struct.field, um auf ein Feld innerhalb einer Struktur zu verweisen und #GObjectClass.foo_bar() für eine vmethod.

Falls Sie die Sonderzeichen »<«, »>«, »()«, »@«, »%« oder »#« in Ihrer Dokumentation verwenden wollen, ohne dass GTK-Doc diese ändert, können Sie die XML-Entitäten »&lt;«, »&gt;«, »&lpar;«, »&rpar;«, »&commat;«, »&percnt;« und »&num;« verwenden oder die Zeichen mit einem Backslash »\« maskieren.

DocBook kann mehr als nur Verweise zu erzeugen. Sie können Listen, Beispiele, Überschriften und Bilder einfügen. In Version 1.20 ist der bevorzugte Weg, ein Subset grundlegender Textformatierungssyntax namens Markdown zu verwenden. In älteren Versionen von GTK-Doc wird jede Dokumentation, die Markdown enthält, unverändert gerendert. Zum Beispiel erscheinen Listenobjekte als Zeilen, die mit einem Gedankenstrich beginnen.

Wenngleich Markdown bevorzugt wird, können Sie beide Formate mischen. Eine Einschränkung ist jedoch, dass Sie DocBook XML innerhalb von Markdown verwenden können, während Markdown in DocBook XML nicht unterstützt wird.

Um die Nutzung der DocBook-XML-Markierungen innerhalb der Dokumentationskommentare zu aktivieren, übergeben Sie der Variable MKDB_OPTIONS in der Datei `Makefile.am` die Option `--xml-mode` (oder `--sgml-mode`).

GTK-Doc-Kommentarblock in Markdown-Syntax

    /**
     * identifier:
     *
     * documentation paragraph ...
     *
     * # Sub Heading #
     *
     * ## Second Sub Heading
     *
     * # Sub Heading With a Link Anchor # {#heading-two}
     *
     * more documentation:
     *
     * - list item 1
     *
     *   Paragraph inside a list item.
     *
     * - list item 2
     *
     * 1. numbered list item
     *
     * 2. another numbered list item
     *
     * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)
     *
     * ![an inline image](plot-result.png)
     *
     * [A link to the heading anchor above][heading-two]
     *
     * A C-language example:
     * |[<!-- language="C" -->
     * GtkWidget *label = gtk_label_new ("Gorgeous!");
     * ]|
     */

Weitere Beispiele zu den unterstützten Markdown-Formatierungen finden Sie in der GTK Documentation Markdown Syntax Reference.

Wie an früherer Stelle bereits erwähnt, ist GTK-Doc für das Dokumentieren der öffentlichen API gedacht. Daher kann man keine Dokumentation für statische Symbole schreiben. Nichtsdestotrotz ist es jedoch gut, diese Symbole trotzdem zu dokumentieren. Dies hilft anderen, Ihren Code besser zu verstehen. Deswegen empfehlen wir, hierfür normale Kommentare zu verwenden, ohne das zweite »*« in der ersten Zeile. Falls später die Funktion veröffentlicht werden soll, ist es lediglich nötig, im Kommentarblock ein zweites »*« hinzuzufügen und den Symbolnamen an der richtigen Stelle in die Abschnittsdatei einzubauen.

### Dokumentieren in Abschnitten

Jeder Abschnitt der Dokumentation enthält Informationen über eine Klasse oder ein Modul. Um eine Komponente hinzuzufügen, können Sie einen Abschnittsblock schreiben. Die Kurzbeschreibung wird auch im Inhaltsverzeichnis verwendet. Alle @-Felder sind optional.

Abschnitts-Kommentarblock

    /**
     * SECTION:meepapp
     * @short_description: the application class
     * @title: Meep application
     * @section_id:
     * @see_also: #MeepSettings
     * @stability: Stable
     * @include: meep/app.h
     * @image: application.png
     *
     * The application class handles ...
     */

SECTION:<name>

  Der Name verweist auf die Abschnittsdokumentation des entsprechenden Teils der Datei `<package>-sections.txt`. Der hier angegebene Name sollte der Markierung <FILE> in der Datei `<package>-sections.txt` entsprechen.

@short_description

  Eine einzeilige Beschreibung des Abschnitts, die später hinter den Verweisen im Inhaltsverzeichnis und oben in der Abschnittsseite erscheint.

@title

  Der Abschnittstitel in der SECTION-Deklaration, Vorgabe ist <name>. Er kann im Feld @title überschrieben werden.

@section_id

  Überschreibt den Einsatz von Titeln als Abschnitts-Bezeichner. Für GObjects wird der <Titel> als section_id verwendet and für andere Abschnitte <MODUL>-<Titel>.

@see_also

  Eine Liste von Symbolen, welche sich auf diesen Abschnitt beziehen.

@stability

  Eine informelle Beschreibung der Stabilitätsstufe dieser API. Wir empfehlen dafür einen der folgenden Begriffe:

  - Stabil - Die Absicht einer stabilen Schnittstelle ist es, beliebigen Dritten es zu ermöglichen, Anwendungen zu diesen Schnittstellen zu entwickeln, diese freizugeben und sich darauf verlassen zu können, dass diese mit allen Unterversionen des Produkts laufen (nach derjenigen, wo die Schnittstelle eingeführt wurde, und innerhalb der gleichen Hauptversion). Selbst bei einer Hauptversion kann man nicht von inkompatiblen Änderungen ausgehen, abgesehen von stark berechtigten.

  - Instabil - Instabile Schnittstellen sind experimentell oder vorübergehend. Sie werden typischerweise verwendet, um außenstehenden Entwicklern frühen Zugang zu neuen oder sich schnell ändernden Technologien zu geben, oder um eine Übergangslösung für ein Problem zu liefern, für das eine allgemeinere Lösung erwartet wird. Es werden keine Garantien zu Quell- oder Binärkompatibilität von einer minor-Freigabe zur nächsten gegeben.

  - Privat - Eine Schnittstelle, die im GNOME-Stack selbst verwendet werden kann, aber nicht für Endanwender dokumentiert ist. Solche Funktionen sollten nur auf spezifizierte und dokumentierte Weisen verwendet werden.

  - Intern - Eine Schnittstelle, die für ein Modul intern ist und keine Endanwender-Dokumentation erfordert. Undokumentierte Funktionen werden als intern angesehen.

@include

  Die `#include` -Dateien werden im Abschnitt »synopsis« angezeigt (eine durch Kommata getrennte Liste). Der globale Wert aus der Abschnittsdatei oder von der Befehlszeile wird überschrieben. Dieser Punkt ist optional.

@image

  Das Bild, das am Beginn einer Referenzseite für diesen Abschnitt angezeigt wird. Meist wird es eine Art Diagramm für das visuelle Erscheinungsbild einer Klasse oder ein Diagramm sein, das die Beziehungen zu anderen Klassen darstellt. Dieses Objekt ist optional.

Um unnötiges Rekompilieren nach Dokumentationsänderungen zu vermeiden, platzieren Sie die Abschnittsdokumentation in die C-Quellen, wo immer es möglich ist.

### Dokumentieren von Symbolen

Jedes Symbol (function, macro, struct, enum, signal und property) wird in einem separaten Block dokumentiert. Der Block wird am besten nahe der Definition der Symbole platziert, sodass es leichter ist, diese synchron zu halten. Die Funktion wird üblicherweise in den C-Quellen definiert, »macro«, »struct« und »enum« dagegen in der Header-Datei.

#### Allgemeine Markierungen

Sie können Versionsinformationen zu allen Dokumentationselementen hinzufügen, um darauf hinzuweisen, wann eine API eingeführt oder wann sie als veraltet markiert wurde.

Versionierungs-Markierungen

Since:

  Beschreibung, seit welcher Version des Codes die API verfügbar ist.

Deprecated:

  Absatz, der darüber informiert, dass diese Funktion nicht mehr genutzt werden sollte. Die Beschreibung sollte einen Verweis auf die neue API enthalten.

Sie können Stabilitätsinformationen zu allen Dokumentationselementen hinzufügen, um darauf hinzuweisen, ob API-Stabilität für alle Minor-Veröffentlichungen des Projekts garantiert wird.

Die Standard-Stabilitätsstufe für alle Dokumentationselemente setzen Sie durch Übergabe des Arguments `--default-stability` an gtkdoc-mkdb in einem der nachfolgend beschriebenen Werte.

Stabilitäts-Markierungen

Stability: Stable

  Markiert das Element als stabil. Dies bezieht sich auf öffentliche APIs, für die für alle zukünftigen Minor-Veröffentlichungen des Projekts Stabilität gewährleistet ist.

Stability: Unstable

  Markiert das Element als instabil. Dies bezieht sich auf öffentliche APIs, die als Vorschau vor der endgültigen Stabilisierung gedacht sind.

Stability: Private

  Markiert das Element als privat. Dies bezieht sich auf Schnittstellen, die von eng damit verknüpften Modulen genutzt werden kann, aber nicht von beliebigen Drittanbietern.

Allgemeine Markierungen

    /**
     * foo_get_bar:
     * @foo: some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: @foo's bar
     *
     * Since: 2.6
     * Deprecated: 2.12: Use foo_baz_get_bar() instead.
     */
    Bar *
    foo_get_bar(Foo *foo)
    {
    ...

#### Anmerkungen

Dokumentationsblöcke können Anmerkungs-Markierungen enthalten. Diese Markierungen werden als Tooltips (Minihilfen) dargestellt, die die jeweilige Bedeutung anzeigen. Sie werden von GObject Introspection genutzt, um Sprachbindungen zu erzeugen. Eine detaillierte Liste der unterstützten Markierungen finden Sie in der GObject Introspection-Dokumentation.

Anmerkungen

    /**
     * foo_get_bar: (annotation)
     * @foo: (annotation): some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: (annotation): @foo's bar
     */
    ...
    /**
     * foo_set_bar_using_the_frobnicator: (annotation) (another annotation)
     *                                    (and another annotation)
     * @foo: (annotation) (another annotation): some foo
     *
     * Sets bar on @foo.
     */

#### Kommentarblock einer Funktion

Bitte denken Sie an:

- Dokumentieren, ob zurückgegebene Objekte, Listen, Zeichenketten usw. befreit/dereferenziert/freigegeben werden.

- Dokumentiert, ob Parameter NULL sein können, und was in diesem Fall geschieht.

- Erwähnen Sie interessante Vorbedingungen (und nachfolgende Bedingungen), wo es nützlich erscheint.

GTK-Doc nimmt an, dass alle Symbole (Makros, Funktionen), die mit »_« beginnen, privat sind. Sie werden wie statische Funktionen behandelt.

Kommentarblock einer Funktion

    /**
     * function_name:
     * @par1:  description of parameter 1. These can extend over more than
     * one line.
     * @par2:  description of parameter 2
     * @...: a %NULL-terminated list of bars
     *
     * The function description goes here. You can use @par1 to refer to parameters
     * so that they are highlighted in the output. You can also use %constant
     * for constants, function_name2() for functions and #GtkWidget for links to
     * other declarations (which may be documented elsewhere).
     *
     * Returns: an integer.
     *
     * Since: 2.2
     * Deprecated: 2.18: Use other_function() instead.
     */

Funktions-Markierungen

Returns:

  Abschnitt, der das zurückgegebene Ergebnis beschreibt.

@...:

  Wenn die Funktion variadische Argumente enthält, sollten Sie diese Markierung verwenden (@Varargs: funktioniert aus historischen Gründen ebenfalls).

#### Property-Kommentarblock

Property-Kommentarblock

    /**
     * SomeWidget:some-property:
     *
     * Here you can document a property.
     */
    g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);

#### Signal-Kommentarblock

Bitte denken Sie an:

- Dokumentiert, wann ein Signal ausgegeben wird und ob es vor oder nach anderen Signalen ausgegeben wird.

- Dokumentiert, was eine Anwendung in dem Signal-Handler tun könnte.

Signal-Kommentarblock

    /**
     * FooWidget::foobarized:
     * @widget: the widget that received the signal
     * @foo: some foo
     * @bar: some bar
     *
     * The ::foobarized signal is emitted each time someone tries to foobarize @widget.
     */
    foo_signals[FOOBARIZED] =
      g_signal_new ("foobarized",
                    ...

#### Struct-Kommentarblock

Struct-Kommentarblock

    /**
     * FooWidget:
     * @bar: some #gboolean
     *
     * This is the best widget, ever.
     */
    typedef struct _FooWidget {
      GtkWidget parent_instance;

      gboolean bar;
    } FooWidget;

Verwenden Sie `/*< private >*/` vor den privaten »struct«-Feldern, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, verwenden Sie `/*< public >*/`.

Wenn das erste Feld »g_iface«, »parent_instance« oder »parent_class« ist, wird es automatisch als privat angesehen und muss nicht im Kommentarblock erwähnt werden.

Struct-Kommentarblöcke können auch für GObjects und GObjectClasses verwendet werden. Es ist ratsam, einen Kommentarblock für eine Klasse hinzuzufügen, wenn diese vmethods enthält (dies ist die Art der Dokumentation dafür). Für GObject selbst können Sie die jeweiligen Abschnittsdokumentationen verwenden, wobei ein separater Block für das Instanz-Struct sinnvoll ist, sofern die Instanz öffentliche Felder enthält. Ein Nachteil ist hier, dass dadurch zwei gleichnamige Indexeinträge erstellt werden (die Struktur und der Abschnitt).

#### Enum-Kommentarblock

Enum-Kommentarblock

    /**
     * Something:
     * @SOMETHING_FOO: something foo
     * @SOMETHING_BAR: something bar
     *
     * Enum values used for the thing, to specify the thing.
     */
    typedef enum {
      SOMETHING_FOO,
      SOMETHING_BAR,
      /*< private >*/
      SOMETHING_COUNT
    } Something;

Verwenden Sie `/*< private >*/` vor den privaten »enum«-Werten, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, verwenden Sie `/*< public >*/`.

### Eingebettete Programmdokumentation

Dokumentieren Sie ein Programm und dessen Befehlszeilen-Schnittstelle mit eingebetteter Dokumentation.

Markierungen

PROGRAM

  Definiert den Start einer Programmdokumentation.

@short_description:

  Definiert eine Kurzbeschreibung des Programms (optional).

@synopsis:

  Definiert die Argumente oder eine Liste von Argumenten, die das Programm akzeptiert (optional).

@see_also:

  Der Abschnitt »SEE ALSO« in den man-Pages (Unix-Handbuchseiten, optional).

@arg:

  Argument(e), die dem Programm übergeben wurden, und die zugehörige Beschreibung (optional).

Description:

  Eine ausführlichere Beschreibung des Programms.

Returns:

  Geben Sie an, welche Wert(e) das Programm zurück gibt (optional).

#### Beispiel einer Programmdokumentation.

Programm-Dokumentationsblock

    /**
     * PROGRAM:test-program
     * @short_description: A test program
     * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*
     * @see_also: test(1)
     * @--arg1 *arg*: set arg1 to *arg*
     * @--arg2 *arg*: set arg2 to *arg*
     * @-v, --version: Print the version number
     * @-h, --help: Print the help message
     *
     * Long description of program.
     *
     * Returns: Zero on success, non-zero on failure
     */
    int main(int argc, char *argv[])
    {
    	return 0;
    }

### Nützliche DocBook-Markierungen

Nachfolgend finden Sie einige DocBook-Markierungen, die beim Dokumentieren von Code nützlich sein können.

So erstellen Sie eine Verknüpfung zu einem anderen Abschnitt in den GTK-Docs:

    <link linkend="glib-Hash-Tables">Hash Tables</link>

»linkend« ist dabei die SGML-XML-Kennung des obersten Elements der Seite, auf welche die Verknüpfung zielt (»gtk«, »gdk«, »glib«), danach folgt der Seitentitel (»Hash Tables«). Für Widgets ist dies einfach der Klassenname. Leerzeichen und Unterstriche werden SGML/XML-konform in »-« umgewandelt.

Für einen Bezug zu einer externen Funktion, z.B. einer C-Standardfunktion:

    <function>...</function>

So fügen Sie Beispielcode ein: Vielleicht auch so, für sehr kurze Codeschnipsel, die keinen Titel benötigen:

    <informalexample>
      <programlisting language="C">
      …
      </programlisting>
    </informalexample>

. In beiden Fällen ist das Language-Attribut optional und wird als Hinweis für die Syntaxhervorhebung-Engine verwnedet (Pygments für die HTML-Ausgabe). Außerdem unterstützt GTK-Doc auch eine Abkürzung:

    |[<!-- language="C" -->
      …
    ]|

Für eine Liste mit Aufzählungszeichen:

    <itemizedlist>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
    </itemizedlist>

Für eine nicht zum eigentlichen Text gehörende Notiz:

    <note>
      <para>
        Make sure you free the data after use.
      </para>
    </note>

Für einen Bezug zu einem Typ:

    <type>unsigned char</type>

Für einen Bezug zu einer externen Struktur (die nicht in den GTK-Docs beschrieben wird):

    <structname>XFontStruct</structname>

Für einen Bezug zu einem Feld einer Struktur:

    <structfield>len</structfield>

Um sich auf einen Klassennamen zu beziehen, kann man möglicherweise folgendes verwenden:

    <classname>GtkWidget</classname>

Aber Sie verwenden vermutlich stattdessen #GtkWidget (um automatisch eine Verknüpfung zur GtkWidget-Seite zu erstellen - lesen Sie die Abkürzungen).

Zum Hervorheben von Text:

    <emphasis>This is important</emphasis>

Für Dateinamen:

    <filename>/home/user/documents</filename>

Für einen Bezug zu einem Schlüssel:

    <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>

## Füllen der zusätzlichen Dateien

Es gibt eine Menge zusätzlicher Dateien, die mit den eingebetteten Quellcode-Kommentaren verwaltet werden müssen: `<package>.types`, `<package>-docs.xml` (früher .sgml), `<package>-sections.txt`.

### Bearbeiten der Typendatei

Falls Ihre Bibliothek oder Anwendung GObjects beinhaltet, sollten deren Signale, Argumente/Parameter und Positionen in der Hierarchie in der Dokumentation erscheinen. Alles was Sie tun müssen, ist die `xxx_get_type`-Funktionen zusammen mit deren Includes in der Datei `<package>.types` aufzulisten.

Beispiel-Schnipsel einer <package>.types-Datei

    #include <gtk/gtk.h>

    gtk_accel_label_get_type
    gtk_adjustment_get_type
    gtk_alignment_get_type
    gtk_arrow_get_type

Seit GTK-Doc 1.8 kann gtkdoc-scan diese Liste für Sie erstellen. Fügen Sie einfach »--rebuild-types« zu SCAN_OPTIONS in `Makefile.am` hinzu. Wenn Sie so vorgehen, sollten Sie weder Typen-Datei mit veröffentlichen noch diese unter Versionsverwaltung stellen.

### Bearbeiten des Master-Dokuments

GTK-Doc erstellt die Dokumentation in DocBook-SGML/XML. Beim Verarbeiten der in den Quellcode eingebetteten Kommentare erzeugt GTK-Doc eine Dokumentationsseite pro Klasse oder Modul als separate Datei. Das Hauptdokument schließt diese ein und setzt sie in die passende Reihenfolge.

Während GTK-Doc ein Vorlagen-Hauptdokument für Sie erstellt, wird eine spätere Ausführung es nicht mehr verändern. Das bedeutet, dass Sie das Dokument beliebig strukturieren können. Dies schließt Gruppieren von Seiten und Hinzufügen von zusätzlichen Seiten ein. GTK-Doc hat eine neue Test-Suite, wo auch das Hauptdokument von Grund auf neu erstellt wird. Es ist ratsam, sich diese von Zeit zu Zeit anzusehen und zu schauen, ob dort einige Neuigkeiten eingeführt werden.

Erstellen Sie keine Schritt-für-Schritt-Anleitungen als zusätzliche Dokumente. Schreiben Sie lediglich zusätzliche Kapitel. Der Vorteil des direkten Einbettens einer Anleitung für Ihre Bibliothek in die API ist die Möglichkeit der einfachen Verknüpfung der Schritt-für-Schritt-Anleitung zur Symboldokumentation. Außerdem sind die Chancen größer, dass die Anleitung die gleichen Aktualisierungen erfährt wie die Bibliothek selbst.

Was sollte nun innerhalb des Master-Dokuments geändert werden? Zunächst recht wenig. Es gibt einige Platzhalter (Text in eckigen Klammern), die Sie beachten sollten.

Kopfzeile des Master-Dokuments

    <bookinfo>
      <title>MODULENAME Reference Manual</title>
      <releaseinfo>
        for MODULENAME [VERSION]
        The latest version of this documentation can be found on-line at
        <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
      </releaseinfo>
    </bookinfo>

    <chapter>
      <title>[Insert title here]</title>

Zusätzlich werden einige Optionselemente in Kommentarform erstellt. Sie können sich diese anschauen und aktivieren, wenn Sie wollen.

Optionaler Teil im Master-Dokument

      <!-- aktivieren Sie dieses, wenn Sie gobject introspection-Anmerkungen verwenden
      <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
      -->

Schlussendlich müssen Sie einen neuen Abschnitt explizit einfügen, sobald Sie einen öffnen. Das Werkzeug gtkdoc-check erinnert Sie an neu erzeugte XML-Dateien, die in der Dokumentation noch nicht erfasst sind.

Einbeziehen erzeugter Abschnitte

      <chapter>
        <title>my library</title>
          <xi:include href="xml/object.xml"/>
          ...

### Bearbeiten der Abschnittsdatei

Die Abschnittsdatei wird verwendet, um die Dokumentations-Ausgaben von GTK-Doc zu organisieren. Man gibt an, welches Symbol zu welchem Modul oder welcher Klasse gehört und regelt die Sichtbarkeit (öffentlich oder privat).

Die Abschnittsdatei ist eine reine Textdatei mit Markierungen, welche die Abschnitte voneinander trennen. Leere Zeilen werden ignoriert und Zeilen, die mit »#« beginnen, werden als Kommentarzeilen behandelt.

Zwar lassen die Markierungen die Datei wie XML erscheinen, doch der Schein trügt. Bitte schließen Sie keine Markierungen wie <SUBSECTION>.

Einbeziehen erzeugter Abschnitte

    <INCLUDE>libmeep/meep.h</INCLUDE>

    <SECTION>
    <FILE>meepapp</FILE>
    <TITLE>MeepApp</TITLE>
    MeepApp
    <SUBSECTION Standard>
    MEEP_APP
    ...
    MeepAppClass
    meep_app_get_type
    </SECTION>

Die Markierung <FILE> ... </FILE> wird verwendet, um den Dateinamen ohne Suffix anzugeben. Zum Beispiel wird »<FILE>gnome-config</FILE>« dazu führen, dass der Deklarationsabschnitt in die Vorlage-Datei `tmpl/gnome-config.sgml` ausgegeben wird, welche in die DocBook-XML-Datei `sgml/gnome-config.sgml` oder die DocBook-XML-Datei `xml/gnome-config.xml` umgewandelt wird. (Der Name der HTML-Datei basiert auf dem Modulnamen und dem Abschnittstitel. Für GObject basiert er auf dem GObject-Klassennamen in Kleinbuchstaben).

Das Tag <TITLE> ... </TITLE> wird zur Angabe des Abschnitttitels verwendet. Es ist nur nützlich bevor die Vorlagen (falls verwendet) anfangs erstellt werden, weil der Titel in der Vorlage diesen überschreibt. Wenn man das SECTION-Kommentar in den Quellen einsetzt, ist dies überflüssig.

Sie können Objekte im Abschnitt mittels der Markierung <SUBSECTION> gruppieren. Derzeit gibt es eine Leerzeile zwischen Unterabschnitten im Inhaltsangabe-Abschnitt aus. Sie können auch <SUBSECTION Standard> für Standard GObject-Deklarationen verwenden (z.B. Funktionen wie g_object_get_type und Makros wie G_OBJECT(), G_IS_OBJECT() etc.). Derzeit werden diese nicht in die Dokumentation aufgenommen. Sie können auch <SUBSECTION Private> für private Deklarationen verwenden, welche nicht ausgegeben werden. Dies ist eine praktische Möglichkeit, Warnmeldungen bezüglich ungenutzter Deklarationen zu vermeiden. Wenn Ihre Bibliothek private Typen enthält, die nicht in der Objekthierarchie und der Liste der implementierten oder benötigten Schnittstellen erscheinen sollen, fügen Sie diese zu einem »Private«-Unterabschnitt hinzu. Ob Sie GObject oder GObjectClass wie Structs im öffentlichen oder im Standardabschnitt einsetzen, hängt davon ab, ob öffentliche Einträge vorhanden sind (Variablen, vmethods).

Sie können auch <INCLUDE> ... </INCLUDE> verwenden, um die #include-Dateien anzugeben, die in den Abschnitten zur Inhaltsangabe gezeigt werden. Es enthält eine durch Kommata getrennte Liste von #include-Dateien ohne eckige Klammern. Wenn Sie es außerhalb aller Abschnitte festlegen, wirkt es in allen Abschnitten bis zum Dateiende. Wenn Sie es innerhalb eines Abschnitts festlegen, wirkt es nur in diesem Abschnitt.

## Überprüfung des Ergebnisses

Ein GTK-Doc-Durchlauf erzeugt Protokolldateien im Dokumentationsordner. Die Namen der erzeugten Dateien sind: `<package>-undocumented.txt`, `<package>-undeclared.txt` und `<package>-unused.txt`. Sie liegen alle als Klartext vor und können daher einfach betrachtet und weiterverarbeitet werden.

Die Datei `<package>-undocumented.txt` beginnt mit der Zusammenfassung der Dokumentation. Darunter sind zwei durch Leerzeilen getrennte Abschnitte. Der erste Abschnitt listet undokumentierte oder unvollständige Symbole. Der zweite Abschnitt macht das gleiche für Abschnitts-Dokumente. Unvollständige Einträge sind jene, welche Dokumentation haben, aber z.B. ein neuer Parameter hinzugefügt worden ist.

Die Datei `<package>-undeclared.txt` listet die in `<package>-sections.txt` gelieferten, aber nicht in den Quellen gefundenen Symbole. Prüfen Sie, ob diese entfernt oder falsch geschrieben wurden.

Die Datei `<package>-unused.txt` listet Symbolnamen auf, in denen der GTK-Doc-Scanner Dokumentation gefunden hat, aber nicht weiß, wo sie abgelegt werden soll. Dies bedeutet, dass das Symbol noch nicht der Datei `<package>-sections.txt` hinzugefügt wurde.

Aktivieren Sie oder fügen Sie die Zeile `TESTS=$(GTKDOC_CHECK)` in Makefile.am hinzu. Wenn zumindest GTK-Doc 1.9 installiert ist, so wird damit eine Plausibilitätsprüfung während `make check` ausgeführt.

Man kann sich auch die Dateien ansehen, die durch den Quellcode-Scanner erzeugt wurden: `<package>-decl-list.txt` und `<package>-decl.txt`. Die erste kann mit der Abschnittsdatei verglichen werden, falls diese händisch verwaltet wird. Die zweite listet alle Deklarationen aus den Kopfdateien. Falls ein Symbol fehlt kann man prüfen, ob diese Datei es enthält.

Wenn das Projekt auf GObject basiert, kann man auch in die Dateien schauen, die der Objekt-Scanner erzeugt hat: `<package>.args.txt`, `<package>.hierarchy.txt`, `<package>.interfaces.txt`, `<package>.prerequisites.txt` und `<package>.signals.txt`. Falls in irgendeiner Datei Symbole fehlen, können Sie Gtk-Doc anweisen, die zwischenläufige Scanner-Datei zur weiteren Analyse zu behalten, indem Sie `GTK_DOC_KEEP_INTERMEDIATE=1 make` ausführen.

## Die Dokumentation modernisieren

GTK-Doc ist schon seit längerer Zeit verfügbar. In diesem Abschnitt zeigen wir neue Features und die Version, mit der sie eingeführt wurden.

### GTK-Doc 1.9

Wenn Sie XML anstatt SGML verwenden, können Sie das Hauptdokument `<package>-docs.xml` nennen.

Diese Version unterstützt `SCAN_OPTIONS=--rebuild-sections` in `Makefile.am`. Wenn dies aktiviert ist, wird die Datei `<package>-sections.txt` automatisch erzeugt und kann aus der Versionsverwaltung entfernt werden. Dies funktioniert nur sauber in Projekten, die eine strikt »reguläre« Struktur haben (zum Beispiel erzeugt jedes .{c,h}-Paar einen neuen Abschnitt). In einem solch sauber organisierten Projekt kann dann mit dem Befehl `meld <package>-decl-list.txt <package>-sections.txt` eine manuell verwaltete Abschnittsdatei sehr einfach aktualisiert werden.

In Version 1.8 wurde bereits die Syntax für Dokumentationsabschnitte in den Quelltexten anstelle von separaten Dateien unter `tmpl` eingeführt. Diese Version fügt Optionen zur Umstellung des gesamten Dokumentationsmoduls auf das neue Verhalten hinzu, sodass kein zusätzlicher tmpl-Erstellungsschritt mehr nötig ist. Dazu dient die Option `--flavour no-tmpl` in `configure.ac`. Wenn Sie keinen Ordner namens `tmpl` in die Versionsverwaltung eingestellt haben und noch nicht umgestellt haben, fügen Sie einfach die Option zu `configure.ac` hinzu, und die Sache ist erledigt.

### GTK-Doc 1.10

Diese Version unterstützt `SCAN_OPTIONS=--rebuild-typess` in `Makefile.am`. Wenn dies aktiviert ist, wird die Datei `<package>.types` automatisch erzeugt und kann aus der Versionsverwaltung entfernt werden. Dieses Feature erfordert die Einrichtung von `IGNORE_HFILES` in `Makefile.am` für Code, der nur unter bestimmten Bedingungen erstellt werden soll.

### GTK-Doc 1.16

Diese Version führt ein neues Werkzeug namens gtkdoc-check ein. Damit können Sie eine Reihe von Plausibilitätsprüfungen auf Ihre Dokumentation anwenden. Um es zu aktivieren, fügen Sie folgende Zeilen am Ende von `Makefile.am` hinzu.

gtkdoc-check einschalten

    if ENABLE_GTK_DOC
    TESTS_ENVIRONMENT = \
      DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
      SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
    TESTS = $(GTKDOC_CHECK)
    endif

### GTK-Doc 1.20

In Version 1.18 wurde erstmals Unterstützung für Markdown eingeführt. Die Verwendung von Markdown in Dokumentationskommentaren ist weniger aufwändig als das Schreiben von DocBook XML. Diese Version bringt diesbezüglich wesentliche Verbesserungen und fügt zahlreiche weitere Stile hinzu. Alle Details hierzu finden Sie im Abschnitt zur Kommentarsyntax.

### GTK-Doc 1.25

Die in dieser Version enthaltenen Make-Steuerdateien erzeugen die Entitätsdatei `xml/gtkdocentities.ent`, die Entitäten für beispielsweise package_name und package_version enthält. Sie können diese in der XML-Hauptdatei verwenden, um eine fest codierte Versionsnummer zu vermeiden. Nachfolgend finden Sie ein Beispiel, wie die Entitätsdatei einbezogen wird und und wie die Einträge verwendet werden. Die Entitäten können auch in allen generierten Dateien verwendet werden. GTK-Doc verwendet die gleichen XML-Kopfeinträge auch in generierten Dateien.

Vorerzeugte Entitäten verwenden

    <?xml version="1.0"?>
    <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
    [
      <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
      <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
      %gtkdocentities;
    ]>
    <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
      <bookinfo>
        <title>&package_name; Reference Manual</title>
        <releaseinfo>
          for &package_string;.
          The latest version of this documentation can be found on-line at
          <ulink role="online-location" url="http://[SERVER]/&package_name;/index.html">http://[SERVER]/&package_name;/</ulink>.
        </releaseinfo>
      </bookinfo>

## Dokumentieren anderer Schnittstellen

Bis jetzt haben wir GTK-Doc nur dazu verwendet, die API des Codes zu dokumentieren. In den nächsten Abschnitten finden Sie Vorschläge, wie die Werkzeuge zum Dokumentieren anderer Schnittstellen eingesetzt werden können.

### Befehlszeilenoptionen und Handbuchseiten

Weil man ebenso man-Hilfeseiten für einen docbook-Referenzeintrag erstellen kann, klingt es nach einer guten Idee, es für diesen Zweck einzusetzen. Auf diese Weise ist die Schnittstelle Teil der Referenz und man erhält kostenfrei die man-Hilfeseite.

#### Dokumentieren des Werkzeuges

Erstellen Sie eine Referenzeintragsdatei pro Werkzeug. In unserem Beispiel nennen wir sie `meep/docs/reference/meeper/meep.xml`. Für die zu verwendenden XML-Markierungen können Sie die generierte Datei im XML-Unterordner oder Beispiele (z.B. in glib) ansehen.

#### Hinzufügen der zusätzlichen Configure-Überprüfungen

Zusätzliche Configure-Überprüfungen

    AC_ARG_ENABLE(man,
                  [AC_HELP_STRING([--enable-man],
                                  [regenerate man pages from Docbook [default=no]])],enable_man=yes,
                  enable_man=no)

    AC_PATH_PROG([XSLTPROC], [xsltproc])
    AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)

#### Hinzufügen der zusätzlichen Makefile-Regeln

Zusätzliche Configure-Überprüfungen

    man_MANS = \
           meeper.1

    if ENABLE_GTK_DOC
    if ENABLE_MAN

    %.1 : %.xml
            @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<

    endif
    endif

    BUILT_EXTRA_DIST = $(man_MANS)
    EXTRA_DIST += meep.xml

### DBus-Schnittstellen

(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)

## Häufig gestellte Fragen

Frage Antwort
- Keine Klassenhierarchie. Die `xxx_get_type()`-Funktion des Objekts wurde nicht in die Datei `<package>.types` eingegeben.
- Noch immer keine Klassenhierarchie. Fehlende oder falsche Benennung in der Datei `<Paket>-sections.txt` (lesen Sie die Erklärung).
- Verdammt, ich habe immer noch keine Klassenhierarchie. Ist der Objektname (Name des Instanz-struct, z.B. GtkWidget) Teil des normalen Abschnitts (nicht in den Standard- oder Unterabschnitten).
- Kein Symbolindex. Enthält `<package>-docs.{xml,sgml}` einen Index, der den erstellten Index xi:enthält?
- Symbole werden nicht mit deren Dokumentationsabschnitt verknüpft. Verwendet das doc-comment das richtige Markup (hinzugefügtes »#«,»%« oder »()«)? Prüfen Sie, ob gtkdoc-fixxref wegen nicht auflösbarer xrefs warnt.
- Eine neue Klasse erscheint nicht in der Dokumentation. Ist die neue Seite xi:eingebunden von `<package>-docs.{xml,sgml}`?
- Ein neues Symbol erscheint nicht in der Dokumentation. Ist doc-comment ordnungsgemäß formatiert? Prüfen Sie den Anfang des Dokuments auf Rechtschreibfehler im Kommentar. Prüfen Sie, ob gtkdoc-fixxref wegen unauflösbarer xrefs warnt. Prüfen Sie, ob das Symbol richtig in `<package>-sections.txt` in einem öffentlichen Abschnitt gelistet ist.
- Ein Typ fehlt in der Klassenhierarchie. Wenn der Typ in `<package>.hierarchy` gelistet ist, aber nicht in `xml/tree_index.sgml`, dann prüfen Sie sorgfältig, ob der Typ ordnungsgemäß in `<package>-sections.txt` abgelegt ist. Falls die Typ-Instanz (z.B. GtkWidget) nicht aufgelistet oder versehentlich als privat markiert ist, so wird sie nicht angezeigt.
- Ich erhalte foldoc-Verweise für alle gobjekt-Anmerkungen. Prüfen Sie, ob `xml/annotation-glossary.xml` von `<package>-docs.{xml,sgml}` xi:eingebunden ist.
- Parameter wird im Kommentarblock des Quellcodes beschrieben, aber existiert nicht Überprüfen Sie, ob die Parameternamen der Prototypen in der Quelle und im Header unterschiedlich sind.
- Mehrfache »IDs« für »constraint linkend: XYZ« Das Symbol XYZ erscheint zweifach in der Datei `<package>-sections.txt`.
- Element-Typname im Namensraum '' in einem Abschnitt, der keiner Vorlage entspricht.

## Werkzeuge mit Bezug zu gtk-doc

GtkDocPlugin - ein Trac GTK-Doc Integrations-Plugin, das API-Dokumente zu einer trac-Seite hinzufügt und die trac-Suche einbindet.

Gtkdoc-depscan - ein Werkzeug (Teil von gtk-doc), um die verwendete API für die minimal erforderliche Version zu prüfen.

Version 1.1, März 2000
2000 Free Software Foundation, Inc.

    Free Software Foundation, Inc. 51 Franklin Street,
            Suite 330, Boston, MA
            02110-1301  USA

. Es ist jedermann erlaubt, wortwörtliche Kopien dieses Lizenzdokuments zu erstellen und zu verbreiten, Änderungen sind jedoch nicht zulässig. Dies ist eine inoffizielle Übersetzung der GNU Free Documentation License (GFDL), Version 1.1, ins Deutsche. Sie wurde nicht von der Free Software Foundation veröffentlicht, und legt nicht gesetzlich die Verteilungsbedingungen für Dokumente fest, die die GFDL nutzen -- nur der originale englische Text der GFDL tut dies. Wie auch immer, ich hoffe, dass sie Deutschsprachigen hilft, die GFDL besser zu verstehen. Dieser Text wurde von der spanischen Version übertragen.

## GNU Freie Dokumentationslizenz

### 0. VORWORT

The purpose of this License is to make a manual, textbook, or other written document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of copyleft, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

Wir haben diese Lizenz gestaltet, um sie für Anleitungen von freier Software zu benutzen, weil freie Software freie Dokumentation benötigt: Ein freies Programm sollte mit Anleitungen kommen, die dieselbe Freiheit wie die Software bieten. Aber diese Lizenz ist nicht auf Software-Anleitungen beschränkt; sie kann für alle textlichen Arbeiten verwendet werden, unabhängig vom Thema, oder ob es als gedrucktes Buch veröffentlicht wird. Wir empfehlen diese Lizenz prinzipiell für Arbeiten, deren Zweck Anleitungen oder Referenzen sind.

### 1. ANWENDBARKEIT UND DEFINITIONEN

This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The Document, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as you.

A Modified Version of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A Secondary Section is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (For example, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The Invariant Sections are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License.

The Cover Texts are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License.

A Transparent copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup has been designed to thwart or discourage subsequent modification by readers is not Transparent. A copy that is not Transparent is called Opaque.

Beispiele von passenden Formaten für Transparente Kopien enthalten reines ASCII ohne Codierung, das Texinfo-Eingabeformat, das LaTeX-Eingabeformat, SGML oder XML die eine öffentlich zugängliche DTD nutzen, und dem Standard entsprechendes HTML, das für die Veränderung durch Menschen gestaltet wurde. Undurchsichtige Formate enthalten PostScript, PDF, proprietäre Formate die nur von proprietären Textverarbeitungen gelesen und bearbeitet werden, SGML oder XML für die die DTD und/oder die Verarbeitungswerkzeuge nicht allgemein erhältlich sind, und maschinengeneriertes HTML, das von einigen Textverarbeitungen nur zu Ausgabezwecken produziert wurde.

The Title Page means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, Title Page means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

### 3. WORTWÖRTLICHE KOPIEN

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

Sie dürfen auch Kopien unter den oben genannten Bedingungen verleihen, und Sie dürfen Kopien öffentlich zeigen.

### 3. KOPIEREN IN MENGEN

If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

Wenn die geforderten Texte für jede Seite zu groß sind, um leserlich darauf zu passen, sollten Sie die erstgenannten (so viele wie vernünftig darauf passen) auf die aktuelle Seite setzen, und mit dem Rest auf angrenzenden Seiten fortfahren.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

### 4. MODIFIKATIONEN

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

- A

  Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

- B

  List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has less than five).

- C

  State on the Title Page the name of the publisher of the Modified Version, as the publisher.

- D

  Preserve all the copyright notices of the Document.

- E

  Einen passenden Copyright-Hinweis für Ihre Modifikationen angrenzend an die anderen Copyright-Hinweise hinzufügen.

- F

  Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

- G

  Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

- H

  Eine unveränderte Kopie dieser Lizenz einfügen.

- I

  Preserve the section entitled History, and its title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section entitled History in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

- J

  Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the History section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

- K

  In any section entitled Acknowledgements or Dedications, preserve the section's title, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

- L

  Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

- M

  Delete any section entitled Endorsements. Such a section may not be included in the Modified Version.

- N

  Do not retitle any existing section as Endorsements or to conflict in title with any Invariant Section.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section entitled Endorsements, provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version .

### 5. DOKUMENTE KOMBINIEREN

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections entitled History in the various original documents, forming one section entitled History; likewise combine any sections entitled Acknowledgements, and any sections entitled Dedications. You must delete all sections entitled Endorsements.

### 6. SAMMLUNGEN VON DOKUMENTEN

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

Sie dürfen ein einzelnes Dokument aus einer solchen Sammlung heraustrennen, und es individuell unter dieser Lizenz verteilen, vorausgesetzt, Sie fügen eine Kopie dieser Lizenz in das herausgetrennte Dokument ein und folgen der Lizenz in jeglicher Hinsicht bezüglich dem wortwörtlichen Kopieren des Dokuments.

### 7. AGGREGATION MIT UNABHÄNGIGEN ARBEITEN

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an aggregate, and this License does not apply to the other self-contained works thus compiled with the Document , on account of their being thus compiled, if they are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.

### 8. ÜBERSETZUNG

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.

### 9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

### 10. ZUKÜNFTIGE REVISIONEN DIESER LIZENZ

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License or any later version applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

### Anhang

Um diese Lizenz in einem von Ihnen geschriebenen Dokument nutzen zu können, fügen Sie eine Kopie der Lizenz in das Dokument ein und setzen Sie die folgenden Copyright- und Lizenzhinweise gleich hinter die Titelseite:

> Copyright (c) JAHR IHR NAME.

> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled GNU Free Documentation License.

If you have no Invariant Sections, write with no Invariant Sections instead of saying which ones are invariant. If you have no Front-Cover Texts, write no Front-Cover Texts instead of Front-Cover Texts being LIST; likewise for Back-Cover Texts.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.