GTK-Doc ay ginagamit upang idokumento C code. Ito ay kadalasang ginagamit sa mga dokumento sa pampublikong API ng mga aklatan, tulad ng GTK + at Gnome aklatan, ngunit ito rin ay maaaring magamit upang idokumento application code.
Tandaan na ang GTK-Doc ay hindi orihinal na inilaan upang maging isang tool babasahin pangkalahatang layunin, kaya maaari itong maging isang bit mahirap na setup at gamitin. Para sa isang mas makinis tool babasahin pangkalahatang-layunin na maaaring gusto mong tingnan ang mga Doxygen (http://www.doxygen.org/). Gayunpaman GTK-Doc ay may ilang mga espesyal na code upang idokumento ang mga signal at mga katangian ng GTK + widgets at GObject mga klase kung saan ang iba pang mga kasangkapan ay hindi maaaring magkaroon.
GTK-Doc ay nagpapahintulot sa iyong mga babasahin na nakasulat sa loob ng 2 mga paraan:
a) naka-embed sa loob ng source code sa espesyal na-format na mga komento.
o
b) Idinagdag sa ang mga file na 'template' na gtk-doc outputs pagkatapos ng pag-scan ang lahat ng mga file na header at pag-parse ng mga pahayag.
Mula sa mga komento ng source code at mga file ng template bumubuo GTK-Doc isang DocBook XML (o SGML) na dokumento, na kung saan ay pagkatapos ay transformed sa HTML. Ang mga nakabuo ng dokumentasyon HTML ay maaaring browse sa isang ordinaryong web browser o sa pamamagitan ng paggamit ng mga espesyal na Devhelp API browser (tingnan http://developer.imendio.com/wiki/Devhelp).
What ay bago sa release na ito:
- sumusuporta gtk-doc sa isang subset ng markdown (heading at lists) - tingnan ang
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc ay hindi bumuo ng mga file ng old devhelp anumang higit pa. Ito cuts down doc
- generation oras at gumagana para devhelp & gt;. = 0.11 (ay inilabas noong 2005)
- mga pagbabago para sa mga out-of-source dir build sanhi ng pagbasag ng mga proyekto gamit ang
- DOC_SOURCE_DIR sa isang kamag-anak na path (na builddir). Ito ay inirerekomenda na gamitin ang
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- Mga Pagbabago
- 590927: AM_SILENT_RULES Suporta para sa doc-build hakbang
- 617121: / * & lt; pribadong & gt; * / Pahayag sa enums ay ipinapakita pa rin
- 627758: Isang paraan upang huwag pansinin ang isang simbolo
- 639145: shorthand syntax para sa mga heading
- 644291: Enum parser break sa pagtatalaga ng mga ')'
- 646870: HTML_IMAGES wala na sa EXTRA_DIST
- 648,289. Gtkdoc-mkdb hindi magtala
- 648,331.: Tukuyin compatible opsyon para sa 'highlight' patuloy
- 649269: Dapat itakda gtkdoc-scanobj ilan sa kanyang sariling CFLAGS / LDFLAGS
- 650407: Buildings docs habang distchecking gumagawa ng libu-libong ng € ONO deklarasyon founda € ?? mga babala, pagkatapos ay nabigo.
- 652746: Documentation ng plain boxed structs nasira
- 652764: Update autotools config ng kaunti
- 655711: lagumin depscan output sa pamamagitan ng package
- 656453: pagpapahusay ng Pagganap (Patch)
- 656658: gtk-doc.make: i-install target ay hindi i-install ang docs kapag gusali sa isang hiwalay na direktoryo
- 656773: nabigo gtk-doc sa makahanap ng isang simbolo na ipinahayag bilang 'char * const'
- 656946: gtk-doc hindi nagawang hawakan 'ekstern maikling int'
- 657377: srcdir = builddir gagawa itapon nilalaman ng tmpl
- Contributors
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David Nea ?? bilang
- Javier JardA³n
- Jorge Gonzalez
- Mario BlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Will Thompson
- Yaakov Selkowitz
Kinakailangan :
- Perl v5
- libxslt & libxml2 2.3.6
- DocBook XSL Stylesheets
- DocBook XML DTD
- DocBook SGML DTD
- Jade v1.1 o OpenJade 1.3.1
- DocBook DSSSL Stylesheets
Mga Komento hindi natagpuan