GTK-Doc wordt gebruikt om C-code te documenteren. Het wordt meestal gebruikt om de publieke API bibliotheken, zoals GTK + en GNOME bibliotheken documenteren, maar het kan ook worden gebruikt om toepassingscode document.
Merk op dat GTK-Doc oorspronkelijk niet bedoeld was om een algemene documentatie hulpmiddel zijn, dus het kan een beetje lastig te installeren en te gebruiken zijn. Voor een meer gepolijste general-purpose documentatiehulpmiddel wilt u misschien om te kijken naar Doxygen (http://www.doxygen.org/). Maar GTK-Doc heeft een aantal speciale code om de signalen en de eigenschappen van GTK + widgets en GObject klassen die andere instrumenten niet kunnen hebben documenteren.
GTK-Doc maakt uw documentatie op 2 manieren worden geschreven:
a) Embedded in de broncode in speciaal opgemaakte opmerkingen.
of
b) toegevoegd aan de 'template' bestanden die gtk-doc uitgangen na het scannen van alle header bestanden en het ontleden van de verklaringen.
Uit deze broncode opmerkingen en template bestanden GTK-Doc genereert een DocBook XML (of SGML) document, dat vervolgens wordt omgezet in HTML. De gegenereerde HTML-documentatie kan worden gebladerd in een gewone webbrowser of met behulp van de speciale devhelp API browser (zie http://developer.imendio.com/wiki/Devhelp).
What is nieuw in deze release:
- gtk-doc ondersteunt een subset van de afwaardering (koppen en lijsten) - zie
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc genereert geen oude devhelp bestanden niet meer. Dit vermindert doc
- generatie tijd en werkt voor devhelp & gt;. = 0,11 (werd uitgebracht in 2005)
- veranderingen voor out-of-source dir build veroorzaakt breuk voor projecten met behulp van
- DOC_SOURCE_DIR met een relatief pad (tot builddir). Het wordt aanbevolen om te gebruiken
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- Wijzigingen
- 590.927: Ondersteuning AM_SILENT_RULES voor doc-bouwen stappen
- 617.121: / * & lt; private & gt; * / Verklaringen in opsommingen zijn nog steeds weergegeven
- 627.758: een manier om een symbool te negeren
- 639.145: steno syntax voor de rubrieken
- 644.291: Enum parser pauzes in opdracht van ')'
- 646.870: HTML_IMAGES niet meer in EXTRA_DIST
- 648.289. Gtkdoc-mkdb niet compileert
- 648.331. Geef compatibele opties voor 'hoogtepunt' consequent
- 649.269: gtkdoc-scanobj moet een aantal van haar eigen CFLAGS set / LDFLAGS
- 650.407: Gebouwen docs terwijl distchecking produceert duizenden van € o Geen verklaring Founda € ?? waarschuwingen, dan is mislukt.
- 652.746: Documentatie van plain boxed structuren gebroken
- 652.764: autotools bijwerken config een beetje
- 655.711: samenvatten depscan uitgang per pakket
- 656.453: Performance verbeteringen (PATCH)
- 656.658: gtk-doc.make: installeer doel niet docs geïnstalleerd bij het bouwen in een aparte map
- 656.773: gtk-doc niet in slaagt om een symbool uitgeroepen als 'char * const' zoeken
- 656.946: gtk-doc niet in staat om 'extern short int' verwerken
- 657.377! Srcdir = builddir bouwt weggooien inhoud van tmpl
- Medewerkers
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David Nea ?? als
- Javier JardA³n
- Jorge Gonzalez
- Mario BlA¤ttermann
- Matthias Clasen
- MichaÃ, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Will Thompson
- Yaakov Selkowitz
Eisen
- Perl v5
- libxslt & libxml2 2.3.6
- DocBook XSL Stylesheets
- DocBook XML DTD
- DocBook SGML DTD
- Jade v1.1 of OpenJade 1.3.1
- DocBook DSSSL Stylesheets
Reacties niet gevonden