GTK-Doc

GTK-Doc brukes til å dokumentere C-kode. Det er vanligvis brukes til å dokumentere den offentlige API av biblioteker, som GTK + og GNOME-biblioteker, men det kan også brukes til å dokumentere applikasjonskoden.
Merk at GTK-Doc ikke var opprinnelig ment å være en generell dokumentasjonsverktøy, så det kan være litt vanskelig å installere og bruke. For en mer polert generell dokumentasjonsverktøy kan det være lurt å se på Doxygen (http://www.doxygen.org/). Men GTK-Doc har noen spesiell kode for å dokumentere de signaler og egenskaper for GTK + widgets og GObject klasser som andre verktøy ikke kan ha.
GTK-Doc gjør at dokumentasjonen skal skrives på 2 måter:
a) Embedded inne i kildekoden i spesialformaterte kommentarer.
eller
b) Lagt til 'mal' filer som gtk-doc utganger etter skanning alle header-filer og analyse erklæringene.
Fra disse kildekode kommentarer og malfiler GTK-Doc genererer en Docbook XML (eller SGML) dokument, som deretter forvandlet til HTML. Den genererte HTML dokumentasjon kan bladde i en vanlig nettleser eller ved å bruke den spesielle Devhelp API nettleser (se http://developer.imendio.com/wiki/Devhelp).

What er nytt i denne versjonen:

• gtk-doc støtter en undergruppe av Markdown (overskrifter og lister) - se
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc ikke genererer gamle devhelp filer lenger. Dette kutter ned doc
• generasjonstid og arbeider for devhelp & gt;. = 0,11 (ble utgitt i 2005)
• endringer for out-of-kilde dir build forårsaket brudd for prosjekter ved hjelp av
• DOC_SOURCE_DIR med en relativ bane (til builddir). Det anbefales å bruke
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Endringer
• 590927: Støtte AM_SILENT_RULES for doc-bygge trinn
• 617121: / * & lt; Privat & gt; * / Erklæringer i enums fortsatt vises
• 627758: En måte å ignorere et symbol
• 639145: stenografi syntaks for overskrifter
• 644291: Enum parser pauser på tildeling av ')'
• 646870: HTML_IMAGES ikke lenger i EXTRA_DIST
• 648289:. Gtkdoc-mkdb ikke kompilere
• 648331.: Angi kompatible alternativer for "høydepunkt" konsekvent
• 649269: gtkdoc-scanobj bør sette noen av sine egne CFLAGS / LDFLAGS
• 650407: Bygninger docs mens distchecking produserer tusenvis av en € oNo erklæring stiftelse € ?? advarsler, så svikter.
• 652746: Dokumentasjon av vanlig eske structs brutt
• 652764: Oppdatering Autotools config litt
• 655711: oppsummere depscan produksjonen med pakken
• 656453: Ytelsesforbedringer (patch)
• 656658: gtk-doc.make: installere target installerer ikke docs når du bygger i en egen katalog
• 656773: gtk-doc ikke klarer å finne et symbol erklært som "char * const '
• 656946: gtk-doc klarer å håndtere 'extern kort int'
• 657377: srcdir = builddir bygger forkaste innholdet tmpl
• Bidragsytere
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? som
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Krav

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