GTK-Doc è usato per documentare il codice C. Esso è tipicamente usato per documentare l'API pubblica di biblioteche, come GTK + e GNOME, ma può anche essere usato per documentare codice dell'applicazione.
Si noti che GTK-Doc non era originariamente destinato ad essere uno strumento di documentazione generico, in modo che possa essere un po 'scomodo da configurare e utilizzare. Per uno strumento di documentazione generico più lucido si consiglia di guardare Doxygen (http://www.doxygen.org/). Tuttavia GTK-Doc ha un codice speciale per documentare i segnali e le proprietà di widget GTK + e classi GObject che altri strumenti non possono avere.
GTK-Doc consente la documentazione da scrivere in 2 modi:
a) incorporato all'interno del codice sorgente nei commenti appositamente formattati.
o
b) dopo la scansione di tutti i file di intestazione e l'analisi delle dichiarazioni di recupero per il file "modello" che trasmette gtk-doc.
Da queste osservazioni del codice sorgente e file di modello GTK-Doc genera un XML Docbook (o SGML) documento, che viene poi trasformata in HTML. La documentazione HTML generato può essere sfogliati in un normale browser web oppure utilizzando il browser speciale Devhelp API (vedi http://developer.imendio.com/wiki/Devhelp).
What è nuovo in questa versione:
- gtk-doc supporta un sottoinsieme di riduzione dei prezzi (rubriche ed elenchi) - vedi
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc non genera vecchio devhelp file più. Questo riduce doc
- tempo di generazione e lavora per devhelp & gt;. = 0,11 (è stato rilasciato nel 2005)
- cambiamenti per out-of-source dir accumulo causato la rottura di progetti utilizzando
- DOC_SOURCE_DIR con un percorso relativo (per builddir). Si consiglia di usare
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- modifiche
- 590.927: AM_SILENT_RULES di supporto alla procedura doc-costruire
- 617.121: / * & lt; privato & gt; * / Dichiarazioni in enumerazioni sono ancora visualizzati
- 627.758: un modo per ignorare il simbolo
- 639.145: sintassi abbreviata per le intestazioni
- 644.291: le interruzioni di Enum parser sull'assegnazione del ')'
- 646.870: non più in EXTRA_DIST HTML_IMAGES
- 648.289. Gtkdoc-mkdb non compila
- 648.331:. Specificare le opzioni compatibili per 'clou' costantemente
- 649.269: gtkdoc-scanobj dovrebbe fissare alcune delle proprie CFLAGS / LDFLAGS
- 650.407: Edifici documenti mentre distchecking produce migliaia di € Ono dichiarazione fondazioni € ?? avvertimenti, poi fallisce.
- 652.746: Documentazione di struct scatola di pianura rotto
- 652.764: Aggiornamento autotools config un po '
- 655.711: riassumere uscita depscan dal pacchetto
- 656.453: miglioramenti delle prestazioni (PATCH)
- 656.658: gtk-doc.make: installare bersaglio non installa documentazione quando si costruisce in una directory separata
- 656.773: gtk-doc non riesce a trovare un simbolo dichiarato come 'char * const'
- 656.946: gtk-doc in grado di gestire 'short int extern'
- 657.377: srcdir = builddir costruisce scartare contenuti di tmpl
- Collaboratori
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David NEA ?? come
- Javier JardA³n
- Jorge Gonzalez
- Mario BlA¤ttermann
- Matthias Clasen
- MichaÅ, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Will Thompson
- Yaakov Selkowitz
Requisiti
- 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 fogli di stile
I commenti non trovato