GTK-Doc

GTK-Doc käytetään dokumentoida C-koodia. Sitä käytetään tyypillisesti dokumentoida yleisölle API-kirjastojen, kuten GTK + ja Gnome kirjastoja, mutta se voi myös voidaan dokumentoida sovelluksen koodi.
Huomaa, että GTK-Doc ei alun perin tarkoitus olla yleiskäyttöinen dokumentointitarkoituksiin, joten se voi olla hieman hankala asentaa ja käyttää. Saat hiotumpi yleiskäyttöinen dokumentointitarkoituksiin voit tarkastella Doxygen (http://www.doxygen.org/). Kuitenkin GTK-Doc on joitakin erityisiä koodi dokumentoida signaaleja ja ominaisuudet GTK + widgetit ja GObject luokat jotka muita välineitä ei välttämättä ole.
GTK-Doc mahdollistaa asiakirjoja kirjoitetaan 2 tavalla:
) Embedded sisällä lähdekoodia erityisesti muotoiltuja kommentteja.
tai
b) Lisätty "template" tiedostoja, jotka gtk-doc lähdöt skannauksen jälkeen kaikki header-tiedostot ja jäsentäminen ilmoituksista.
Näiden lähdekoodi kommentit ja mallitiedostot GTK-Doc luo DocBook XML (tai SGML) asiakirja, joka sitten muunnetaan HTML. Luotu HTML asiakirjat voidaan selailla tavallisessa selaimella tai käyttämällä erityistä Devhelp API selaimen (ks http://developer.imendio.com/wiki/Devhelp).

What on uusi tässä julkaisussa:

• gtk-doc tukee osaa markdown (otsikot ja luettelot) - katso
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc ei tuota vanhaa devhelp tiedostot enää. Tämä vähentää doc
• sukupolven ajan ja toimii devhelp & gt; = 0,11 (julkaistiin vuonna 2005).
• muutoksia out-of-source dir build aiheuttama rikkoutuminen hankkeiden avulla
• DOC_SOURCE_DIR joiden suhteellinen polku (ja builddir). On suositeltavaa käyttää
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Muutokset
• 590927: Tuki AM_SILENT_RULES for doc-rakentaa vaiheet
• 617121: / * & lt; yksityinen & gt; * / Ilmoitusten enums vielä näkyvissä
• 627758: tapa sivuuttaa symboli
• 639145: lyhenteenä syntaksi otsikoiden
• 644291: Enum parser taukoja luovutus ")"
• 646870: HTML_IMAGES enää EXTRA_DIST
• 648289: gtkdoc-mkdb ei kokoa.
• 648331: Määritä yhteensopiva vaihtoehdot "highlight" jatkuvasti.
• 649269: gtkdoc-scanobj tulisi asettaa joitakin omia CFLAGS / LDFLAGS
• 650407: Buildings docs vaikka distchecking tuottaa tuhansia € Ono ilmoituksen rahastoista € ?? varoitukset, sitten epäonnistuu.
• 652746: Documentation tavallista boxed structs rikki
• 652764: Päivitä autotools config bit
• 655711: yhteenveto depscan lähtönä paketti
• 656453: Suorituskyvyn parannukset (PATCH)
• 656658: gtk-doc.make: Asenna kohde ei asenna docs rakennettaessa erilliseen hakemistoon
• 656773: gtk-doc ei löydä symbolin ilmoitettu "char * const"
• 656946: gtk-doc pysty käsittelemään "extern lyhyen int"
• 657377: srcdir! = Builddir rakentaa hävitä sisältö tmpl
• Avustajat
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? kuin
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

vaatimukset

• Perl V5
• libxslt & libxml2 2.3.6
• DocBook XSL Tyylitaulukkoja
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 tai OpenJade 1.3.1
• DocBook DSSSL Tyylitaulukkoja