"GTK-doc naudojamas dokumentas C kodą. Ji paprastai naudojamas patvirtinti, viešąjį API bibliotekų, tokių kaip GNOME bibliotekų ir GTK +, bet ji taip pat gali būti naudojamas patvirtinti programos kodą.
Atkreipkite dėmesį, kad GTK-doc pradžių nebuvo skirtas būti bendrosios paskirties dokumentacija priemonė, todėl ji gali būti šiek tiek nepatogu įdiegti ir naudoti. Norėdami daugiau poliruoto bendrosios paskirties dokumentų įrankį galite pažvelgti doxygen (http://www.doxygen.org/). Tačiau GTK-doc turi specialų kodą dokumentuoti signalus ir savybes GTK + raštai ir gobject klases, kiti įrankiai negali turėti.
GTK-doc leidžia jūsų dokumentacija turi būti parašyta 2 būdais:
) Įterptosios viduje kodo į specialiai suformatuotas komentarus.
arba
b) pridedamas prie "šabloną" failai, kurie GTK-doc išėjimai po nuskaitymo visas antraštės failai ir apdorojant deklaracijas.
Iš šių šaltinių kodų pastabas ir šablonų failus GTK-doc generuoja DocBook XML (arba SGML) dokumentą, kuris vėliau virstų HTML. Generuoja HTML dokumentus galima naršyti įprasta naršyklėje arba naudojant specialų DevHelp API naršyklę (žr http://developer.imendio.com/wiki/Devhelp).
What naujo , šioje laidoje:
- GTK-doc palaiko reklamos kainos (išlaidų kategorijas ir sąrašus) poaibį - pamatyti,
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- GTK-doc nesukuria senas DevHelp failus, bet daugiau. Tai mažina doc
- kartos laikas ir dirba DevHelp & gt;. = 0,11 (buvo išleistas 2005 metais);
- pokyčiai "out-of-šaltinio rež statyti sukėlė lūžimo projektams naudojant"
- DOC_SOURCE_DIR santykinis kelias (iki builddir). Patartina naudoti
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- Pokyčiai
- 590.927: Paramos AM_SILENT_RULES DOC-statyti etapais,
- 617.121: / * & lt; privatus & gt; * / Deklaracijos enums vis dar rodomas,
- 627.758: būdas ignoruoti simbolį,
- 639.145: sutrumpinimas sintaksė pozicijose;
- 644.291: Enum analizatoriaus pertraukos perleidimo ")";
- 646.870: HTML_IMAGES nebėra EXTRA_DIST
- 648.289:. Gtkdoc-mkdb neturi sudaryti;
- 648.331:. Nurodykite suderinamus galimybes "išryškinti" parodo,
- 649.269: gtkdoc-scanobj turėtų nustatyti kai kurių savo CFLAGS / LDFLAGS
- 650.407: Pastatai dokumentai, o distchecking gamina tūkstančius â € Ono deklaracija founda € ?? įspėjimai, tada nepavyksta. "
- 652.746: Dokumentacija paprasto supakuota structs suskaidytas
- 652.764: Atnaujinti autotools config truputį;
- 655.711: apibendrinti depscan produkciją paketą
- 656.453: Veikimo patobulinimai (FRAGMENTAS)
- 656.658: GTK-doc.make: įdiegti tikslą nėra įdiegti docs statant atskirame kataloge;
- 656.773: GTK-doc nepavyksta rasti simbolį deklaruotos kaip "char * const"
- 656.946: GTK-doc negali dirbti "extern trumpas int '
- 657377: srcdir = builddir stato išmesti turinį tmpl
- Bendraautoriai "
- Bakaoukas Nikolaos,
- Claude Paroz
- Danielis Mustieles
- Davidas Necas
- Davidas nea ?? kaip "
- Javier JardA³n
- Jorge Gonzalez,
- Mario BlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- Shaunas McCance
- Stefanas Sauer (Kost)
- Ar Thompsonas,
- Jokūbas Selkowitz
Reikalavimai
- Perlas V5,
- libxslt & libxml2 2.3.6;
- Docbook XSL stilių lentelės,
- DocBook XML DTD,
- DocBook SGML DTD,
- Jade v1.1 arba OpenJade 1.3.1;
- Docbook DSSSL Stilių,
Komentarai nerastas