GTK-Doc används för att dokumentera C-kod. Det är oftast används för att dokumentera den offentliga API bibliotek, såsom GTK + och GNOME-biblioteken, men det kan också användas för att dokumentera programkoden.
Observera att GTK-Doc inte ursprungligen var avsedd att vara ett allmänt ändamål dokumentationshjälpmedel, så det kan vara lite krångligt att installera och använda. För en mer polerad allmänt ändamål dokumentationshjälpmedel kan du vill titta på Doxygen (http://www.doxygen.org/). Men GTK-Doc har några speciella kod för att dokumentera signaler och egenskaperna hos GTK + widgets och GObject klasser som andra verktyg inte kan ha.
GTK-Doc gör att din dokumentation som ska skrivas på 2 sätt:
a) inbäddad i källkoden i special formaterade kommentarer.
eller
b) Till de "mall" filer som gtk-doc utgångar efter skanning alla header-filer och tolka deklarationerna.
Från dessa källkod kommentarer och mallfiler GTK-Doc genererar en Docbook XML (eller SGML) dokument, som sedan omvandlas till HTML. Den genererade HTML-dokumentation kan bläddra i en vanlig webbläsare eller med hjälp av special Devhelp API webbläsare (se http://developer.imendio.com/wiki/Devhelp).
What är nytt i den här versionen:
- gtk-doc stöder en delmängd av markdown (rubriker och listor) - se
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- gtk-doc inte genererar gamla devhelp filer längre. Detta minskar doc
- generationstid och arbetar för devhelp & gt;. = 0,11 (släpptes 2005)
- förändringar för out-of-source dir bygga orsakade brott för projekt med hjälp av
- DOC_SOURCE_DIR med en relativ sökväg (till builddir). Det rekommenderas att använda
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- ändringar
- 590.927: Stöd AM_SILENT_RULES för doc-build steg
- 617.121: / * & lt; privat & gt; * / Deklarationer i enums fortfarande visas
- 627.758: Ett sätt att ignorera en symbol
- 639.145: stenografi syntax för rubriker
- 644.291: Enum parser raster på uppdrag av ")"
- 646.870: HTML_IMAGES inte längre EXTRA_DIST
- 648.289. Gtkdoc-mkdb inte kompilera
- 648.331. Ange kompatibla alternativ för "highlight" konsekvent
- 649.269: gtkdoc-scanobj bör sätta några av sina egna CFLAGS / LDFLAGS
- 650.407: Byggnader docs medan distchecking producerar tusentals av € ONO deklaration Stiftelsen € ?? varningar, sedan misslyckas.
- 652.746: Dokumentation av vanliga boxed structs brutna
- 652.764: Uppdatera autotools config lite
- 655.711: sammanfatta depscan produktionen med paketet
- 656.453: Prestandaförbättringar (patch)
- 656.658: gtk-doc.make: installera målet inte installera docs när man bygger i en separat katalog
- 656.773: gtk-doc inte hitta en symbol som deklarerats som "char * const"
- 656.946: gtk-doc inte hantera "extern kort int '
- 657.377: srcdir = builddir bygger kassera innehållet i tmpl
- Medverkande
- Bakaoukas Nikolaos
- Claude Paroz
- Daniel Mustieles
- David Necas
- David Nea ?? som
- Javier JardA³n
- Jorge Gonzalez
- Mario BlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- Shaun McCance
- Stefan Sauer (Kost)
- Will Thompson
- Yaakov Selkowitz
Krav :
- Perl v5
- libxslt & libxml2 2.3.6
- DocBook XSL-formatmallar
- DocBook XML DTD
- DocBook SGML DTD
- Jade v1.1 eller OpenJade 1.3.1
- DocBook DSSSL Sheets
Kommentarer hittades inte