GTK-Doc

GTK-Doc se používá k dokumentu C kód. To se obvykle používá k dokumentaci veřejné API knihoven, jako je GTK + a knihovnách GNOME, ale to může také být použit pro zdokumentování kód aplikace.
Všimněte si, že GTK-Doc nebyl původně zamýšlel být univerzální dokumentace nástroj, tak to může být trochu trapné, aby nastavení a používání. Pro více leštěné nástroj univerzální dokumentace možná budete chtít podívat na Doxygen (http://www.doxygen.org/). Nicméně GTK-Doc má nějaký speciální kód dokumentovat signály a vlastnosti GTK + widgetů a GObject tříd, které jiné nástroje mohou nemají.
GTK-Doc umožňuje, aby Vaše dokumenty, které mají být napsán ve 2 způsoby:
a) Embedded uvnitř zdrojového kódu v speciálně formátovaných komentářů.
nebo
b) přičtena k "šablona" souborů, které gtk-doc výstupy po naskenování všechny soubory záhlaví a parsování prohlášení.
Z těchto zdrojový kód komentáře a soubory šablony GTK-Doc generuje Docbook XML (nebo SGML) dokument, který je pak transformována do HTML. Generované dokumentace HTML lze prohlížet v běžném webovém prohlížeči nebo pomocí speciálního Devhelp API prohlížeč (viz http://developer.imendio.com/wiki/Devhelp).

What je nového v této verzi:

• gtk-doc podporuje podmnožinu srážky (nadpisy a seznamy) - viz
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc negeneruje starý Devhelp soubory nic víc. To snižuje doc
• generační doba a pracuje pro Devhelp & gt;. = 0,11 (byl propuštěn v roce 2005)
• změny pro out-of-zdroje dir sestavení způsobil poškození projektů pomocí
• DOC_SOURCE_DIR s relativní cesty (na builddir). Doporučuje se používat
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Změny
• 590.927: Podpůrné AM_SILENT_RULES pro doc-stavět kroky
• 617121: / * & lt; soukromá & gt; * / Prohlášení v výčtových typů jsou stále zobrazeny
• 627758: způsob, jak ignorovat symbol
• 639145: zkrácený syntaxe čísel
• 644291: Enum parser přestávky o postoupení "),"
• 646870: HTML_IMAGES již není v EXTRA_DIST
• 648289:. Gtkdoc-mkdb nezkompiluje
• 648331:. Určete kompatibilní možnosti pro "zlatý hřeb" důsledně
• 649269: gtkdoc-scanobj měli nastavit některé ze svých vlastních CFLAGS / LDFLAGS
• 650407: Budovy docs zatímco distchecking produkuje tisíce za € Ono prohlášení nadací € ?? varování, pak se nezdaří.
• 652746: Dokumentace hladkých orámovaných structs zlomený
• 652764: Aktualizace autotools config trochu
• 655711: shrnout depscan výkon o balíku
• 656453: Zlepšení výkonu (PATCH)
• 656658: gtk-doc.make: instalovat cíl nenainstaluje docs při stavbě v samostatném adresáři
• 656773: gtk-doc nepodaří najít symbol, deklarované jako "const char *"
• 656946: gtk-doc nezvládají "extern krátký int '
• 657377:! Zdrojovém adresáři = builddir staví odhodit obsah tmpl
• Přispěvatelé
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Nečas
• David Nea ?? jako
• Javier JardA³n
• Jorge González
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Požadavky na :

• Perl v5
• libxslt a libxml2 2.3.6
• DocBook XSL styly
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 nebo OpenJade 1.3.1
• DocBook DSSSL Styly