GTK-Doc

GTK-Doc gebruik word om C-kode te dokumenteer. Dit is tipies gebruik word vir die publiek API van biblioteke, soos die GTK + en GNOME biblioteke dokumenteer, maar dit kan ook gebruik word om aansoek kode dokumenteer.
Let daarop dat GTK-Doc nie oorspronklik bedoel om 'n algemene doel dokumentasie hulpmiddel wees, so dit kan 'n bietjie ongemaklik om te installeer en te gebruik. Vir 'n meer gepoleerde algemene doel dokumentasie hulpmiddel kan jy om te kyk na Doxygen (http://www.doxygen.org/). Maar GTK-Doc het 'n paar spesiale kode om die seine en eienskappe van GTK + widgets en GObject klasse wat ander instrumente nie dalk te dokumenteer.
GTK-Doc kan jou dokumentasie in 2 maniere geskryf word:
a) Embedded binne-in die bron-kode in spesiaal-geformateerde kommentaar.
of
b) Bygevoeg na die 'template' lêers wat gtk-doc uitset na die skandering al die header lêers en die ontleding van die verklarings.
Van hierdie bronkode kommentaar en sjabloon lêers GTK-Doc genereer 'n Docbook XML (of SGML) dokument, wat dan omskep in HTML. Die gegenereerde HTML dokumentasie kan gesoek in 'n gewone webblaaier of deur die gebruik van die spesiale Devhelp API leser (sien http://developer.imendio.com/wiki/Devhelp).

What is nuwe in hierdie release:

• gtk-doc ondersteun 'n subset van Afprijzingsmanager (opskrifte en lyste) - sien
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc nie genereer ou devhelp lêers nie meer nie. Dit verminder doc
• generasie tyd en werk vir devhelp & gt;. = 0,11 (vrygestel in 2005)
• veranderinge vir buite-bron dir bou veroorsaak skade vir projekte met
• DOC_SOURCE_DIR met 'n relatiewe pad (te builddir). Dit word aanbeveel om te gebruik
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Wysigings
• 590927: Support AM_SILENT_RULES vir doc-bou stappe
• 617121: / * & lt; private & gt; * / Verklarings in enums steeds vertoon
• 627758: 'n manier om 'n simbool te ignoreer
• 639145: snelskrif sintaksis vir opskrifte
• 644291: Enum parser breek opdrag van ')'
• 646870: HTML_IMAGES nie meer in EXTRA_DIST
• 648289. Gtkdoc-mkdb nie stel
• 648331. Spesifiseer versoenbaar opsies vir 'n hoogtepunt 'konsekwent
• 649269: gtkdoc-scanobj moet 'n paar van sy eie CFLAGS stel / LDFLAGS
• 650407: Geboue docs terwyl distchecking produseer duisende van 'n € Ono verklaring hoeksteen € ?? waarskuwings, dan versuim.
• 652746: Dokumentasie van plain doos structs gebreek
• 652764: autotools Update config 'n bietjie
• 655711: som depscan uitset deur pakket
• 656453: verbeterings Performance (PATCH)
• 656658: gtk-doc.make: installeer teiken nie docs installeer wanneer die bou in 'n aparte gids
• 656773: gtk-doc versuim om 'n simbool verklaar as 'char * const'
vind
• 656946: gtk-doc nie 'eksterne kort int' hanteer
• 657377: srcdir = builddir bou weggooi inhoud van tmpl
• Bydraers
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? as
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance voer
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Vereistes :

• Perl v5
• libxslt & libxml2 2.3.6
• DocBook XSL Stylblaaie
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 of OpenJade 1.3.1
• DocBook DSSSL Stylblaaie