GTK-Doc este folosit pentru a documenta codul C. Acesta este de obicei folosit pentru a documenta API publică de biblioteci, cum ar fi GTK + și biblioteci GNOME, dar poate fi de asemenea folosite pentru a documenta codul aplicației.
Rețineți că GTK-Doc nu a fost destinat inițial pentru a fi un instrument de documentare, de uz general, astfel încât acesta poate fi un pic ciudat de instalat și utilizat. Pentru un instrument de documentare de uz general mai lustruit poate doriți să se uite la Doxygen (http://www.doxygen.org/). Cu toate acestea GTK-Doc are unele cod special pentru a documenta semnalele și proprietățile GTK + widget-uri și clase GObject care alte instrumente nu pot avea.
GTK-Doc permite documentația să fie scris în 2 moduri:
a) încorporat în interiorul codul sursă în comentariile special formatate.
sau
b) se adaugă la fișierele "șablon", care ieșiri gtk-doc după scanarea tuturor fișierelor antet și parsarea declarațiile.
Din aceste observații de cod sursă și fișiere șablon GTK-Doc generează un document DocBook XML (sau SGML), care este apoi transformat în HTML. Documentația HTML generat poate fi deschis într-un browser web obișnuit sau cu ajutorul special browser Devhelp API (vezi http://developer.imendio.com/wiki/Devhelp).
What este nou în această versiune:
- gtk-doc suportă un subset de Markdown (pozițiile și liste) - a se vedea
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc nu generează Devhelp vechi fișiere mai. Acest taie doc
- timp de generare și lucrări pentru Devhelp & gt;. = 0,11 (a fost lansat în 2005)
- schimbări out-of-source dir construi cauzat ruperea de proiecte folosind
- DOC_SOURCE_DIR cu o cale relativă (la builddir). Se recomandă să utilizați
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- Modificările
- 590927: AM_SILENT_RULES sprijin pentru măsuri-doc construi
- 617121: / * & lt; privat & gt; * / Declarațiile din ENUM sunt încă afișate
- 627758: Un mod de a ignora un simbol
- 639145: sintaxa prescurtarea pentru pozițiile
- 644291: pauze Enum parser pe cesiune de ")"
- 646870: nu mai sunt în EXTRA_DIST HTML_IMAGES
- 648289:. Gtkdoc-mkdb nu compila
- 648331:. Specificați opțiunile compatibile pentru 'highlight "constant
- 649269: gtkdoc-scanobj ar trebui să stabilească unele dintre propriile sale CFLAGS / LDFLAGS
- 650407: Cladiri docs în timp ce distchecking produce mii de € Ono declarație fundații € ?? avertismente, apoi nu.
- 652746: Documentarea struct simplu cutie rupt
- 652764: Actualizare autotools config un pic
- 655711: rezumat ieșire depscan de pachet
- 656453: îmbunătățiri de performanță (PATCH)
- 656658: gtk-doc.make: instala țintă nu se instalează docs atunci când construirea într-un director separat
- 656773: gtk-doc nu a găsi un simbol declarat "char * const"
- 656946: gtk-doc în imposibilitatea de a gestiona "int scurt extern"
- 657377: srcdir = builddir construiește aruncați conținutul tmpl
- colaboratori
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David Nea ?? ca
- Javier JardA³n
- Jorge Gonzalez
- Mario BlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Va Thompson
- Yaakov Selkowitz
Cerințe :
- Perl v5
- libxslt si libxml2 2.3.6
- DocBook XSL Stylesheets
- DocBook XML DTD
- DocBook SGML DTD
- Jade v1.1 sau OpenJade 1.3.1
- DocBook DSSSL Stylesheets
Comentariile nu a fost găsit