GTK-Doc C kodu belgelemek için kullanılır. Bu tipik olarak, GTK + ve Gnome kitaplıkları gibi kütüphaneler, halka API belge için kullanılır, ama aynı zamanda bir uygulama kodunu belge için kullanılabilir.
GTK-Doc aslında bir genel amaçlı dokümantasyon aracı olması amaçlanmıştır olmadığını unutmayın, bu nedenle kurulum ve kullanım biraz garip olabilir. Bir daha parlak genel amaçlı belgeleri aracı için size Doxygen (http://www.doxygen.org/) bakmak isteyebilirsiniz. Ancak GTK-Doc GTK + widget ve diğer araçları olmayabilir GObject sınıfların sinyalleri ve özelliklerini belgelemek için bazı özel kodu vardır.
GTK-Doc sizin dokümantasyon 2 şekilde yazılmasına izin verir:
a) özel olarak biçimlendirilmiş yorumlarda kaynak kodu içinde Embedded.
veya
b) Tüm başlık dosyalarını tarayarak ve beyanları ayrıştırma sonra 'şablon' dosyalar gtk-doc çıkışları eklendi.
Bu kaynak kodu yorumlar ve şablon dosyalarını GTK-Doc sonra HTML dönüşür DocBook XML (veya SGML) belge üretir itibaren. Oluşturulan HTML belgeleri sıradan bir web tarayıcısında veya özel DevHelp API tarayıcısı kullanarak taranabilir (http://developer.imendio.com/wiki/Devhelp).
What yeni bakınız Bu sürümde :
- gtk-doc markdown (başlıklar ve listeler) bir alt kümesini destekler - bkz
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc eski DevHelp bir daha dosyaları oluşturmaz. Bu doc keser
- nesil zamanı ve DevHelp & gt için çalışır;. = 0.11 (2005 yılında yayımlanmıştır)
- out-of-kaynak dir kurmak için değişiklikler kullanan projeler için kırılması neden
- (builddir kadar) göreli bir yol ile DOC_SOURCE_DIR. Bu kullanılması tavsiye edilir
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- Değişiklikleri
- 590927: doc-build adımlar için destek AM_SILENT_RULES
- 617121: / * & lt; Özel & gt; * / Çeteleler bildirimleri hala görüntülenir
- 627758: bir sembol göz ardı etmek bir yolu
- 639145: başlıklar için kestirme sözdizimi
- 644291: atama üzerine Enum ayrıştırıcı sonları ')
- 646870: artık EXTRA_DIST içinde HTML_IMAGES
- 648289:. Gtkdoc-mkdb derleme değil
- 648331:. Sürekli 'vurgulamak için' uyumlu seçeneklerini belirleyin
- 649269: gtkdoc-scanobj kendi CFLAGS bazı ayarlamanız gerekir / LDFLAGS
- 650407: distchecking bir € Ono beyan tesisleri yok € binlerce üretirken Binalar docs ?? uyarılar, sonra başarısız olur.
- 652746: kırık düz kutulu yapılar Belgeleme
- 652764: Biraz konfigürasyon Güncelleme Autotools
- 655711: paketiyle depscan çıktı özetlemek
- 656453: Performans iyileştirmeleri (PATCH)
- 656658: gtk-doc.make: Ayrı bir dizinde oluştururken docs yüklemez hedef yüklemek
- 656773: gtk-doc 'char * const' olarak bildirilmiş bir sembol bulmak için başarısız
- 656946: 'extern kısa int' işlemek için gtk-doc yapamaz
- 657377: SRCDIRın = builddir tmpl içeriğini silmek oluşturur
- Sanatçılar
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David NEA ?? olarak
- Javier JardA³n
- Jorge Gonzalez
- Mario BlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Will Thompson
- Yaakov Selkowitz
Gereksinimleri :
- Perl v5
- libxslt & libxml2 2.3.6
- DocBook XSL Stylesheets
- DocBook XML DTD
- DocBook SGML DTD
- Jade v1.1 veya OpenJade 1.3.1
- DocBook DSSSL Stylesheets
Yorum Bulunamadı