GTK-Doc

GTK-Doc digunakan untuk mendokumentasikan kode C. Hal ini biasanya digunakan untuk mendokumentasikan API publik perpustakaan, seperti + GTK dan GNOME perpustakaan, tetapi juga dapat digunakan untuk mendokumentasikan kode aplikasi.
Perhatikan bahwa GTK-Doc awalnya tidak dimaksudkan untuk menjadi alat dokumentasi untuk keperluan umum, sehingga dapat sedikit canggung untuk setup dan menggunakan. Untuk alat dokumentasi tujuan umum lebih halus Anda mungkin ingin melihat Doxygen (http://www.doxygen.org/). Namun GTK-Doc memiliki beberapa kode khusus untuk mendokumentasikan sinyal dan sifat GTK + widget dan kelas GObject yang alat-alat lain mungkin tidak memiliki.
GTK-Doc memungkinkan dokumentasi Anda yang akan ditulis dalam 2 cara:
a) Tertanam dalam kode sumber dalam komentar khusus diformat.
atau
b) Ditambahkan ke 'Template' file yang output gtk-doc setelah pemindaian semua file header dan parsing deklarasi.
Dari komentar kode sumber tersebut dan file template GTK-Doc menghasilkan DocBook XML (atau SGML) dokumen, yang kemudian diubah menjadi HTML. Dokumentasi HTML yang dihasilkan dapat diakses di web browser biasa atau dengan menggunakan browser Devhelp API khusus (lihat http://developer.imendio.com/wiki/Devhelp).

What baru dalam rilis ini:

• gtk-doc mendukung subset dari penurunan harga (judul dan daftar) - lihat
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc tidak menghasilkan devhelp tua file lagi. Ini menghemat doc
• waktu generasi dan bekerja untuk devhelp & gt;. = 0,11 (dirilis pada 2005)
• perubahan untuk out-of-sumber dir membangun disebabkan kerusakan untuk proyek-proyek menggunakan
• DOC_SOURCE_DIR dengan path relatif (untuk builddir). Disarankan untuk menggunakan
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Perubahan
• 590.927: Dukungan AM_SILENT_RULES untuk langkah doc-membangun
• 617.121: / * & lt; pribadi & gt; * / Deklarasi di enum masih ditampilkan
• 627.758: Sebuah cara untuk mengabaikan simbol
• 639.145: sintaks singkatan untuk judul
• 644.291: Enum parser istirahat pada tugas dari ')'
• 646.870: HTML_IMAGES tidak lagi di EXTRA_DIST
• 648.289:. Gtkdoc-mkdb tidak mengkompilasi
• 648.331:. Tentukan Pilihan kompatibel untuk 'highlight' konsisten
• 649.269: gtkdoc-scanobj harus menetapkan beberapa CFLAGS sendiri / LDFLAGS
• 650.407: Bangunan docs sementara distchecking menghasilkan ribuan dari € oNo deklarasi pondasi € ?? peringatan, kemudian gagal
.
• 652.746: Dokumentasi struct kotak polos rusak
• 652.764: Perbarui autotools config sedikit
• 655.711: meringkas keluaran depscan oleh paket
• 656.453: Kinerja perbaikan (PATCH)
• 656.658: gtk-doc.make: memasang target tidak menginstal docs ketika membangun dalam direktori terpisah
• 656.773: gtk-doc gagal untuk menemukan simbol dinyatakan sebagai 'char * const'
• 656.946: gtk-doc mampu menangani 'extern int singkat'
• 657.377: srcdir = builddir membangun membuang isi tmpl
• Kontributor
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? sebagai
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Persyaratan :

• Perl v5
• libxslt & libxml2 2.3.6
• DocBook XSL stylesheet
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 atau OpenJade 1.3.1
• DocBook DSSSL Stylesheets