GTK-Doc

GTK-Doc est utilisé pour documenter du code C. Il est généralement utilisé pour documenter l'API publique de bibliothèques, telles que la GTK + et les bibliothèques GNOME, mais il peut également être utilisé pour documenter le code d'application.
Notez que GTK-Doc n'a pas été à l'origine destiné à être un outil de documentation d'usage général, de sorte qu'il peut être un peu difficile à installer et à utiliser. Pour un outil de documentation à usage général plus poli que vous pourriez vouloir regarder Doxygen (http://www.doxygen.org/). Cependant GTK-Doc possède un code spécial pour documenter les signaux et les propriétés des widgets GTK + et les classes GObject autres outils qui ne peuvent pas avoir.
GTK-Doc permet à votre documentation pour être écrit de 2 façons:
a) intégré à l'intérieur du code source dans les commentaires spécialement formatés.
ou
b) Ajout aux fichiers «modèle» qui sorties gtk-doc après la numérisation de tous les fichiers d'en-tête et analyser les déclarations.
De ces commentaires de code source et les fichiers modèles GTK-Doc génère un document XML DocBook (ou SGML), qui est ensuite transformé en HTML. La documentation HTML générée peut être consulté dans un navigateur Web ordinaire ou en utilisant le navigateur API Devhelp spéciale (voir http://developer.imendio.com/wiki/Devhelp).

What est nouvelle dans cette version:

• gtk-doc prend en charge un sous-ensemble de démarques (titres et les listes) - voir
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc ne génère pas de vieux fichiers devhelp plus. Cela réduit doc
• temps de génération et travaille pour devhelp & gt;. = 0,11 (a été libéré en 2005)
• changements pour out-of-source de build dir causé la rupture pour des projets utilisant
• DOC_SOURCE_DIR avec un chemin relatif (à builddir). Il est recommandé d'utiliser
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• les modifications
• 590927: AM_SILENT_RULES de soutien pour les étapes de doc-construire
• 617121: / * & lt; privée & gt; * / Déclarations dans les énumérations sont toujours affichés
• 627758: Une façon d'ignorer un symbole
• 639145: syntaxe abrégée pour les rubriques
• 644291: pauses Enum d'analyseur à la cession des '')
• 646870: HTML_IMAGES plus en EXTRA_DIST
• 648289:. Gtkdoc-mkdb ne compile pas
• 648331:. Spécifier les options compatibles pour 'highlight' toujours
• 649269: gtkdoc-scanobj devrait définir certaines de ses propres CFLAGS / LDFLAGS
• 650407: Bâtiments docs tout distchecking produit des milliers de € oNon une déclaration fondations € ?? avertissements, puis échoue.
• 652746: Documentation de struct simples boîtes cassé
• 652 764: Mise à jour autotools config un peu
• 655711: résumer sortie depscan par le paquet
• 656 453: des améliorations de performance (PATCH)
• 656658: gtk-doc.make: cible d'installation ne pas installer docs lors de la construction dans un répertoire distinct
• 656773: gtk-doc ne parvient pas à trouver un symbole déclaré que «const char * '
• 656946: gtk-doc incapable de gérer 'short int externe'
• 657377: srcdir = builddir construit jetez contenu de tmpl
• contributeurs
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? comme
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• Michaël, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Exigences :

• Perl v5
• libxslt & libxml2 2.3.6
• feuilles de style XSL DocBook
• DocBook XML DTD
• DocBook DTD SGML
• Jade ou OpenJade v1.1 1.3.1
• DocBook DSSSL Stylesheets