GTK-Doc

GTK-Doc használják a C kódot. Ez akkor tipikus, hogy dokumentálja a nyilvános API könyvtárak, mint például a GTK + és a GNOME könyvtárak, de ez is használhatók annak dokumentálására alkalmazás kódját.
Ne feledje, hogy a GTK-Doc eredetileg nem célja, hogy egy általános célú dokumentációs eszközként, így lehet, hogy egy kicsit kínos beállítása és használata. Egy letisztultabb általános célú dokumentációs eszközként érdemes megnézni Doxygen (http://www.doxygen.org/). Azonban GTK-Doc van néhány speciális kódot, hogy dokumentálja a jeleket és tulajdonságai GTK + kütyü és GObject osztályok, amelyek más eszközökkel nem rendelkezik.
GTK-Doc lehetővé teszi a dokumentációt írandó 2 módon:
a) beágyazva a forráskód speciálisan kialakított észrevételeit.
vagy
b) hozzá kell adni a "sablon" fájlt, amely gtk-doc kimenet beolvasása után a header fájlokat és elemzés a nyilatkozatokat.
Ezekből a forráskód kommentek és a sablon fájlokat GTK-Doc generál Docbook XML (vagy SGML) dokumentum, amelyet majd át HTML. A generált HTML dokumentációt is böngészhetők egy egyszerű web-böngészővel, vagy a speciális Devhelp API böngésző (lásd http://developer.imendio.com/wiki/Devhelp).

What új ebben a kiadásban:

• gtk-doc egy részét támogatja árleszállítás (fejezetek és listák) - lásd
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc nem generál régi devhelp fájlokat többé. Ez lecsökkenti doc
• generációs idő és működik devhelp & gt; = 0,11 (2005-ben jelent).
• változtatásokat az out-of-forrás könyvtárában építmények okozott törést projektek segítségével
• DOC_SOURCE_DIR relatív elérési utat (a builddir). Javasoljuk, hogy használja a
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Változások
• 590927: Support AM_SILENT_RULES a doc-build lépések
• 617121: / * & lt; privát & gt; * / Nyilatkozatok enum továbbra is a kijelzőn
• 627758: A módja annak, hogy figyelmen kívül hagyja a szimbólum
• 639145: gyors- és szintaxis fejezetek
• 644291: Enum értelmező szünetek átengedéséért ")"
• 646870: HTML_IMAGES már nem EXTRA_DIST
• 648289: gtkdoc-mkdb nem fordul le.
• 648331: Adja kompatibilis lehetőségek "fénypontja" következetesen.
• 649269: gtkdoc-scanobj kell kitűznie a saját CFLAGS / LDFLAGS
• 650407: Épületek docs, míg distchecking termel ezer € egy Ono nyilatkozatot founda € ?? figyelmeztetések, majd leáll.
• 652746: Dokumentáció sima dobozos struktúrákat törött
• 652764: Frissítés autotools config egy kicsit
• 655711: összefoglalni depscan által kiadott csomag
• 656453: Teljesítmény fejlesztések (tapasz)
• 656658: gtk-doc.make: install cél nem telepíti docs kiépítése során egy külön könyvtárba
• 656773: gtk-doc nem talál egy szimbólum nyilvánították "const char * '
• 656946: gtk-doc tudja kezelni "extern rövid int '
• 657377: srcdir! = Builddir épít megválni tartalmát tmpl
• Közreműködők
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? mint
• Javier JardA³n
• Jorge GonzAlez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

követelmények :

• Perl V5
• libxslt & libxml2 2.3.6
• DocBook- XSL stíluslapok
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 vagy openjade 1.3.1
• DocBook- DSSSL stíluslapok