GTK-Doc

GTK-Doc bruges til at dokumentere C-kode. Det er typisk anvendt til at dokumentere den offentlige API af biblioteker, såsom GTK + og GNOME-biblioteker, men det kan også bruges til at dokumentere applikationskode.
Bemærk, at GTK-Doc ikke var oprindelig beregnet til at være et generelt formål dokumentationsredskab, så det kan være en smule akavet at installere og bruge. For en mere poleret dokumentation generelle formål værktøj, du måske ønsker at se på Doxygen (http://www.doxygen.org/). Men GTK-Doc har nogle speciel kode for at dokumentere de signaler og egenskaber GTK + widgets og GObject klasser, som andre værktøjer måske ikke har.
GTK-Doc giver din dokumentation, der skal skrives på 2 måder:
a) Embedded inde i kildekoden i specielt formaterede kommentarer.
eller
b) Tilføjet til 'skabelon' filer, som gtk-doc udgange efter scanning af alle header-filer og parsing erklæringerne.
Fra disse kildekode kommentarer og skabelonfiler GTK-Doc genererer en Docbook XML (eller SGML) dokument, som derefter omdannes til HTML. Den genererede HTML dokumentation kan gennemses i en almindelig webbrowser eller ved at bruge den specielle Devhelp API browser (se http://developer.imendio.com/wiki/Devhelp).

What er nyt i denne udgivelse:

• gtk-doc understøtter en delmængde af 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 mere. Det skærer ned doc
• generation tid og arbejder for DevHelp & gt;. = 0,11 (udkom i 2005)
• ændringer for out-of-source dir build forårsagede brud til projekter ved hjælp af
• DOC_SOURCE_DIR med en relativ sti (for at builddir). Det anbefales at bruge
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• ændringer
• 590927: Support AM_SILENT_RULES til doc-bygge trin
• 617121: / * & lt; private & gt; * / Erklæringer i Gentagelsestyper stadig vises
• 627758: En måde at ignorere et symbol
• 639145: stenografi syntaks for overskrifter
• 644291: Enum parser pauser på tildeling af ') «
• 646870: HTML_IMAGES ikke længere i EXTRA_DIST
• 648289:. Gtkdoc-mkdb ikke kompilere
• 648331:. Angiv kompatible muligheder for "highlight" konsekvent
• 649269: gtkdoc-scanobj bør sætte nogle af sine egne CFLAGS / LDFLAGS
• 650407: Bygninger docs mens distchecking producerer tusindvis af en € Ono erklæring fundament € ?? advarsler, så mislykkes.
• 652746: Dokumentation af glatte boxed structs brudt
• 652764: Opdatering autotools config lidt
• 655711: opsummere depscan output ved pakke
• 656453: ydeevne forbedringer (PATCH)
• 656658: gtk-doc.make: installere målet ikke installeres docs når man bygger i en separat mappe
• 656773: gtk-doc undlader at finde et symbol angivet som 'char * const "
• 656946: gtk-doc i stand til at håndtere 'extern short int "
• 657377: srcdir = builddir bygger kassere indholdet af tmpl
• Bidragydere
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? som
• Javier JardA³n
• Jorge González
• 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 Stylesheets
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 eller OpenJade 1.3.1
• DocBook DSSSL Stylesheets