GTK-Doc

GTK-Doc wird verwendet, um C-Code zu dokumentieren. Es wird typischerweise verwendet, um die öffentliche API von Bibliotheken, wie beispielsweise die GTK + und GNOME Dokumentbibliotheken, aber es kann auch verwendet werden, um Applikationscode zu dokumentieren.
Beachten Sie, dass GTK-Doc war ursprünglich nicht beabsichtigt, ein Allzweck-Dokumentations sein, so kann es ein wenig umständlich einzurichten und zu bedienen sein. Wollen für eine mehr poliert Allzweckdokumentations Sie vielleicht in Doxygen (http://www.doxygen.org/) zu suchen. Allerdings GTK-Doc hat einige speziellen Code, um die Signale und Eigenschaften von GTK + Widgets und GObject Klassen, die andere Tools möglicherweise nicht zu dokumentieren.
GTK-Doc können Sie in der Dokumentation zu auf 2 Arten geschrieben werden:
a) in den Source-Code in speziell formatierten Kommentaren Embedded.
oder
b) Zusammen mit den 'template' Dateien, die gtk-doc-Ausgänge nach dem Scannen alle Header-Dateien und Parsen der Erklärungen.
Aus diesen Quellcode Kommentare und Template-Dateien GTK-Doc erzeugt einen DocBook XML (oder SGML) Dokument, das dann in HTML umgewandelt. Der erzeugte HTML-Dokumentation kann in einem normalen Web-Browser oder mit Hilfe der speziellen Devhelp API-Browser durchsucht werden (siehe http://developer.imendio.com/wiki/Devhelp).

What neu ist in dieser Pressemitteilung:

• gtk-doc unterstützt einen Teil der Markdown (Überschriften und Listen) - siehe
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc erzeugt keine alten devhelp Dateien nicht mehr. Dies reduziert doc
• Generationszeit und arbeitet für devhelp & gt;. = 0,11 (erschien 2005)
• Änderungen für out-of-Source-Verzeichnis build verursacht Bruch für Projekte mit
• DOC_SOURCE_DIR mit einem relativen Pfad (zu builddir). Es wird empfohlen, zu verwenden
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Änderungen
• 590927: Unterstützung AM_SILENT_RULES für doc-Erstellungsschritte
• 617121: / * & lt; Private & gt; * / Erklärungen in Aufzählungen immer noch angezeigt werden,
• 627758: Ein Weg, um ein Symbol zu ignorieren
• 639145: Kurzschrift Syntax für Überschriften
• 644291: Enum Parser bricht auf Zuordnung ') "
• 646870: HTML_IMAGES nicht mehr in EXTRA_DIST
• 648.289. Gtkdoc-mkdb nicht kompiliert
• 648331:. Geben Sie kompatible Optionen für 'Highlight' konsequent
• 649269: gtkdoc-scanobj sollten einige seiner eigenen CFLAGS gesetzt / LDFLAGS
• 650407: Gebäude docs während distchecking produziert Tausende von € oNo Erklärung Stiftungen € ?? Warnungen, dann scheitert.
• 652746: Dokumentation der Normal boxed Strukturen gebrochen
• 652764: Update Config Autotools etwas
• 655711: Zusammenfassend depscan Ausgabe von Paket
• 656453: Performance-Verbesserungen (PATCH)
• 656658: gtk-doc.make: Installationsziel nicht docs installiert werden, wenn Gebäude in einem separaten Verzeichnis
• 656773: gtk-doc nicht um ein Symbol als "const char * '
deklariert finden
• 656946: gtk-doc nicht 'extern short int' hand
• 657377: srcdir = builddir baut verwerfen Inhalt tmpl
• Teilnehmer
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David NeA ?? wie
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Anforderungen :

• Perl v5
• libxslt & libxml2 2.3.6
• DocBook XSL-Stylesheets
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 oder OpenJade 1.3.1
• DocBook DSSSL Stylesheets