# German translation of the gtk-doc manual. # # Mario Blättermann , 2009-2010, 2012-2013, 2016, 2018, 2021. # Wolfgang Stöggl , 2015. # Christian Kirbach , 2013, 2015, 2018. # Jürgen Benvenuti , 2024. # msgid "" msgstr "" "Project-Id-Version: gtk-doc help master\n" "POT-Creation-Date: 2024-04-01 18:02+0000\n" "PO-Revision-Date: 2024-04-08 21:20+0200\n" "Last-Translator: Christian Kirbach \n" "Language-Team: German \n" "Language: de\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Plural-Forms: nplurals=2; plural=(n != 1);\n" "X-Generator: Poedit 3.4.2\n" #. Put one translator per line, in the form NAME , YEAR1, YEAR2 msgctxt "_" msgid "translator-credits" msgstr "" "Mario Blättermann , 2009-2013, 2016, 2018, " "2021\n" "Christian Kirbach , 2013, 2015-2024\n" "Jürgen Benvenuti , 2024" #. (itstool) path: bookinfo/title #: C/index.docbook:12 msgid "GTK-Doc Manual" msgstr "GTK-Doc-Handbuch" #. (itstool) path: bookinfo/edition #: C/index.docbook:13 msgid "1.24.1" msgstr "1.24.1" #. (itstool) path: abstract/para #: C/index.docbook:14 msgid "User manual for developers with instructions of GTK-Doc usage." msgstr "" "Benutzerhandbuch für Entwickler mit Anweisungen für die Benutzung von GTK-" "Doc." #. (itstool) path: authorgroup/author #: C/index.docbook:16 msgid "" "Chris Lyttle " "
chris@wilddev.net
" msgstr "" "Chris Lyttle " "
chris@wilddev.net
" #. (itstool) path: authorgroup/author #: C/index.docbook:25 msgid "" "Dan Mueth
" "d-mueth@uchicago.edu
" msgstr "" "Dan Mueth
" "d-mueth@uchicago.edu
" #. (itstool) path: authorgroup/author #: C/index.docbook:34 msgid "" "Stefan Sauer (Kost) " "
ensonic@users.sf.net
" msgstr "" "Stefan Sauer (Kost) " "
ensonic@users.sf.net
" #. (itstool) path: publisher/publishername #: C/index.docbook:45 msgid "GTK-Doc project" msgstr "GTK-Doc-Projekt" #. (itstool) path: bookinfo/publisher #: C/index.docbook:44 msgid "" "<_:publishername-1/>
gtk-doc-list@gnome.org
" msgstr "" "<_:publishername-1/>
gtk-doc-list@gnome.org
" #. (itstool) path: bookinfo/copyright #: C/index.docbook:48 msgid "2000, 2005 Dan Mueth and Chris Lyttle" msgstr "2000, 2005 Dan Mueth und Chris Lyttle" #. (itstool) path: bookinfo/copyright #: C/index.docbook:52 msgid "2007-2019 Stefan Sauer (Kost)" msgstr "2007-2019 Stefan Sauer (Kost)" #. (itstool) path: legalnotice/para #: C/index.docbook:65 msgid "" "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 no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A " "copy of the license is included." msgstr "" "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." #. (itstool) path: legalnotice/para #: C/index.docbook:73 msgid "" "Many of the names used by companies to distinguish their products and " "services are claimed as trademarks. Where those names appear in any GNOME " "documentation, and those trademarks are made aware to the members of the " "GNOME Documentation Project, the names have been printed in caps or initial " "caps." msgstr "" "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." #. (itstool) path: revhistory/revision #: C/index.docbook:83 msgid "" "1.33.0 1 Oct 2020 mc gtk4 version" msgstr "" "1.33.0 1. Oktober 2020 " "mc Gtk4-Version" #. (itstool) path: revhistory/revision #: C/index.docbook:89 msgid "" "1.32.1 15 Aug 2019 ss dev version" msgstr "" "1.32.1 15. August 2019 " "ss Entwicklerversion" #. (itstool) path: revhistory/revision #: C/index.docbook:95 msgid "" "1.32 15 Aug 2019 ss hotfix release" msgstr "" "1.32 15. August 2019 ss Korrekturveröffentlichung" #. (itstool) path: revhistory/revision #: C/index.docbook:101 msgid "" "1.31 05 Aug 2019 ss refactorings and more test coverage" msgstr "" "1.31 05. August 2019 ss Größere Umbauten und weitere Tests" #. (itstool) path: revhistory/revision #: C/index.docbook:107 msgid "" "1.30 08 May 2019 ss more test coverage" msgstr "" "1.30 08. Mai 2019 ss Weitere Tests" #. (itstool) path: revhistory/revision #: C/index.docbook:113 msgid "" "1.29 28 Aug 2018 ss bug fixes" msgstr "" "1.29 28. August 2018 ss Fehlerbehebungen" #. (itstool) path: revhistory/revision #: C/index.docbook:119 msgid "" "1.28 24 Mar 2018 ss bug fixes" msgstr "" "1.28 24. März 2018 ss Fehlerbehebungen" #. (itstool) path: revhistory/revision #: C/index.docbook:125 msgid "" "1.27 07 Dec 2017 ss fine tuning of the python port" msgstr "" "1.27 07. Dezember 2017> " "ss Detailanpassungen der Python-" "Portierung" #. (itstool) path: revhistory/revision #: C/index.docbook:131 msgid "" "1.26 11 Aug 2017 ss port all tools from perl/bash to python" msgstr "" "1.26.1 11. August 2017 " "ss Alle Werkzeuge von Perl/Bash " "nach Python portiert" #. (itstool) path: revhistory/revision #: C/index.docbook:137 msgid "" "1.25 21 March 2016 ss bug fixes, test cleanups" msgstr "" "1.25 21. März 2015 ss Fehlerbehebungen, Test-Cleanups" #. (itstool) path: revhistory/revision #: C/index.docbook:143 msgid "" "1.24 29 May 2015 ss bug fix" msgstr "" "1.24 29. Mai 2015 ss Fehlerbehebungen" #. (itstool) path: revhistory/revision #: C/index.docbook:149 msgid "" "1.23 17 May 2015 ss bug fix" msgstr "" "1.23 17. Mai 2015 ss Fehlerbehebungen" #. (itstool) path: revhistory/revision #: C/index.docbook:155 msgid "" "1.22 07 May 2015 ss bug fixes, dropping deprecated features" msgstr "" "1.22 7. Mai 2015 ss Fehlerbehebungen, veraltete Funktionen verworfen" #. (itstool) path: revhistory/revision #: C/index.docbook:161 msgid "" "1.21 17 Jul 2014 ss bug fixes, dropping deprecated features" msgstr "" "1.21 17. Juli 2014 ss Fehlerbehebungen, veraltete Funktionen verworfen" #. (itstool) path: revhistory/revision #: C/index.docbook:167 msgid "" "1.20 16 Feb 2014 ss bug fixes, markdown support, style improvements" msgstr "" "1.20 16. Februar 2014 " "ss Fehlerberhebungen, " "Unterstützung für Markdown, Layoutverbesserungen" #. (itstool) path: revhistory/revision #: C/index.docbook:173 msgid "" "1.19 05 Jun 2013 ss bug fixes" msgstr "" "1.19 05. Juni 2013 ss Fehlerbehebungen" #. (itstool) path: revhistory/revision #: C/index.docbook:179 msgid "" "1.18 14 Sep 2011 ss bug fixes, speedups, markdown support" msgstr "" "1.18 14. September 2011 " "ss Fehlerbehebungen, Verbesserte " "Geschwindigkeit, Unterstützung für markdown" #. (itstool) path: revhistory/revision #: C/index.docbook:185 msgid "" "1.17 26 Feb 2011 sk urgent bug fix update" msgstr "" "1.17 26. Februar 2011 " "sk Dringende Bugfix-" "Aktualisierung" #. (itstool) path: revhistory/revision #: C/index.docbook:191 msgid "" "1.16 14 Jan 2011 sk bugfixes, layout improvements" msgstr "" "1.16 14. Januar 2011 sk Bugfixes, Layoutverbesserungen" #. (itstool) path: revhistory/revision #: C/index.docbook:197 msgid "" "1.15 21 May 2010 sk bug and regression fixes" msgstr "" "1.15 21. Mai 2010 sk Bug- und Regressionsfixes" #. (itstool) path: revhistory/revision #: C/index.docbook:203 msgid "" "1.14 28 March 2010 sk bugfixes and performance improvements" msgstr "" "1.14 28. März 2010 sk Bugfixes und Leistungsverbesserungen" #. (itstool) path: revhistory/revision #: C/index.docbook:209 msgid "" "1.13 18 December 2009 " "sk broken tarball update" msgstr "" "1.13 18. Dezember 2009 " "sk Aktualisierung eines " "beschädigten Tarballs" #. (itstool) path: revhistory/revision #: C/index.docbook:215 msgid "" "1.12 18 December 2009 " "sk new tool features and " "bugfixes" msgstr "" "1.12 18. Dezember 2009 " "sk Neue Features und Bugfixes" #. (itstool) path: revhistory/revision #: C/index.docbook:221 msgid "" "1.11 16 November 2008 " "mal GNOME doc-utils migration" msgstr "" "1.11 16. November 2008 " "mal Migration auf die GNOME doc-" "utils" #. (itstool) path: chapter/title #: C/index.docbook:234 msgid "Introduction" msgstr "Einführung" #. (itstool) path: chapter/para #: C/index.docbook:236 msgid "" "This chapter introduces GTK-Doc and gives an overview of what it is and how " "it is used." msgstr "" "Dieses Kapitel führt in GTK-Doc ein und gibt einen Überblick darüber, worum " "es sich dabei handelt und wie es benutzt wird." #. (itstool) path: sect1/title #: C/index.docbook:242 msgid "What is GTK-Doc?" msgstr "Was ist GTK-Doc?" #. (itstool) path: sect1/para #: C/index.docbook:244 msgid "" "GTK-Doc is used to document C code. It is typically used to document the " "public API of libraries, such as the GTK+ and GNOME libraries. But it can " "also be used to document application code." msgstr "" "GTL-Doc wird zur Dokumentation von C-Code verwendet. Üblicherweise wird " "damit die öffentliche API von Bibliotheken dokumentiert, wie die der GTK+- " "und GNOME-Bibliotheken. Es kann aber auch zur Dokumentation von " "Anwendungscode verwendet werden." #. (itstool) path: sect1/title #: C/index.docbook:252 msgid "How Does GTK-Doc Work?" msgstr "Wie funktioniert GTK-Doc?" #. (itstool) path: sect1/para #: C/index.docbook:254 msgid "" "GTK-Doc works by using documentation of functions placed inside the source " "files in specially-formatted comment blocks, or documentation added to the " "template files which GTK-Doc uses (though note that GTK-Doc will only " "document functions that are declared in header files; it won't produce " "output for static functions)." msgstr "" "GTK-Doc verwendet Funktionsdokumentationen, die sich in den Quelldateien " "innerhalb speziell formatierter Kommentarblöcke befinden, oder " "Dokumentation, die zu den von GTK-Doc verwendeten Vorlagendateien " "hinzugefügt wurde. Beachten Sie jedoch, dass GTK-Doc nur Funktionen " "dokumentieren wird, die in den Header-Dateien deklariert sind. Es erstellt " "keine Ausgaben für statische Funktionen." #. (itstool) path: sect1/para #: C/index.docbook:261 msgid "" "GTK-Doc consists of a number of python scripts, each performing a different " "step in the process." msgstr "" "GTK-Doc besteht aus einer Anzahl von Python-Skripten, wovon jedes einen " "bestimmten Schritt in dem Prozess ausführt." #. (itstool) path: sect1/para #: C/index.docbook:266 msgid "There are 5 main steps in the process:" msgstr "Dieser Vorgang umfasst fünf Hauptschritte:" #. (itstool) path: listitem/para #: C/index.docbook:273 msgid "" "Writing the documentation. The author fills in the " "source files with the documentation for each function, macro, structs or " "unions, etc." msgstr "" "Schreiben der Dokumentation. Der Autor ergänzt die " "Quelldateien um die Dokumentation für jede Funktion, jedes Makro usw." #. (itstool) path: listitem/para #: C/index.docbook:282 msgid "" "Gathering information about the code. " "gtkdoc-scan scans the header files of the code " "looking for declarations of functions, macros, enums, structs, and unions. " "It creates the file <module>-decl-list.txt " "containing a list of the declarations, placing them into sections according " "to which header file they are in. On the first run this file is copied to " "<module>-sections.txt. The author can rearrange " "the sections, and the order of the declarations within them, to produce the " "final desired order. The second file it generates is <" "module>-decl.txt. This file contains the full declarations " "found by the scanner. If for some reason one would like some symbols to show " "up in the docs, where the full declaration cannot be found by the scanner or " "the declaration should appear differently, one can place entities similar to " "the ones in <module>-decl.txt into <" "module>-overrides.txt." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:299 msgid "" "gtkdoc-scangobj can also be used to dynamically " "query a library about any GObject subclasses it exports. It saves " "information about each object's position in the class hierarchy and about " "any GObject properties and signals it provides." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:305 msgid "" "gtkdoc-scanobj should not be used anymore. It was " "needed in the past when GObject was still GtkObject inside gtk+." msgstr "" "gtkdoc-scanobj sollte nicht weiter verwendet " "werden. Es war in der Vergangenheit notwendig, als GObject noch ein " "GtkObject innerhalb von gtk+ war." #. (itstool) path: listitem/para #: C/index.docbook:312 msgid "" "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 on functions, 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." msgstr "" "Erstellen des SGML/XML und HTML/PDF. " "gtkdoc-mkdb wandelt die Vorlagen-Dateien in XML-" "Dateien in den Unterordner xml/ um. " "Wenn der Quellcode Dokumentation über Funktionen mittels speziellen " "Kommentarblöcken enthält, so wird diese hier eingepflegt. Wenn keine tmpl-" "Dateien eingesetzt werden, so wird nur Dokumentation von den Quell- und " "introspection-Daten gelesen." #. (itstool) path: listitem/para #: C/index.docbook:321 msgid "" "gtkdoc-mkhtml turns the XML files into HTML files " "in the html/ subdirectory. Likewise " "gtkdoc-mkpdf turns the XML files into a PDF " "document called <package>.pdf." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:327 msgid "" "Files in xml/ and html/ directories are always overwritten. One " "should never edit them directly." msgstr "" "Dateien in xml/ und html/-Ordnern werden immer überschrieben. " "Niemand sollte diese direkt bearbeiten." #. (itstool) path: listitem/para #: C/index.docbook:335 msgid "" "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)." msgstr "" "Querverweise zwischen Dokumenten korrigieren. Nach " "Intallation der HTML-Dateien kann gtkdoc-fixxref " "ausgeführt werden, um alle Querverweise zwischen separaten Dokumenten zu " "korrigieren. Die GTK+-Dokumentation zum Beispiel enthält viele Querverweise " "zu Typen, die im GLib-Handbuch dokumentiert sind. Beim Erstellen des Quellen-" "tarball zur Verteilung wandelt gtkdoc-rebase alle " "externen Verweise in Web-Verweise um. Beim Installieren verteilter (zuvor " "erstellter) Dokumente wird dieselbe Anwendung versuchen, Verweise zurück in " "lokale Verweise umzuwandeln (wo diese Dokumente installiert werden)." #. (itstool) path: sect1/title #: C/index.docbook:353 msgid "Getting GTK-Doc" msgstr "GTK-Doc bekommen" #. (itstool) path: sect2/title #: C/index.docbook:356 msgid "Requirements" msgstr "Erfordernisse" #. (itstool) path: sect2/para #: C/index.docbook:357 msgid "" "python 2/3 - the main scripts are written in python." msgstr "" "Python 2/3 - Die Hauptskripte wurden in Python " "geschrieben." #. (itstool) path: sect2/para #: C/index.docbook:360 msgid "" "xsltproc - the xslt processor from libxslt xmlsoft.org/XSLT/" msgstr "" "xsltproc - der xslt-Verarbeiter von libxslt xmlsoft.org/XSLT/" #. (itstool) path: sect2/para #: C/index.docbook:364 msgid "" "docbook-xsl - the docbook xsl stylesheets sourceforge.net/projects/docbook/files/docbook-xsl" msgstr "" "docbook-xsl - die docbook xsl-Stilvorlagen sourceforge.net/projects/docbook/files/docbook-xsl" #. (itstool) path: sect2/para #: C/index.docbook:368 msgid "" "One of source-highlight, highlight " "or vim - optional - used for syntax highlighting of " "examples" msgstr "" "source-highlight, highlight oder " "vim - optional - für Syntax-Hervorhebung von Beispielen" #. (itstool) path: sect1/title #: C/index.docbook:376 msgid "About GTK-Doc" msgstr "Info zu GTK-Doc" #. (itstool) path: sect1/para #: C/index.docbook:378 msgid "" "Historically GTK-Doc was used to generate template files from the sources " "code. These template files could be used by developers to enter the API " "documentation. This approach was rather inconvenient because it required to " "keep the generated files under version control. Since GTK-Doc 1.9 it became " "possible to place all API information into source comments, which made the " "template support obsolete. In version 1.26 template support has been removed." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:388 C/index.docbook:402 msgid "(FIXME)" msgstr "(FIXME)" #. (itstool) path: sect1/para #: C/index.docbook:392 msgid "" "(authors, web pages, mailing list, license, future plans, comparison with " "other similar systems.)" msgstr "" "(Autoren, Webseiten, Mailingliste, Lizenz, Zukunftspläne, Vergleich mit " "ähnlichen Systemen)" #. (itstool) path: sect1/title #: C/index.docbook:400 msgid "About this Manual" msgstr "Über dieses Handbuch" #. (itstool) path: sect1/para #: C/index.docbook:406 msgid "(who it is meant for, where you can get it, license)" msgstr "(wofür es bestimmt ist, wo Sie es erhalten können, Lizenz)" #. (itstool) path: chapter/title #: C/index.docbook:415 msgid "Project Setup" msgstr "Einrichtung in einem Projekt" #. (itstool) path: chapter/para #: C/index.docbook:417 msgid "" "This Chapter describes the steps that are necessary to integrate GTK-Doc " "into your project. The integration of GTK-Doc into a project includes the " "following steps:" msgstr "" "Dieses Kapitel beschreibt die notwendigen Schritte, um GTK-Doc in Ihr " "Projekt zu integrieren. Im einzelnen sind dies folgende Schritte:" #. (itstool) path: listitem/para #: C/index.docbook:425 msgid "" "Preparation of the directory structure and creating required configuration " "files for your GTK-Doc documentation (see Setting up a skeleton documentation)." msgstr "" "Vorbereitung der Ordnerstruktur und Erstellung der erforderlichen " "Konfigurationsdateien für Ihre GTK-Doc-Dokumentation (siehe Einrichten des Grundgerüsts der " "Dokumentation)." #. (itstool) path: listitem/para #: C/index.docbook:433 msgid "" "Adjusting the build system to build your documentation using the GTK-Doc " "tools. Multiple build systems are supported, in this manual we describe how " "to integrate GTK-Doc with Autotools, CMake, and plain Makefiles." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:443 msgid "" "Adding GTK-Doc specific files to version control and deciding which files to " "ignore (see Integration with version " "control systems)." msgstr "" "Hinzufügen GTK-Doc-spezifischer Dateien zur Versionsverwaltung, wobei zu " "entscheiden ist, welche Dateien ignoriert werden sollen (siehe Integration in Versionsverwaltungssysteme)." #. (itstool) path: chapter/para #: C/index.docbook:451 msgid "" "The following sections assume we work on a project called meep. " "This project contains two packages (or modules), a library called " "libmeep and an end-user app called meeper." msgstr "" "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." #. (itstool) path: sect1/title #: C/index.docbook:460 msgid "Setting up a skeleton documentation" msgstr "Einrichten des Grundgerüsts der Dokumentation" #. (itstool) path: sect1/para #: C/index.docbook:462 msgid "" "A common convention is to place documentation into a folder called " "docs inside your top-level project directory. We usually " "distinguish between reference documentation intended " "for developers and an user manual intended for end-" "users. Again the convention is to have separate folders for both. We usually " "place the reference documentation in a folder named reference " "and the end-user manual in a folder named help as. According to " "the above convention the documentation for our libmeep package " "would be placed into: docs/reference/libmeep. For packages with " "just one library or application the documentation could also be placed " "directly into docs/reference. It is not mandatory to use the " "above convention, but if you choose to use a different directory structure " "you must adjust your build system configuration to match your directory " "structure." msgstr "" "Ü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." #. (itstool) path: example/title #: C/index.docbook:493 msgid "Example directory structure of meep project" msgstr "Beispielhafte Ordnerstruktur des meep-Projekts" #. (itstool) path: example/programlisting #: C/index.docbook:495 #, no-wrap msgid "" "\n" "meep/\n" " docs/\n" " reference/ # reference documentation\n" " libmeep/\n" " meeper/\n" " help/ # optional: user manual\n" " meeper/\n" " src/\n" " libmeep/\n" " meeper/\n" msgstr "" "\n" "meep/\n" " docs/\n" " reference/ # reference documentation\n" " libmeep/\n" " meeper/\n" " help/ # optional: user manual\n" " meeper/\n" " src/\n" " libmeep/\n" " meeper/\n" #. (itstool) path: sect1/para #: C/index.docbook:487 msgid "" "In the following sections we will assume a directory structure for our " "meep project that uses the above conventions. <_:" "example-1/>" msgstr "" "In den folgenden Abschnitten gehen wir für unser meep-" "Projekt von einer Ordnerstruktur aus, die die oben genannten Konventionen " "berücksichtigt. <_:example-1/>" #. (itstool) path: sect1/title #: C/index.docbook:512 msgid "Integration with Autotools" msgstr "Integration in Autotools" #. (itstool) path: sect1/para #: C/index.docbook:513 msgid "" "Integration of GTK-Doc into an autotools-based build system requires the " "following steps:" msgstr "" "Für die Integration von GTK-Doc in ein Autotools-basiertes Projekt sind die " "folgenden Schritte auszuführen:" #. (itstool) path: listitem/para #: C/index.docbook:519 msgid "" "Ensure that gtkdocize is run once before the " "configure script. If an autogen.sh " "script is present, adjust it to check for GTK-Doc and add a call to " "gtkdocize." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:527 msgid "" "The main purpose of gtkdocize is to make the " "gtk-doc.make Makefile and the gtk-doc.m4 macro definition file available to the build system, either by " "copying or linking it into the project." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:536 msgid "" "Add the necessary autoconf macros to " "configure.ac to enable GTK-Doc in your build system to " "allow configuration of GTK-Doc via the generated configure script." msgstr "" "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." # Das hier verstehe ich nicht so recht... # CK: Das Original ist kein richtiges Englisch. #. (itstool) path: listitem/para #: C/index.docbook:542 msgid "" "Among others with registers the --enable-gtk-doc option with " "the configure script." msgstr "" "Unter anderem wird die Option --enable-gtk-doc mit dem " "configure-Skript registriert." #. (itstool) path: listitem/para #: C/index.docbook:548 msgid "" "Create an automake script for each application or " "library in your project. In the example used in this documentation this step " "applies to both meeper and libmeep." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:557 msgid "" "In the following sections, we will perform the above steps in reverse order. " "We start with the automake scripts and work our " "way up to configure.ac and autogen.sh. Then we show how enable Gtk-Doc in the build system and how to " "build the documentation." msgstr "" "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." #. (itstool) path: sect2/title #: C/index.docbook:567 msgid "Integration with automake" msgstr "Integration in automake" #. (itstool) path: sect2/para #: C/index.docbook:569 msgid "" "First copy the Makefile.am from the examples sub-directory of the gtkdoc-sources to your project's reference documentation " "directory (e.g. docs/reference/<package>" "). A local copy should be available under e.g. /usr/" "share/doc/gtk-doc-tools/examples/Makefile.am. If you have " "multiple packages repeat this for each one." msgstr "" "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." #. (itstool) path: note/simpara #: C/index.docbook:582 msgid "" "Do not forget to add each Makefile.am to the " "AC_CONFIG_FILES macro in configure.ac. For docs/reference/libmeep/Makefile.am you " "will need to add the entry docs/reference/libmeep/Makefile to AC_CONFIG_FILES." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:594 msgid "Example directory structure with Makefiles.am" msgstr "Beispielhafte Ordnerstruktur mit Makefiles.am" #. (itstool) path: example/programlisting #: C/index.docbook:597 #, no-wrap msgid "" "\n" "meep/\n" " docs/\n" " reference/ # reference documentation\n" " libmeep/\n" " Makefile.am\n" " meeper/\n" " Makefile.am\n" " help/ # optional: user manual\n" " meeper/\n" " src/\n" " libmeep/\n" " meeper/\n" msgstr "" "\n" "meep/\n" " docs/\n" " reference/ # reference documentation\n" " libmeep/\n" " Makefile.am\n" " meeper/\n" " Makefile.am\n" " help/ # optional: user manual\n" " meeper/\n" " src/\n" " libmeep/\n" " meeper/\n" #. (itstool) path: sect2/para #: C/index.docbook:613 msgid "" "Next, you need to customize the copied Makefiles and provide values for the " "various parameters in each Makefile.am. All settings " "have a comment above them that describes their purpose and how to customize " "the setting. Most settings are used to supply extra flags to the respective " "tools to which they apply. Every tool has a variable of the form (e.g. the tool gtkdoc-mkhtml has an option named MKHTML_OPTIONS). All the tools " "support to list the supported options." msgstr "" "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 . Alle " "Werkzeuge unterstützen zur Auflistung der " "unterstützten Parameter." #. (itstool) path: listitem/para #: C/index.docbook:637 msgid "" " is used to provide the name of the package that " "is being documentated (e.g. meeper, or libmeep)." msgstr "" " stellt den Namen des Pakets bereit, das " "dokumentiert werden soll (z.B. meeper oder libmeep)." #. (itstool) path: listitem/para #: C/index.docbook:644 msgid "" " is used to specify the location of source " "directory which GTK-Doc searches for your API documentation. This will " "usually be DOC_SOURCE_DIR=$(top_srcdir)/src or a sub-" "directory of that directory." msgstr "" " 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." #. (itstool) path: listitem/para #: C/index.docbook:657 msgid "" " and are used for " "dependencies. Each option take a file-glob (e.g. " "HFILE_GLOB=$(top_srcdir)/src/*.c). The documentation will be " "rebuilt if any of the matched files change." msgstr "" " und 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." #. (itstool) path: listitem/para #: C/index.docbook:669 msgid "" " allows to specify extra header files to " "include when scanning for API documentation, which are not found under " "DOC_SOURCE_DIR (e.g. EXTRA_HFILES=$(top_srcdir}/contrib/" "extra.h)." msgstr "" "Mit 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)." #. (itstool) path: listitem/para #: C/index.docbook:679 msgid "" " allows to specify header files or directories " "to ignore when scanning for API documentation. Use the basename of the file " "or directory (e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h " "private_code_folder)." msgstr "" "Mit 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)." #. (itstool) path: listitem/para #: C/index.docbook:689 msgid "" " allows to specify images files which will be " "copied into the html/ directory of the generated " "documentation. If your API documentation includes any images they need to be " "added to this option (e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/" "stock_about_24.png)." msgstr "" "In 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)." #. (itstool) path: listitem/para #: C/index.docbook:702 msgid "" " allows to specify extra files that are " "included by $(DOC_MAIN_SGML_FILE) (e.g. " "content_files=running.xml building.xml changes-2.0.xml)." msgstr "" "In 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)." #. (itstool) path: listitem/para #: C/index.docbook:713 msgid "" " allows to specify files where " "gtk-doc abbreviations such as #GtkWidget " "are expanded (e.g. expand_content_files=running.xml)." msgstr "" "In geben Sie Dateien an, in denen " "gtk-doc Abkürzungen wie #GtkWidget " "expandiert werden (z.B. expand_content_files=running.xml)." #. (itstool) path: sect2/para #: C/index.docbook:631 msgid "" "The following list explains the most relevant options. Check the example " "Makefile.am for additional options. <_:itemizedlist-1/>" msgstr "" "In der folgenden Liste werden einige der relevantesten Optionen erläutert. " "Im Beispiel für Makefile.am finden Sie weitere " "Optionen. <_:itemizedlist-1/>" #. (itstool) path: sect2/title #: C/index.docbook:728 msgid "Integration with autoconf" msgstr "Integration in autoconf" #. (itstool) path: sect2/para #: C/index.docbook:730 msgid "" "Integration with autoconf is very simple and " "includes one required step and an additional optional (but recommended) " "step. The first step is to add the GTK_DOC_CHECK macro " "to your configure.ac script. This registers several " "configure options to enable GTK-Doc and allows you to set default arguments " "for gtkdocize." msgstr "" "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." #. (itstool) path: warning/simpara #: C/index.docbook:742 msgid "" "Make sure that the GTK_DOC_CHECK macro is not indented. The " "macro must start at the beginning of the line and should not start with " "whitespace." msgstr "" "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." #. (itstool) path: sect2/para #: C/index.docbook:749 msgid "" "The second step is to add the AC_CONFIG_MACRO_DIR(m4) to your " "configure.ac. This is not required but helps " "gtkdocize to automatically copy the macro " "definition (e.g gtk-doc.m4) which contains the " "GTK_DOC_CHECK macro to your project's macro directory. " "Without this, the GTK_DOC_CHECK macro might not be found and you would need " "to explicitly tell the aclocal tool where to find " "the macro definition file." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:762 msgid "Minimal integration with autoconf" msgstr "Minimale Integration in autoconf" #. (itstool) path: example/programlisting #: C/index.docbook:763 #, no-wrap msgid "" "\n" "# recommended: set m4 directory\n" "AC_CONFIG_MACRO_DIR(m4)\n" "# optional: register gtk-doc in configure\n" "GTK_DOC_CHECK([1.28])\n" msgstr "" "\n" "# recommended: set m4 directory\n" "AC_CONFIG_MACRO_DIR(m4)\n" "# optional: register gtk-doc in configure\n" "GTK_DOC_CHECK([1.28])\n" #. (itstool) path: example/title #: C/index.docbook:778 msgid "Integration with optional gtk-doc dependency" msgstr "Integration mit optionaler Abhängigkeit zu gtk-doc" #. (itstool) path: example/programlisting #: C/index.docbook:779 #, no-wrap msgid "" "\n" "m4_ifdef([GTK_DOC_CHECK], [\n" "# recommended: set m4 directory\n" "AC_CONFIG_MACRO_DIR(m4)\n" "# optional: register gtk-doc in configure\n" "GTK_DOC_CHECK([1.28])\n" "],[\n" "AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n" "])\n" msgstr "" "\n" "m4_ifdef([GTK_DOC_CHECK], [\n" "# recommended: set m4 directory\n" "AC_CONFIG_MACRO_DIR(m4)\n" "# optional: register gtk-doc in configure\n" "GTK_DOC_CHECK([1.28])\n" "],[\n" "AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n" "])\n" #. (itstool) path: sect2/para #: C/index.docbook:772 msgid "" "The above example works, but will require all developers to have gtk-doc " "installed. A better way is to make building the documentation optional as " "shown in the next example: <_:example-1/>" msgstr "" "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: <_:example-1/>" #. (itstool) path: sect2/para #: C/index.docbook:792 msgid "" "The first argument is used to check for the Gtk-Doc version at configure " "time. The 2nd, optional argument is used by gtkdocize. The GTK_DOC_CHECK macro also adds several " "configure switches:" msgstr "" "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:" #. (itstool) path: listitem/para #: C/index.docbook:801 msgid "--with-html-dir=PATH : path to installed docs" msgstr "--with-html-dir=PATH : Pfad zur installierten Dokumentation" #. (itstool) path: listitem/para #: C/index.docbook:802 msgid "--enable-gtk-doc : use gtk-doc to build documentation [default=no]" msgstr "" "--enable-gtk-doc : gtk-doc zur Erstellung der Dokumentation verwenden " "[Vorgabe=no]" #. (itstool) path: listitem/para #: C/index.docbook:803 msgid "" "--enable-gtk-doc-html : build documentation in html format [default=yes]" msgstr "" "--enable-gtk-doc-html : Erstellung der Dokumentation im HTML-Format " "[Vorgabe=yes]" #. (itstool) path: listitem/para #: C/index.docbook:804 msgid "--enable-gtk-doc-pdf : build documentation in pdf format [default=no]" msgstr "" "--enable-gtk-doc-pdf : Erstellung der Dokumentation im PDF-Format " "[Vorgabe=no]" #. (itstool) path: important/para #: C/index.docbook:808 msgid "" "GTK-Doc is disabled by default! Remember to pass the option to the next configure run. " "Otherwise pregenerated documentation is installed (which makes sense for " "users but not for developers)." msgstr "" "GTK-Doc ist standardmäßig deaktiviert! Denken Sie daran, die Option " " 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." #. (itstool) path: sect2/para #: C/index.docbook:816 msgid "" "After all changes to configure.ac are made, update the " "configure file. This can be done by re-running " "autogen.sh." msgstr "" "Nachdem alle Änderungen auf configure.ac angewendet " "wurden, aktualisieren Sie die Datei configure. Dies " "geschieht durch erneutes Ausführen von autogen.sh." #. (itstool) path: sect2/title #: C/index.docbook:824 msgid "Integration with autogen" msgstr "Integration in autogen" #. (itstool) path: sect2/para #: C/index.docbook:826 msgid "" "Most projects will have an autogen.sh script to setup " "the build infrastructure after the project was checked out from a version " "control system (such as git or svn). GTK-Doc comes with a script called " "gtkdocize which can be used to copy the necessary " "files needed by Gtk-Doc to the source directory." msgstr "" "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." #. (itstool) path: sect2/para #: C/index.docbook:834 msgid "It should be run before autoreconf, autoheader, automake or autoconf." msgstr "" "Es sollte vor autoreconf, autoheader, automake oder autoconf ausgeführt " "werden." #. (itstool) path: example/title #: C/index.docbook:839 msgid "Running gtkdocize from autogen.sh" msgstr "Ausführen von gtkdocize durch autogen.sh" #. (itstool) path: example/programlisting #: C/index.docbook:840 #, no-wrap msgid "" "\n" "gtkdocize || exit 1\n" msgstr "" "\n" "gtkdocize || exit 1\n" #. (itstool) path: example/title #: C/index.docbook:848 msgid "Conditionally run gtkdocize from autogen.sh" msgstr "Bedingtes Ausführen von gtkdocize durch autogen.sh" #. (itstool) path: example/programlisting #: C/index.docbook:849 #, no-wrap msgid "" "\n" "GTKDOCIZE=$(which gtkdocize 2>/dev/null)\n" "if test $? -ne 0; then\n" " echo \"No gtk-doc support found. You can't build the docs.\"\n" "else\n" " $GTKDOCIZE || exit 1\n" "fi\n" msgstr "" "\n" "GTKDOCIZE=$(which gtkdocize 2>/dev/null)\n" "if test $? -ne 0; then\n" " echo \"No gtk-doc support found. You can't build the docs.\"\n" "else\n" " $GTKDOCIZE || exit 1\n" "fi\n" #. (itstool) path: sect2/para #: C/index.docbook:860 msgid "" "When running gtkdocize it copies gtk-" "doc.make to your project root (or any directory specified by the " " option)." msgstr "" "Beim Ausführen von gtkdocize wird gtk-" "doc.make in die Wurzel Ihres Projekts oder in jeden anderen durch " "die Option festgelegten Ordner kopiert." #. (itstool) path: sect2/para #: C/index.docbook:866 msgid "" "gtkdocize checks your configure.ac script for the GTK_DOC_CHECK macro. The " "GTK_DOC_CHECK macro can be used to pass extra arguments " "to the gtkdocize script. the 2nd parameter in the " "GTK_DOC_CHECK macro." msgstr "" "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." #. (itstool) path: sect2/para #: C/index.docbook:875 msgid "" "Alternatively, additional arguments can also be passed to " "gtkdocize via the GTKDOCIZE_FLAGS environment variable, or by directly specifying them to " "gtkdocize in autogen.sh." msgstr "" "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." #. (itstool) path: sect2/title #: C/index.docbook:886 msgid "Executing GTK-Doc from the Build System" msgstr "Aufruf von GTK-Doc aus dem Erstellungssystem heraus" #. (itstool) path: sect2/para #: C/index.docbook:888 msgid "" "After the previous steps it's time to run the build. First we need to rerun " "autogen.sh. If this script runs configure for you, then " "give it the option. Otherwise manually run " "configure with this option afterwards." msgstr "" "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 hinzufügen. Anderenfalls führen Sie " "danach configure manuell aus, ebenfalls mit dieser " "Option." #. (itstool) path: sect2/para #: C/index.docbook:895 msgid "" "The first make run generates several additional files in the doc-" "directories. The important ones are: <package>.types, <package>-docs.xml (in the past ." "sgml), <package>-sections.txt." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:903 msgid "Running the doc build" msgstr "Erstellung der Dokumentation" #. (itstool) path: example/programlisting #: C/index.docbook:904 #, no-wrap msgid "" "\n" "./autogen.sh --enable-gtk-doc\n" "make\n" msgstr "" "\n" "./autogen.sh --enable-gtk-doc\n" "make\n" #. (itstool) path: sect2/para #: C/index.docbook:911 msgid "" "Now you can point your browser to docs/reference/<package>/" "index.html. With this initial setup you will only see a very " "simple document. The next chapter will teach you how to add API " "documentation to your code via special comment blocks. The Chapter " "afterwards introduces additional files " "and shows how to edit the master " "template to add additional chapters and sections to your " "documentation files." msgstr "" "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." #. (itstool) path: sect1/title #: C/index.docbook:927 msgid "Integration with CMake build systems" msgstr "Integration in CMake-Erstellungssysteme" #. (itstool) path: sect1/para #: C/index.docbook:929 msgid "" "GTK-Doc now provides a GtkDocConfig.cmake module (and " "the corresponding GtkDocConfigVersion.cmake module). " "This provides a gtk_doc_add_module command that you can " "set in your CMakeLists.txt file." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:939 msgid "Example of using GTK-Doc from CMake" msgstr "Beispiel zur Verwendung von GTK-Doc mit CMake" #. (itstool) path: example/programlisting #: C/index.docbook:940 #, no-wrap msgid "" "\n" "find_package(GtkDoc 1.25 REQUIRED)\n" "\n" "# Create the doc-libmeep target.\n" "gtk_doc_add_module(\n" " libmeep ${CMAKE_SOURCE_DIR}/libmeep\n" " XML meep-docs.xml\n" " LIBRARIES libmeep\n" ")\n" "\n" "# Build doc-libmeep as part of the default target. Without this, you would\n" "# have to explicitly run something like `make doc-libmeep` to build the docs.\n" "add_custom_target(documentation ALL DEPENDS doc-libmeep)\n" "\n" "# Install the docs. (This assumes you're using the GNUInstallDirs CMake module\n" "# to set the CMAKE_INSTALL_DOCDIR variable correctly).\n" "install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html\n" " DESTINATION ${CMAKE_INSTALL_DOCDIR})\n" msgstr "" "\n" "find_package(GtkDoc 1.25 REQUIRED)\n" "\n" "# Create the doc-libmeep target.\n" "gtk_doc_add_module(\n" " libmeep ${CMAKE_SOURCE_DIR}/libmeep\n" " XML meep-docs.xml\n" " LIBRARIES libmeep\n" ")\n" "\n" "# Build doc-libmeep as part of the default target. Without this, you would\n" "# have to explicitly run something like `make doc-libmeep` to build the docs.\n" "add_custom_target(documentation ALL DEPENDS doc-libmeep)\n" "\n" "# Install the docs. (This assumes you're using the GNUInstallDirs CMake module\n" "# to set the CMAKE_INSTALL_DOCDIR variable correctly).\n" "install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html\n" " DESTINATION ${CMAKE_INSTALL_DOCDIR})\n" #. (itstool) path: sect1/para #: C/index.docbook:937 msgid "The following example shows how to use this command. <_:example-1/>" msgstr "" "Das folgende Beispiel zeigt, wie dieser Befehl eingesetzt wird. <_:example-1/" ">" #. (itstool) path: sect1/title #: C/index.docbook:964 msgid "Integration with plain makefiles or other build systems" msgstr "Integration in Klartext-Makefiles oder andere Erstellungssysteme" #. (itstool) path: sect1/para #: C/index.docbook:966 msgid "" "In the case one does not want to use automake and therefore gtk-" "doc.mak one will need to call the gtkdoc tools in the right order " "in own makefiles (or other build tools)." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:973 msgid "Documentation build steps" msgstr "Schritte zur Erstellung der Dokumentation" #. (itstool) path: example/programlisting #: C/index.docbook:974 #, no-wrap msgid "" "\n" "DOC_MODULE=meep\n" "// sources have changed\n" "gtkdoc-scan --module=$(DOC_MODULE) <source-dir>\n" "gtkdoc-scangobj --module=$(DOC_MODULE)\n" "gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=<source-dir>\n" "// xml files have changed\n" "mkdir html\n" "cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n" "gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n" msgstr "" "\n" "DOC_MODULE=meep\n" "// sources have changed\n" "gtkdoc-scan --module=$(DOC_MODULE) <source-dir>\n" "gtkdoc-scangobj --module=$(DOC_MODULE)\n" "gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=<source-dir>\n" "// xml files have changed\n" "mkdir html\n" "cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n" "gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n" #. (itstool) path: sect1/para #: C/index.docbook:988 msgid "" "One will need to look at the Makefile.am and " "gtk-doc.mak to pick the extra options needed." msgstr "" "Man muss sich Makefile.am und gtk-doc.mak anschauen, um die zusätzlich notwendigen Optionen herauszusuchen." #. (itstool) path: sect1/title #: C/index.docbook:995 msgid "Integration with version control systems" msgstr "Integration in Versionsverwaltungssysteme" #. (itstool) path: sect1/para #: C/index.docbook:997 msgid "" "As a rule of thumb, it's the files you edit which should go under version " "control. For typical projects it's these files: <package>." "types, <package>-docs.xml (in the " "past .sgml), <package>-sections.txt, " "Makefile.am." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:1005 msgid "" "Files in the xml/ and html/ " "directories should not go under version control. Neither should any of the " ".stamp files." msgstr "" "Dateien in den Ordnern xml/ und html/ sollten nicht unter Versionsverwaltung gestellt werden, ebenso " "keine der .stamp-Dateien." #. (itstool) path: chapter/title #: C/index.docbook:1015 msgid "Documenting the code" msgstr "Dokumentieren des Codes" #. (itstool) path: chapter/para #: C/index.docbook:1017 msgid "" "GTK-Doc uses source code comment with a special syntax for code " "documentation. Further it retrieves information about your project structure " "from other sources. During the next section you will find all information " "about the syntax of the comments." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:1028 C/index.docbook:1054 msgid "GTK-Doc comment block" msgstr "GTK-Doc-Kommentarblock" #. (itstool) path: example/programlisting #: C/index.docbook:1029 #, no-wrap msgid "" "\n" "#ifndef __GTK_DOC_IGNORE__\n" "/* unparseable code here */\n" "#endif\n" msgstr "" "\n" "#ifndef __GTK_DOC_IGNORE__\n" "/* unparseable code here */\n" "#endif\n" #. (itstool) path: chapter/para #: C/index.docbook:1024 msgid "" "The GTK-Doc scanner can handle the majority of C headers fine. In the case " "of receiving warnings from the scanner that look like a special case, one " "can hint GTK-Doc to skip over them. <_:example-1/>" msgstr "" "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. <_:example-1/>" #. (itstool) path: note/title #: C/index.docbook:1038 msgid "Limitations" msgstr "Einschränkungen" #. (itstool) path: note/para #: C/index.docbook:1039 msgid "" "Note, that GTK-Doc's supports #ifndef(__GTK_DOC_IGNORE__) but " "not #if !defined(__GTK_DOC_IGNORE__) or other combinations." msgstr "" "Beachten Sie, dass GTK-Doc zwar #ifndef(__GTK_DOC_IGNORE__) " "unterstützt, aber nicht #if !defined(__GTK_DOC_IGNORE__) oder " "andere Kombinationen." #. (itstool) path: sect1/title #: C/index.docbook:1049 msgid "Documentation comments" msgstr "Kommentare zur Dokumentation" #. (itstool) path: example/programlisting #: C/index.docbook:1055 #, no-wrap msgid "" "\n" "/**\n" " * identifier:\n" " * documentation ...\n" " */\n" msgstr "" "\n" "/**\n" " * identifier:\n" " * documentation ...\n" " */\n" #. (itstool) path: sect1/para #: C/index.docbook:1051 msgid "" "A multiline comment that starts with an additional '*' marks a documentation " "block that will be processed by the GTK-Doc tools. <_:example-1/>" msgstr "" "Ein mehrzeiliger Kommentar, der mit einem zusätzlichen »*« beginnt, markiert " "einen Kommentarblock, der von den Werkzeugen in GTK-Doc verarbeitet wird. <_:" "example-1/>" #. (itstool) path: sect1/para #: C/index.docbook:1064 msgid "" "The 'identifier' is one line with the name of the item the comment is " "related to. The syntax differs a little depending on the item. (TODO add " "table showing identifiers)" msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:1070 msgid "" "The 'documentation' block is also different for each symbol type. Symbol " "types that get parameters such as functions or macros have the parameter " "description first followed by a blank line (just a '*'). Afterwards follows " "the detailed description. All lines (outside program listings and CDATA " "sections) just containing a ' *' (blank-asterisk) are converted to paragraph " "breaks. If you don't want a paragraph break, change that into ' * ' (blank-" "asterisk-blank-blank). This is useful in preformatted text (code listings)." msgstr "" "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)." #. (itstool) path: listitem/para #: C/index.docbook:1087 msgid "" "What it is: The name for a class or function can sometimes be misleading for " "people coming from a different background." msgstr "" "Was es ist: Der Name für eine Klasse oder Funktion kann manchmal irreführend " "sein für Personen, die einen anderen Hintergrund haben." #. (itstool) path: listitem/para #: C/index.docbook:1093 msgid "" "What it does: Tell about common uses. Put it in relation with the other API." msgstr "" "Was es ist: Berichtet über normale Anwendungsfälle. Stellen Sie es ins " "Verhältnis mit der anderen API." #. (itstool) path: tip/para #: C/index.docbook:1083 msgid "When documenting code, describe two aspects: <_:itemizedlist-1/>" msgstr "" "Beim Dokumentieren von Code beschreiben Sie zwei Aspekte: <_:itemizedlist-1/>" #. (itstool) path: listitem/para #: C/index.docbook:1108 msgid "Use function() to refer to functions or macros which take arguments." msgstr "" "Verwenden Sie function(), um einen Bezug zu Funktionen oder Makros " "herzustellen, die Argumente akzeptieren." #. (itstool) path: listitem/para #: C/index.docbook:1113 msgid "" "Use @param to refer to parameters. Also use this when referring to " "parameters of other functions, related to the one being described." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:1119 msgid "Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS." msgstr "" "Benutzen Sie %constant, um einen Bezug auf eine Konstante herzustellen, z.B. " "%G_TRAVERSE_LEAFS." #. (itstool) path: listitem/para #: C/index.docbook:1124 msgid "" "Use #symbol to refer to other types of symbol, e.g. structs and enums and " "macros which don't take arguments." msgstr "" "Verwenden Sie #symbol, um auf andere Symboltypen zu verweisen, z.B. " "»structs« und »enums« und Makros, die keine Argumente benötigen." #. (itstool) path: listitem/para #: C/index.docbook:1130 msgid "Use #Object::signal to refer to a GObject signal." msgstr "Verwenden Sie #Object::signal, um auf ein GObject-Signal zu verweisen." #. (itstool) path: listitem/para #: C/index.docbook:1135 msgid "Use #Object:property to refer to a GObject property." msgstr "" "Verwenden Sie #Object:property, um auf eine GObject-Eigenschaft zu verweisen." #. (itstool) path: listitem/para #: C/index.docbook:1140 msgid "" "Use #Struct.field to refer to a field inside a structure and #GObjectClass." "foo_bar() to refer to a vmethod." msgstr "" "Verwenden Sie #Struct.field, um auf ein Feld innerhalb einer Struktur zu " "verweisen und #GObjectClass.foo_bar() für eine vmethod." #. (itstool) path: sect1/para #: C/index.docbook:1102 msgid "" "One advantage of hyper-text over plain-text is the ability to have links in " "the document. Writing the correct markup for a link can be tedious though. " "GTK-Doc comes to help by providing several useful abbreviations. <_:" "itemizedlist-1/>" msgstr "" "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. <_:" "itemizedlist-1/>" #. (itstool) path: tip/para #: C/index.docbook:1149 msgid "" "If you need to use the special characters '<', '>', '()', '@', '%', or " "'#' in your documentation without GTK-Doc changing them you can use the XML " "entities \"&lt;\", \"&gt;\", \"&lpar;\", \"&rpar;\", \"&" "commat;\", \"&percnt;\" and \"&num;\" respectively or escape them " "with a backslash '\\'." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:1158 msgid "" "DocBook can do more than just links. One can also have lists, examples, " "headings, and images. As of version 1.20, the preferred way is to use a " "subset of the basic text formatting syntax called Markdown. On older GTK-Doc " "versions any documentation that includes Markdown will be rendered as is. " "For example, list items will appear as lines starting with a dash." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:1169 msgid "" "While markdown is now preferred one can mix both. One limitation here is " "that one can use docbook xml within markdown, but markdown within docbook " "xml is not supported." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:1175 msgid "" "In older GTK-Doc releases, if you need support for additional formatting, " "you would need to enable the usage of docbook XML tags inside doc-comments " "by putting (or ) in " "the variable MKDB_OPTIONS inside Makefile.am." msgstr "" "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 (oder )." #. (itstool) path: example/title #: C/index.docbook:1184 msgid "GTK-Doc comment block using Markdown" msgstr "GTK-Doc-Kommentarblock in Markdown-Syntax" #. (itstool) path: example/programlisting #: C/index.docbook:1185 #, no-wrap msgid "" "\n" "/**\n" " * identifier:\n" " *\n" " * documentation paragraph ...\n" " *\n" " * # Sub Heading #\n" " *\n" " * ## Second Sub Heading\n" " *\n" " * # Sub Heading With a Link Anchor # {#heading-two}\n" " *\n" " * more documentation:\n" " *\n" " * - list item 1\n" " *\n" " * Paragraph inside a list item.\n" " *\n" " * - list item 2\n" " *\n" " * 1. numbered list item\n" " *\n" " * 2. another numbered list item\n" " *\n" " * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n" " *\n" " * ![an inline image](plot-result.png)\n" " *\n" " * [A link to the heading anchor above][heading-two]\n" " *\n" " * A C-language example:\n" " * |[<!-- language=\"C\" -->\n" " * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n" " * ]|\n" " */\n" msgstr "" "\n" "/**\n" " * identifier:\n" " *\n" " * documentation paragraph ...\n" " *\n" " * # Sub Heading #\n" " *\n" " * ## Second Sub Heading\n" " *\n" " * # Sub Heading With a Link Anchor # {#heading-two}\n" " *\n" " * more documentation:\n" " *\n" " * - list item 1\n" " *\n" " * Paragraph inside a list item.\n" " *\n" " * - list item 2\n" " *\n" " * 1. numbered list item\n" " *\n" " * 2. another numbered list item\n" " *\n" " * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n" " *\n" " * ![an inline image](plot-result.png)\n" " *\n" " * [A link to the heading anchor above][heading-two]\n" " *\n" " * A C-language example:\n" " * |[<!-- language=\"C\" -->\n" " * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n" " * ]|\n" " */\n" #. (itstool) path: sect1/para #: C/index.docbook:1224 msgid "" "More examples of what markdown tags are supported can be found in the GTK " "Documentation Markdown Syntax Reference." msgstr "" "Weitere Beispiele zu den unterstützten Markdown-Formatierungen finden Sie in " "der GTK Documentation Markdown Syntax Reference." #. (itstool) path: tip/para #: C/index.docbook:1230 msgid "" "As already mentioned earlier GTK-Doc is for documenting public API. Thus one " "cannot write documentation for static symbols. Nevertheless it is good to " "comment those symbols too. This helps other developers to understand your " "code. Therefore we recommend to comment these using normal comments (without " "the 2nd '*' in the first line). If later the function needs to be made " "public, all one needs to do is to add another '*' in the comment block and " "insert the symbol name at the right place inside the sections file." msgstr "" "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." #. (itstool) path: sect1/title #: C/index.docbook:1245 msgid "Documenting sections" msgstr "Dokumentieren in Abschnitten" #. (itstool) path: sect1/para #: C/index.docbook:1247 msgid "" "Each section of the documentation contains information about one class or " "module. To introduce the component one can write a section block. The short " "description is also used inside the table of contents. All the @fields are " "optional." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:1255 msgid "Section comment block" msgstr "Abschnitts-Kommentarblock" #. (itstool) path: example/programlisting #: C/index.docbook:1256 #, no-wrap msgid "" "\n" "/**\n" " * SECTION:meepapp\n" " * @short_description: the application class\n" " * @title: Meep application\n" " * @section_id:\n" " * @see_also: #MeepSettings\n" " * @stability: Stable\n" " * @include: meep/app.h\n" " * @image: application.png\n" " *\n" " * The application class handles ...\n" " */\n" msgstr "" "\n" "/**\n" " * SECTION:meepapp\n" " * @short_description: the application class\n" " * @title: Meep application\n" " * @section_id:\n" " * @see_also: #MeepSettings\n" " * @stability: Stable\n" " * @include: meep/app.h\n" " * @image: application.png\n" " *\n" " * The application class handles ...\n" " */\n" #. (itstool) path: varlistentry/term #: C/index.docbook:1275 msgid "SECTION:<name>" msgstr "SECTION:<name>" #. (itstool) path: listitem/para #: C/index.docbook:1277 msgid "" "The name links the section documentation to the respective part in the " "<package>-sections.txt file. The name given here " "should match the <FILE> tag in the <package>-sections." "txt file." msgstr "" "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." #. (itstool) path: varlistentry/term #: C/index.docbook:1286 msgid "@short_description" msgstr "@short_description" #. (itstool) path: listitem/para #: C/index.docbook:1288 msgid "" "A one line description of the section, that later will appear after the " "links in the TOC and at the top of the section page." msgstr "" "Eine einzeilige Beschreibung des Abschnitts, die später hinter den Verweisen " "im Inhaltsverzeichnis und oben in der Abschnittsseite erscheint." #. (itstool) path: varlistentry/term #: C/index.docbook:1295 msgid "@title" msgstr "@title" #. (itstool) path: listitem/para #: C/index.docbook:1297 msgid "" "The section title defaults to <name> from the SECTION declaration. It " "can be overridden with the @title field." msgstr "" "Der Abschnittstitel in der SECTION-Deklaration, Vorgabe ist <name>. Er " "kann im Feld @title überschrieben werden." #. (itstool) path: varlistentry/term #: C/index.docbook:1304 msgid "@section_id" msgstr "@section_id" #. (itstool) path: listitem/para #: C/index.docbook:1306 msgid "" "Overrides the use of title as a section identifier. For GObjects the <" "title> is used as a section_id and for other sections it is <" "MODULE>-<title>." msgstr "" "Ü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>." #. (itstool) path: varlistentry/term #: C/index.docbook:1314 msgid "@see_also" msgstr "@see_also" #. (itstool) path: listitem/para #: C/index.docbook:1316 msgid "A list of symbols that are related to this section." msgstr "Eine Liste von Symbolen, welche sich auf diesen Abschnitt beziehen." #. (itstool) path: varlistentry/term #: C/index.docbook:1322 msgid "@stability" msgstr "@stability" #. (itstool) path: listitem/para #: C/index.docbook:1329 msgid "" "Stable - The intention of a Stable interface is to enable arbitrary third " "parties to develop applications to these interfaces, release them, and have " "confidence that they will run on all minor releases of the product (after " "the one in which the interface was introduced, and within the same major " "release). Even at a major release, incompatible changes are expected to be " "rare, and to have strong justifications." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:1341 msgid "" "Unstable - Unstable interfaces are experimental or transitional. They are " "typically used to give outside developers early access to new or rapidly " "changing technology, or to provide an interim solution to a problem where a " "more general solution is anticipated. No claims are made about either source " "or binary compatibility from one minor release to the next." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:1353 msgid "" "Private - An interface that can be used within the GNOME stack itself, but " "that is not documented for end-users. Such functions should only be used in " "specified and documented ways." msgstr "" "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." #. (itstool) path: listitem/para #: C/index.docbook:1362 msgid "" "Internal - An interface that is internal to a module and does not require " "end-user documentation. Functions that are undocumented are assumed to be " "Internal." msgstr "" "Intern - Eine Schnittstelle, die für ein Modul intern ist und keine " "Endanwender-Dokumentation erfordert. Undokumentierte Funktionen werden als " "intern angesehen." #. (itstool) path: listitem/para #: C/index.docbook:1324 msgid "" "An informal description of the stability level this API has. We recommend " "the use of one of these terms: <_:itemizedlist-1/>" msgstr "" "Eine informelle Beschreibung der Stabilitätsstufe dieser API. Wir empfehlen " "dafür einen der folgenden Begriffe: <_:itemizedlist-1/>" #. (itstool) path: varlistentry/term #: C/index.docbook:1374 msgid "@include" msgstr "@include" #. (itstool) path: listitem/para #: C/index.docbook:1376 msgid "" "The #include files to show in the section synopsis (a " "comma separated list), overriding the global value from the section file or command line. This " "item is optional." msgstr "" "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." #. (itstool) path: varlistentry/term #: C/index.docbook:1385 msgid "@image" msgstr "@image" #. (itstool) path: listitem/para #: C/index.docbook:1387 msgid "" "The image to display at the top of the reference page for this section. This " "will often be some sort of a diagram to illustrate the visual appearance of " "a class or a diagram of its relationship to other classes. This item is " "optional." msgstr "" "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." #. (itstool) path: tip/para #: C/index.docbook:1398 msgid "" "To avoid unnecessary recompilation after doc-changes put the section docs " "into the c-source where possible." msgstr "" "Um unnötiges Rekompilieren nach Dokumentationsänderungen zu vermeiden, " "platzieren Sie die Abschnittsdokumentation in die C-Quellen, wo immer es " "möglich ist." #. (itstool) path: sect1/title #: C/index.docbook:1407 msgid "Documenting symbols" msgstr "Dokumentieren von Symbolen" #. (itstool) path: sect1/para #: C/index.docbook:1409 msgid "" "Each symbol (function, macro, struct, enum, signal and property) is " "documented in a separate block. The block is best placed close to the " "definition of the symbols so that it is easy to keep them in sync. Thus " "functions are usually documented in the c-source and macros, structs and " "enums in the header file." msgstr "" "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." #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1417 C/index.docbook:1483 msgid "General tags" msgstr "Allgemeine Markierungen" #. (itstool) path: sect2/para #: C/index.docbook:1419 msgid "" "You can add versioning information to all documentation elements to tell " "when an API was introduced, or when it was deprecated." msgstr "" "Sie können Versionsinformationen zu allen Dokumentationselementen " "hinzufügen, um darauf hinzuweisen, wann eine API eingeführt oder wann sie " "als veraltet markiert wurde." #. (itstool) path: variablelist/title #: C/index.docbook:1424 msgid "Versioning Tags" msgstr "Versionierungs-Markierungen" #. (itstool) path: varlistentry/term #: C/index.docbook:1425 msgid "Since:" msgstr "Since:" #. (itstool) path: listitem/para #: C/index.docbook:1427 msgid "Description since which version of the code the API is available." msgstr "Beschreibung, seit welcher Version des Codes die API verfügbar ist." #. (itstool) path: varlistentry/term #: C/index.docbook:1432 msgid "Deprecated:" msgstr "Deprecated:" #. (itstool) path: listitem/para #: C/index.docbook:1434 msgid "" "Paragraph denoting that this function should no be used anymore. The " "description should point the reader to the new API." msgstr "" "Absatz, der darüber informiert, dass diese Funktion nicht mehr genutzt " "werden sollte. Die Beschreibung sollte einen Verweis auf die neue API " "enthalten." #. (itstool) path: sect2/para #: C/index.docbook:1442 msgid "" "You can also add stability information to all documentation elements to " "indicate whether API stability is guaranteed for them for all future minor " "releases of the project." msgstr "" "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." #. (itstool) path: sect2/para #: C/index.docbook:1448 msgid "" "The default stability level for all documentation elements can be set by " "passing the argument to " "gtkdoc-mkdb with one of the values below." msgstr "" "Die Standard-Stabilitätsstufe für alle Dokumentationselemente setzen Sie " "durch Übergabe des Arguments an " "gtkdoc-mkdb in einem der nachfolgend " "beschriebenen Werte." #. (itstool) path: variablelist/title #: C/index.docbook:1454 msgid "Stability Tags" msgstr "Stabilitäts-Markierungen" #. (itstool) path: varlistentry/term #: C/index.docbook:1455 msgid "Stability: Stable" msgstr "Stability: Stable" #. (itstool) path: listitem/para #: C/index.docbook:1457 msgid "" "Mark the element as stable. This is for public APIs which are guaranteed to " "remain stable for all future minor releases of the project." msgstr "" "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." #. (itstool) path: varlistentry/term #: C/index.docbook:1464 msgid "Stability: Unstable" msgstr "Stability: Unstable" #. (itstool) path: listitem/para #: C/index.docbook:1466 msgid "" "Mark the element as unstable. This is for public APIs which are released as " "a preview before being stabilised." msgstr "" "Markiert das Element als instabil. Dies bezieht sich auf öffentliche APIs, " "die als Vorschau vor der endgültigen Stabilisierung gedacht sind." #. (itstool) path: varlistentry/term #: C/index.docbook:1472 msgid "Stability: Private" msgstr "Stability: Private" #. (itstool) path: listitem/para #: C/index.docbook:1474 msgid "" "Mark the element as private. This is for interfaces which can be used by " "tightly coupled modules, but not by arbitrary third parties." msgstr "" "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." #. (itstool) path: example/programlisting #: C/index.docbook:1484 #, no-wrap msgid "" "\n" "/**\n" " * foo_get_bar:\n" " * @foo: some foo\n" " *\n" " * Retrieves @foo's bar.\n" " *\n" " * Returns: @foo's bar\n" " *\n" " * Since: 2.6\n" " * Deprecated: 2.12: Use foo_baz_get_bar() instead.\n" " */\n" "Bar *\n" "foo_get_bar(Foo *foo)\n" "{\n" "...\n" msgstr "" "\n" "/**\n" " * foo_get_bar:\n" " * @foo: some foo\n" " *\n" " * Retrieves @foo's bar.\n" " *\n" " * Returns: @foo's bar\n" " *\n" " * Since: 2.6\n" " * Deprecated: 2.12: Use foo_baz_get_bar() instead.\n" " */\n" "Bar *\n" "foo_get_bar(Foo *foo)\n" "{\n" "...\n" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1504 C/index.docbook:1514 msgid "Annotations" msgstr "Anmerkungen" #. (itstool) path: sect2/para #: C/index.docbook:1506 msgid "" "Documentation blocks can contain annotation-tags. These tags will be " "rendered with tooltips describing their meaning. The tags are used by " "GObject Introspection to generate language bindings. A detailed list of the " "supported tags can be found in the GObject Introspection " "documentation." msgstr "" "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." #. (itstool) path: example/programlisting #: C/index.docbook:1515 #, no-wrap msgid "" "\n" "/**\n" " * foo_get_bar: (annotation)\n" " * @foo: (annotation): some foo\n" " *\n" " * Retrieves @foo's bar.\n" " *\n" " * Returns: (annotation): @foo's bar\n" " */\n" "...\n" "/**\n" " * foo_set_bar_using_the_frobnicator: (annotation) (another annotation)\n" " * (and another annotation)\n" " * @foo: (annotation) (another annotation): some foo\n" " *\n" " * Sets bar on @foo.\n" " */\n" msgstr "" "\n" "/**\n" " * foo_get_bar: (annotation)\n" " * @foo: (annotation): some foo\n" " *\n" " * Retrieves @foo's bar.\n" " *\n" " * Returns: (annotation): @foo's bar\n" " */\n" "...\n" "/**\n" " * foo_set_bar_using_the_frobnicator: (annotation) (another annotation)\n" " * (and another annotation)\n" " * @foo: (annotation) (another annotation): some foo\n" " *\n" " * Sets bar on @foo.\n" " */\n" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1536 C/index.docbook:1565 msgid "Function comment block" msgstr "Kommentarblock einer Funktion" #. (itstool) path: listitem/para #: C/index.docbook:1542 msgid "" "Document whether returned objects, lists, strings, etc, should be freed/" "unrefed/released." msgstr "" "Dokumentieren, ob zurückgegebene Objekte, Listen, Zeichenketten usw. befreit/" "dereferenziert/freigegeben werden." #. (itstool) path: listitem/para #: C/index.docbook:1548 msgid "Document whether parameters can be NULL, and what happens if they are." msgstr "" "Dokumentiert, ob Parameter NULL sein können, und was in diesem Fall " "geschieht." #. (itstool) path: listitem/para #: C/index.docbook:1553 msgid "" "Mention interesting pre-conditions and post-conditions where appropriate." msgstr "" "Erwähnen Sie interessante Vorbedingungen (und nachfolgende Bedingungen), wo " "es nützlich erscheint." #. (itstool) path: sect2/para #: C/index.docbook:1538 C/index.docbook:1624 msgid "Please remember to: <_:itemizedlist-1/>" msgstr "Bitte denken Sie an: <_:itemizedlist-1/>" #. (itstool) path: sect2/para #: C/index.docbook:1560 msgid "" "Gtk-doc assumes all symbols (macros, functions) starting with '_' are " "private. They are treated like static functions." msgstr "" "GTK-Doc nimmt an, dass alle Symbole (Makros, Funktionen), die mit »_« " "beginnen, privat sind. Sie werden wie statische Funktionen behandelt." #. (itstool) path: example/programlisting #: C/index.docbook:1566 #, no-wrap msgid "" "\n" "/**\n" " * function_name:\n" " * @par1: description of parameter 1. These can extend over more than\n" " * one line.\n" " * @par2: description of parameter 2\n" " * @...: a %NULL-terminated list of bars\n" " *\n" " * The function description goes here. You can use @par1 to refer to parameters\n" " * so that they are highlighted in the output. You can also use %constant\n" " * for constants, function_name2() for functions and #GtkWidget for links to\n" " * other declarations (which may be documented elsewhere).\n" " *\n" " * Returns: an integer.\n" " *\n" " * Since: 2.2\n" " * Deprecated: 2.18: Use other_function() instead.\n" " */\n" msgstr "" "\n" "/**\n" " * function_name:\n" " * @par1: description of parameter 1. These can extend over more than\n" " * one line.\n" " * @par2: description of parameter 2\n" " * @...: a %NULL-terminated list of bars\n" " *\n" " * The function description goes here. You can use @par1 to refer to parameters\n" " * so that they are highlighted in the output. You can also use %constant\n" " * for constants, function_name2() for functions and #GtkWidget for links to\n" " * other declarations (which may be documented elsewhere).\n" " *\n" " * Returns: an integer.\n" " *\n" " * Since: 2.2\n" " * Deprecated: 2.18: Use other_function() instead.\n" " */\n" #. (itstool) path: variablelist/title #: C/index.docbook:1587 msgid "Function tags" msgstr "Funktions-Markierungen" #. (itstool) path: varlistentry/term #: C/index.docbook:1588 C/index.docbook:1795 msgid "Returns:" msgstr "Returns:" #. (itstool) path: listitem/para #: C/index.docbook:1590 msgid "Paragraph describing the returned result." msgstr "Abschnitt, der das zurückgegebene Ergebnis beschreibt." #. (itstool) path: varlistentry/term #: C/index.docbook:1595 msgid "@...:" msgstr "@...:" #. (itstool) path: listitem/para #: C/index.docbook:1597 msgid "" "In case the function has variadic arguments, you should use this tag " "(@Varargs: does also work for historic reasons)." msgstr "" "Wenn die Funktion variadische Argumente enthält, sollten Sie diese " "Markierung verwenden (@Varargs: funktioniert aus historischen Gründen " "ebenfalls)." #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1607 C/index.docbook:1609 msgid "Property comment block" msgstr "Property-Kommentarblock" #. (itstool) path: example/programlisting #: C/index.docbook:1610 #, no-wrap msgid "" "\n" "/**\n" " * SomeWidget:some-property:\n" " *\n" " * Here you can document a property.\n" " */\n" "g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n" msgstr "" "\n" "/**\n" " * SomeWidget:some-property:\n" " *\n" " * Here you can document a property.\n" " */\n" "g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1622 C/index.docbook:1641 msgid "Signal comment block" msgstr "Signal-Kommentarblock" #. (itstool) path: listitem/para #: C/index.docbook:1628 msgid "" "Document when the signal is emitted and whether it is emitted before or " "after other signals." msgstr "" "Dokumentiert, wann ein Signal ausgegeben wird und ob es vor oder nach " "anderen Signalen ausgegeben wird." #. (itstool) path: listitem/para #: C/index.docbook:1634 msgid "Document what an application might do in the signal handler." msgstr "Dokumentiert, was eine Anwendung in dem Signal-Handler tun könnte." #. (itstool) path: example/programlisting #: C/index.docbook:1642 #, no-wrap msgid "" "\n" "/**\n" " * FooWidget::foobarized:\n" " * @widget: the widget that received the signal\n" " * @foo: some foo\n" " * @bar: some bar\n" " *\n" " * The ::foobarized signal is emitted each time someone tries to foobarize @widget.\n" " */\n" "foo_signals[FOOBARIZED] =\n" " g_signal_new (\"foobarized\",\n" " ...\n" msgstr "" "\n" "/**\n" " * FooWidget::foobarized:\n" " * @widget: the widget that received the signal\n" " * @foo: some foo\n" " * @bar: some bar\n" " *\n" " * The ::foobarized signal is emitted each time someone tries to foobarize @widget.\n" " */\n" "foo_signals[FOOBARIZED] =\n" " g_signal_new (\"foobarized\",\n" " ...\n" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1659 C/index.docbook:1660 msgid "Struct comment block" msgstr "Struct-Kommentarblock" #. (itstool) path: example/programlisting #: C/index.docbook:1661 #, no-wrap msgid "" "\n" "/**\n" " * FooWidget:\n" " * @bar: some #gboolean\n" " *\n" " * This is the best widget, ever.\n" " */\n" "typedef struct _FooWidget {\n" " GtkWidget parent_instance;\n" "\n" " gboolean bar;\n" "} FooWidget;\n" msgstr "" "\n" "/**\n" " * FooWidget:\n" " * @bar: some #gboolean\n" " *\n" " * This is the best widget, ever.\n" " */\n" "typedef struct _FooWidget {\n" " GtkWidget parent_instance;\n" "\n" " gboolean bar;\n" "} FooWidget;\n" #. (itstool) path: sect2/para #: C/index.docbook:1676 msgid "" "Use /*< private >*/ before the private struct fields you " "want to hide. Use /*< public >*/ for the reverse " "behaviour." msgstr "" "Verwenden Sie /*< private >*/ vor den privaten »struct«-" "Feldern, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, " "verwenden Sie /*< public >*/." #. (itstool) path: sect2/para #: C/index.docbook:1682 msgid "" "If the first field is \"g_iface\", \"parent_instance\" or \"parent_class\" " "it will be considered private automatically and doesn't need to be mentioned " "in the comment block." msgstr "" "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." #. (itstool) path: sect2/para #: C/index.docbook:1688 msgid "" "Struct comment blocks can also be used for GObjects and GObjectClasses. It " "is usually a good idea to add a comment block for a class, if it has " "vmethods (as this is how they can be documented). For the GObject itself one " "can use the related section docs, having a separate block for the instance " "struct would be useful if the instance has public fields. One disadvantage " "here is that this creates two index entries of the same name (the structure " "and the section)." msgstr "" "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)." #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1700 C/index.docbook:1701 msgid "Enum comment block" msgstr "Enum-Kommentarblock" #. (itstool) path: example/programlisting #: C/index.docbook:1702 #, no-wrap msgid "" "\n" "/**\n" " * Something:\n" " * @SOMETHING_FOO: something foo\n" " * @SOMETHING_BAR: something bar\n" " *\n" " * Enum values used for the thing, to specify the thing.\n" " */\n" "typedef enum {\n" " SOMETHING_FOO,\n" " SOMETHING_BAR,\n" " /*< private >*/\n" " SOMETHING_COUNT\n" "} Something;\n" msgstr "" "\n" "/**\n" " * Something:\n" " * @SOMETHING_FOO: something foo\n" " * @SOMETHING_BAR: something bar\n" " *\n" " * Enum values used for the thing, to specify the thing.\n" " */\n" "typedef enum {\n" " SOMETHING_FOO,\n" " SOMETHING_BAR,\n" " /*< private >*/\n" " SOMETHING_COUNT\n" "} Something;\n" #. (itstool) path: sect2/para #: C/index.docbook:1719 msgid "" "Use /*< private >*/ before the private enum values you " "want to hide. Use /*< public >*/ for the reverse " "behaviour." msgstr "" "Verwenden Sie /*< private >*/ vor den privaten »enum«-" "Werten, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, " "verwenden Sie /*< public >*/." #. (itstool) path: sect1/title #: C/index.docbook:1730 msgid "Inline program documentation" msgstr "Eingebettete Programmdokumentation" #. (itstool) path: sect1/para #: C/index.docbook:1731 msgid "" "You can document programs and their commandline interface using inline " "documentation." msgstr "" "Dokumentieren Sie ein Programm und dessen Befehlszeilen-Schnittstelle mit " "eingebetteter Dokumentation." #. (itstool) path: variablelist/title #: C/index.docbook:1737 msgid "Tags" msgstr "Markierungen" #. (itstool) path: varlistentry/term #: C/index.docbook:1739 msgid "PROGRAM" msgstr "PROGRAM" #. (itstool) path: listitem/para #: C/index.docbook:1742 msgid "Defines the start of a program documentation." msgstr "Definiert den Start einer Programmdokumentation." #. (itstool) path: varlistentry/term #: C/index.docbook:1749 msgid "@short_description:" msgstr "@short_description:" #. (itstool) path: listitem/para #: C/index.docbook:1751 msgid "Defines a short description of the program. (Optional)" msgstr "Definiert eine Kurzbeschreibung des Programms (optional)." #. (itstool) path: varlistentry/term #: C/index.docbook:1758 msgid "@synopsis:" msgstr "@synopsis:" #. (itstool) path: listitem/para #: C/index.docbook:1760 msgid "" "Defines the arguments, or list of arguments that the program can take. " "(Optional)" msgstr "" "Definiert die Argumente oder eine Liste von Argumenten, die das Programm " "akzeptiert (optional)." #. (itstool) path: varlistentry/term #: C/index.docbook:1768 msgid "@see_also:" msgstr "@see_also:" #. (itstool) path: listitem/para #: C/index.docbook:1770 msgid "See Also manual page section. (Optional)" msgstr "" "Der Abschnitt »SEE ALSO« in den man-Pages (Unix-Handbuchseiten, optional)." #. (itstool) path: varlistentry/term #: C/index.docbook:1777 msgid "@arg:" msgstr "@arg:" #. (itstool) path: listitem/para #: C/index.docbook:1779 msgid "Argument(s) passed to the program and their description. (Optional)" msgstr "" "Argument(e), die dem Programm übergeben wurden, und die zugehörige " "Beschreibung (optional)." #. (itstool) path: varlistentry/term #: C/index.docbook:1786 msgid "Description:" msgstr "Description:" #. (itstool) path: listitem/para #: C/index.docbook:1788 msgid "A longer description of the program." msgstr "Eine ausführlichere Beschreibung des Programms." #. (itstool) path: listitem/para #: C/index.docbook:1797 msgid "Specify what value(s) the program returns. (Optional)" msgstr "Geben Sie an, welche Wert(e) das Programm zurück gibt (optional)." #. (itstool) path: sect2/title #: C/index.docbook:1806 msgid "Example of program documentation." msgstr "Beispiel einer Programmdokumentation." #. (itstool) path: example/title #: C/index.docbook:1807 msgid "Program documentation block" msgstr "Programm-Dokumentationsblock" # Würde ich nicht übersetzen. Ein Entwickler schreibt stets in Englisch, # die Übersetzung ist unsere Sache. #. (itstool) path: example/programlisting #: C/index.docbook:1808 #, no-wrap msgid "" "\n" "/**\n" " * PROGRAM:test-program\n" " * @short_description: A test program\n" " * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*\n" " * @see_also: test(1)\n" " * @--arg1 *arg*: set arg1 to *arg*\n" " * @--arg2 *arg*: set arg2 to *arg*\n" " * @-v, --version: Print the version number\n" " * @-h, --help: Print the help message\n" " *\n" " * Long description of program.\n" " *\n" " * Returns: Zero on success, non-zero on failure\n" " */\n" "int main(int argc, char *argv[])\n" "{\n" "\treturn 0;\n" "}\n" msgstr "" "\n" "/**\n" " * PROGRAM:test-program\n" " * @short_description: A test program\n" " * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*\n" " * @see_also: test(1)\n" " * @--arg1 *arg*: set arg1 to *arg*\n" " * @--arg2 *arg*: set arg2 to *arg*\n" " * @-v, --version: Print the version number\n" " * @-h, --help: Print the help message\n" " *\n" " * Long description of program.\n" " *\n" " * Returns: Zero on success, non-zero on failure\n" " */\n" "int main(int argc, char *argv[])\n" "{\n" "\treturn 0;\n" "}\n" #. (itstool) path: sect1/title #: C/index.docbook:1834 msgid "Useful DocBook tags" msgstr "Nützliche DocBook-Markierungen" #. (itstool) path: sect1/para #: C/index.docbook:1836 msgid "" "Here are some DocBook tags which are most useful when documenting the code." msgstr "" "Nachfolgend finden Sie einige DocBook-Markierungen, die beim Dokumentieren " "von Code nützlich sein können." #. (itstool) path: informalexample/programlisting #: C/index.docbook:1845 #, no-wrap msgid "" "\n" "<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n" msgstr "" "\n" "<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n" #. (itstool) path: sect1/para #: C/index.docbook:1841 msgid "" "To link to another section in the GTK docs: <_:informalexample-1/> The " "linkend is the SGML/XML id on the top item of the page you want to link to. " "For most pages this is currently the part (\"gtk\", \"gdk\", \"glib\") and " "then the page title (\"Hash Tables\"). For widgets it is just the class " "name. Spaces and underscores are converted to '-' to conform to SGML/XML." msgstr "" "So erstellen Sie eine Verknüpfung zu einem anderen Abschnitt in den GTK-" "Docs: <_:informalexample-1/> »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." #. (itstool) path: informalexample/programlisting #: C/index.docbook:1858 #, no-wrap msgid "" "\n" "<function>...</function>\n" msgstr "" "\n" "<function>...</function>\n" #. (itstool) path: sect1/para #: C/index.docbook:1855 msgid "" "To refer to an external function, e.g. a standard C function: <_:" "informalexample-1/>" msgstr "" "Für einen Bezug zu einer externen Funktion, z.B. einer C-Standardfunktion: " "<_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1867 #, no-wrap msgid "" "\n" "<example>\n" " <title>Using a GHashTable.</title>\n" " <programlisting language=\"C\">\n" " ...\n" " </programlisting>\n" "</example>\n" msgstr "" "\n" "<example>\n" " <title>Using a GHashTable.</title>\n" " <programlisting language=\"C\">\n" " …\n" " </programlisting>\n" "</example>\n" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1878 #, no-wrap msgid "" "\n" "<informalexample>\n" " <programlisting language=\"C\">\n" " ...\n" " </programlisting>\n" "</informalexample>\n" msgstr "" "\n" "<informalexample>\n" " <programlisting language=\"C\">\n" " …\n" " </programlisting>\n" "</informalexample>\n" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1890 #, no-wrap msgid "" "\n" "|[<!-- language=\"C\" -->\n" " ...\n" "]|\n" msgstr "" "\n" "|[<!-- language=\"C\" -->\n" " …\n" "]|\n" #. (itstool) path: sect1/para #: C/index.docbook:1864 msgid "" "To include example code: <_:informalexample-1/> or possibly this, for very " "short code fragments which don't need a title: <_:informalexample-2/> In " "both cases, the language attribute is optional and is used as a hint to the " "syntax highlighting engine (pygments for html output). For the latter GTK-" "Doc also supports an abbreviation: <_:informalexample-3/>" msgstr "" "So fügen Sie Beispielcode ein: Vielleicht auch so, für sehr " "kurze Codeschnipsel, die keinen Titel benötigen: <_:informalexample-2/> . 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: <_:informalexample-3/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1901 #, no-wrap msgid "" "\n" "<itemizedlist>\n" " <listitem>\n" " <para>\n" " ...\n" " </para>\n" " </listitem>\n" " <listitem>\n" " <para>\n" " ...\n" " </para>\n" " </listitem>\n" "</itemizedlist>\n" msgstr "" "\n" "<itemizedlist>\n" " <listitem>\n" " <para>\n" " ...\n" " </para>\n" " </listitem>\n" " <listitem>\n" " <para>\n" " ...\n" " </para>\n" " </listitem>\n" "</itemizedlist>\n" #. (itstool) path: sect1/para #: C/index.docbook:1898 msgid "To include bulleted lists: <_:informalexample-1/>" msgstr "Für eine Liste mit Aufzählungszeichen: <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1921 #, no-wrap msgid "" "\n" "<note>\n" " <para>\n" " Make sure you free the data after use.\n" " </para>\n" "</note>\n" msgstr "" "\n" "<note>\n" " <para>\n" " Make sure you free the data after use.\n" " </para>\n" "</note>\n" #. (itstool) path: sect1/para #: C/index.docbook:1918 msgid "" "To include a note which stands out from the text: <_:informalexample-1/>" msgstr "" "Für eine nicht zum eigentlichen Text gehörende Notiz: <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1934 #, no-wrap msgid "" "\n" "<type>unsigned char</type>\n" msgstr "" "\n" "<type>unsigned char</type>\n" #. (itstool) path: sect1/para #: C/index.docbook:1931 msgid "To refer to a type: <_:informalexample-1/>" msgstr "Für einen Bezug zu einem Typ: <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1943 #, no-wrap msgid "" "\n" "<structname>XFontStruct</structname>\n" msgstr "" "\n" "<structname>XFontStruct</structname>\n" #. (itstool) path: sect1/para #: C/index.docbook:1940 msgid "" "To refer to an external structure (not one described in the GTK docs): <_:" "informalexample-1/>" msgstr "" "Für einen Bezug zu einer externen Struktur (die nicht in den GTK-Docs " "beschrieben wird): <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1952 #, no-wrap msgid "" "\n" "<structfield>len</structfield>\n" msgstr "" "\n" "<structfield>len</structfield>\n" #. (itstool) path: sect1/para #: C/index.docbook:1949 msgid "To refer to a field of a structure: <_:informalexample-1/>" msgstr "Für einen Bezug zu einem Feld einer Struktur: <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1961 #, no-wrap msgid "" "\n" "<classname>GtkWidget</classname>\n" msgstr "" "\n" "<classname>GtkWidget</classname>\n" #. (itstool) path: sect1/para #: C/index.docbook:1958 msgid "" "To refer to a class name, we could possibly use: <_:informalexample-1/> but " "you'll probably be using #GtkWidget instead (to automatically create a link " "to the GtkWidget page - see the " "abbreviations)." msgstr "" "Um sich auf einen Klassennamen zu beziehen, kann man möglicherweise " "folgendes verwenden: <_:informalexample-1/> Aber Sie verwenden vermutlich " "stattdessen #GtkWidget (um automatisch eine Verknüpfung zur GtkWidget-Seite " "zu erstellen - lesen Sie die " "Abkürzungen)." #. (itstool) path: informalexample/programlisting #: C/index.docbook:1972 #, no-wrap msgid "" "\n" "<emphasis>This is important</emphasis>\n" msgstr "" "\n" "<emphasis>This is important</emphasis>\n" #. (itstool) path: sect1/para #: C/index.docbook:1969 msgid "To emphasize text: <_:informalexample-1/>" msgstr "Zum Hervorheben von Text: <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1981 #, no-wrap msgid "" "\n" "<filename>/home/user/documents</filename>\n" msgstr "" "\n" "<filename>/home/user/documents</filename>\n" #. (itstool) path: sect1/para #: C/index.docbook:1978 msgid "For filenames use: <_:informalexample-1/>" msgstr "Für Dateinamen: <_:informalexample-1/>" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1990 #, no-wrap msgid "" "\n" "<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n" msgstr "" "\n" "<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n" #. (itstool) path: sect1/para #: C/index.docbook:1987 msgid "To refer to keys use: <_:informalexample-1/>" msgstr "Für einen Bezug zu einem Schlüssel: <_:informalexample-1/>" #. (itstool) path: chapter/title #: C/index.docbook:2000 msgid "Filling the extra files" msgstr "Füllen der zusätzlichen Dateien" #. (itstool) path: chapter/para #: C/index.docbook:2002 msgid "" "There are a couple of extra files, that need to be maintained along with the " "inline source code comments: <package>.types, " "<package>-docs.xml (in the past .sgml), " "<package>-sections.txt." msgstr "" "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." #. (itstool) path: sect1/title #: C/index.docbook:2011 msgid "Editing the types file" msgstr "Bearbeiten der Typendatei" #. (itstool) path: sect1/para #: C/index.docbook:2013 msgid "" "If your library or application includes GObjects, you want their signals, " "arguments/parameters and position in the hierarchy to be shown in the " "documentation. All you need to do, is to list the xxx_get_type functions together with their include inside the <" "package>.types file." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:2022 msgid "Example <package>.types file" msgstr "Beispiel-Schnipsel einer <package>.types-Datei" #. (itstool) path: example/programlisting #: C/index.docbook:2023 #, no-wrap msgid "" "\n" "#include <gtk/gtk.h>\n" "\n" "gtk_accel_label_get_type\n" "gtk_adjustment_get_type\n" "gtk_alignment_get_type\n" "gtk_arrow_get_type\n" msgstr "" "\n" "#include <gtk/gtk.h>\n" "\n" "gtk_accel_label_get_type\n" "gtk_adjustment_get_type\n" "gtk_alignment_get_type\n" "gtk_arrow_get_type\n" #. (itstool) path: sect1/para #: C/index.docbook:2034 msgid "" "Since GTK-Doc 1.8 gtkdoc-scan can generate this " "list for you. Just add \"--rebuild-types\" to SCAN_OPTIONS in " "Makefile.am. If you use this approach you should not " "dist the types file nor have it under version control." msgstr "" "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." #. (itstool) path: sect1/title #: C/index.docbook:2043 msgid "Editing the master document" msgstr "Bearbeiten des Master-Dokuments" #. (itstool) path: sect1/para #: C/index.docbook:2045 msgid "" "GTK-Doc produces documentation in DocBook SGML/XML. When processing the " "inline source comments, the GTK-Doc tools generate one documentation page " "per class or module as a separate file. The master document includes them " "and place them in an order." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:2052 msgid "" "While GTK-Doc creates a template master document for you, later runs will " "not touch it again. This means that one can freely structure the " "documentation. That includes grouping pages and adding extra pages. GTK-Doc " "has now a test suite, where also the master-document is recreated from " "scratch. Its a good idea to look at this from time to time to see if there " "are some new goodies introduced there." msgstr "" "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." #. (itstool) path: tip/para #: C/index.docbook:2062 msgid "" "Do not create tutorials as extra documents. Just write extra chapters. The " "benefit of directly embedding the tutorial for your library into the API " "documentation is that it is easy to link for the tutorial to symbol " "documentation. Apart chances are higher that the tutorial gets updates along " "with the library." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:2071 msgid "" "So what are the things to change inside the master document? For a start is " "only a little. There are some placeholders (text in square brackets) there " "which you should take care of." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:2078 msgid "Master document header" msgstr "Kopfzeile des Master-Dokuments" #. (itstool) path: example/programlisting #: C/index.docbook:2079 #, no-wrap msgid "" "\n" "<bookinfo>\n" " <title>MODULENAME Reference Manual</title>\n" " <releaseinfo>\n" " for MODULENAME [VERSION]\n" " The latest version of this documentation can be found on-line at\n" " <ulink role=\"online-location\" url=\"http://[SERVER]/MODULENAME/index.html\">http://[SERVER]/MODULENAME/</ulink>.\n" " </releaseinfo>\n" "</bookinfo>\n" "\n" "<chapter>\n" " <title>[Insert title here]</title>\n" msgstr "" "\n" "<bookinfo>\n" " <title>MODULENAME Reference Manual</title>\n" " <releaseinfo>\n" " for MODULENAME [VERSION]\n" " The latest version of this documentation can be found on-line at\n" " <ulink role=\"online-location\" url=\"http://[SERVER]/MODULENAME/index.html\">http://[SERVER]/MODULENAME/</ulink>.\n" " </releaseinfo>\n" "</bookinfo>\n" "\n" "<chapter>\n" " <title>[Insert title here]</title>\n" #. (itstool) path: sect1/para #: C/index.docbook:2095 msgid "" "In addition a few option elements are created in commented form. You can " "review these and enable them as you like." msgstr "" "Zusätzlich werden einige Optionselemente in Kommentarform erstellt. Sie " "können sich diese anschauen und aktivieren, wenn Sie wollen." #. (itstool) path: example/title #: C/index.docbook:2101 msgid "Optional part in the master document" msgstr "Optionaler Teil im Master-Dokument" #. (itstool) path: example/programlisting #: C/index.docbook:2102 #, no-wrap msgid "" "\n" " <!-- enable this when you use gobject introspection annotations\n" " <xi:include href=\"xml/annotation-glossary.xml\"><xi:fallback /></xi:include>\n" " -->\n" msgstr "" "\n" " <!-- aktivieren Sie dieses, wenn Sie gobject introspection-Anmerkungen verwenden\n" " <xi:include href=\"xml/annotation-glossary.xml\"><xi:fallback /></xi:include>\n" " -->\n" #. (itstool) path: sect1/para #: C/index.docbook:2110 msgid "" "Finally you need to add new section whenever you introduce one. The gtkdoc-check tool will remind " "you of newly generated xml files that are not yet included into the doc." msgstr "" "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." #. (itstool) path: example/title #: C/index.docbook:2118 C/index.docbook:2153 msgid "Including generated sections" msgstr "Einbeziehen erzeugter Abschnitte" #. (itstool) path: example/programlisting #: C/index.docbook:2119 #, no-wrap msgid "" "\n" " <chapter>\n" " <title>my library</title>\n" " <xi:include href=\"xml/object.xml\"/>\n" " ...\n" msgstr "" "\n" " <chapter>\n" " <title>my library</title>\n" " <xi:include href=\"xml/object.xml\"/>\n" " ...\n" #. (itstool) path: sect1/title #: C/index.docbook:2131 msgid "Editing the section file" msgstr "Bearbeiten der Abschnittsdatei" #. (itstool) path: sect1/para #: C/index.docbook:2133 msgid "" "The section file is used to organise the documentation output by GTK-Doc. " "Here one specifies which symbol belongs to which module or class and control " "the visibility (public or private)." msgstr "" "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)." #. (itstool) path: sect1/para #: C/index.docbook:2139 msgid "" "The section file is a plain text file with tags delimiting sections. Blank " "lines are ignored and lines starting with a '#' are treated as comment lines." msgstr "" "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." #. (itstool) path: note/para #: C/index.docbook:2146 msgid "" "While the tags make the file look like xml, it is not. Please do not close " "tags like <SUBSECTION>." msgstr "" "Zwar lassen die Markierungen die Datei wie XML erscheinen, doch der Schein " "trügt. Bitte schließen Sie keine Markierungen wie <SUBSECTION>." #. (itstool) path: example/programlisting #: C/index.docbook:2154 #, no-wrap msgid "" "\n" "<INCLUDE>libmeep/meep.h</INCLUDE>\n" "\n" "<SECTION>\n" "<FILE>meepapp</FILE>\n" "<TITLE>MeepApp</TITLE>\n" "MeepApp\n" "<SUBSECTION Standard>\n" "MEEP_APP\n" "...\n" "MeepAppClass\n" "meep_app_get_type\n" "</SECTION>\n" msgstr "" "\n" "<INCLUDE>libmeep/meep.h</INCLUDE>\n" "\n" "<SECTION>\n" "<FILE>meepapp</FILE>\n" "<TITLE>MeepApp</TITLE>\n" "MeepApp\n" "<SUBSECTION Standard>\n" "MEEP_APP\n" "...\n" "MeepAppClass\n" "meep_app_get_type\n" "</SECTION>\n" #. (itstool) path: sect1/para #: C/index.docbook:2171 msgid "" "The <FILE> ... </FILE> tag is used to specify the file name, " "without any suffix. For example, using '<FILE>gnome-config</" "FILE>' will result in the section declarations being output in the " "template file tmpl/gnome-config.sgml, which will be " "converted into the DocBook XML file xml/gnome-config.sgml or the DocBook XML file xml/gnome-config.xml. " "(The name of the HTML file is based on the module name and the section " "title, or for GObjects it is based on the GObjects class name converted to " "lower case)." msgstr "" "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)." #. (itstool) path: sect1/para #: C/index.docbook:2183 msgid "" "The <TITLE> ... </TITLE> tag is used to specify the title of the " "section. It is only useful before the templates (if used) are initially " "created, since the title set in the template file overrides this. Also if " "one uses SECTION comment in the sources, this is obsolete." msgstr "" "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." #. (itstool) path: sect1/para #: C/index.docbook:2190 msgid "" "You can group items in the section by using the <SUBSECTION> tag. " "Currently it outputs a blank line between subsections in the synopsis " "section. You can also use <SUBSECTION Standard> for standard GObject " "declarations (e.g. the functions like g_object_get_type and macros like " "G_OBJECT(), G_IS_OBJECT() etc.). Currently these are left out of the " "documentation. You can also use <SUBSECTION Private> for private " "declarations which will not be output (it is a handy way to avoid warning " "messages about unused declarations). If your library contains private types " "which you don't want to appear in the object hierarchy and the list of " "implemented or required interfaces, add them to a Private subsection. " "Whether you would place GObject and GObjectClass like structs in public or " "Standard section depends if they have public entries (variables, vmethods)." msgstr "" "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)." #. (itstool) path: sect1/para #: C/index.docbook:2209 msgid "" "You can also use <INCLUDE> ... </INCLUDE> to specify the " "#include files which are shown in the synopsis sections. It contains a comma-" "separate list of #include files, without the angle brackets. If you set it " "outside of any sections, it acts for all sections until the end of the file. " "If you set it within a section, it only applies to that section." msgstr "" "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." #. (itstool) path: chapter/title #: C/index.docbook:2223 msgid "Controlling the result" msgstr "Überprüfung des Ergebnisses" #. (itstool) path: chapter/para #: C/index.docbook:2225 msgid "" "A GTK-Doc run generates report files inside the documentation directory. The " "generated files are named: <package>-undocumented.txt, <package>-undeclared.txt and " "<package>-unused.txt. All those are plain text " "files that can be viewed and postprocessed easily." msgstr "" "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." #. (itstool) path: chapter/para #: C/index.docbook:2234 msgid "" "The <package>-undocumented.txt file starts with " "the documentation coverage summary. Below are two sections divided by blank " "lines. The first section lists undocumented or incomplete symbols. The " "second section does the same for section docs. Incomplete entries are those, " "which have documentation, but where e.g. a new parameter has been added." msgstr "" "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." #. (itstool) path: chapter/para #: C/index.docbook:2243 msgid "" "The <package>-undeclared.txt file lists symbols " "given in the <package>-sections.txt but not found " "in the sources. Check if they have been removed or if they are misspelled." msgstr "" "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." #. (itstool) path: chapter/para #: C/index.docbook:2250 msgid "" "The <package>-unused.txt file lists symbol names, " "where the GTK-Doc scanner has found documentation, but does not know where " "to put it. This means that the symbol has not yet been added to the " "<package>-sections.txt file." msgstr "" "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." #. (itstool) path: tip/para #: C/index.docbook:2258 msgid "" "Enable or add the line in Makefile." "am. If at least GTK-Doc 1.9 is installed, this will run sanity checks during " "make check run." msgstr "" "Aktivieren Sie oder fügen Sie die Zeile