GTK-Doc

GTK-Doc se utiliza para documentar código C. Normalmente se utiliza para documentar la API pública de bibliotecas, tales como el GTK + y bibliotecas de GNOME, pero también se puede utilizar para documentar código de la aplicación.
Tenga en cuenta que GTK-Doc no estaba destinado a ser un instrumento de documentación de uso general, por lo que puede ser un poco difícil de configurar y usar. Para un instrumento de documentación de uso general más pulido es posible que desee mirar a Doxygen (http://www.doxygen.org/). Sin embargo GTK-Doc tiene un código especial para documentar las señales y las propiedades de widgets GTK + y clases GObject que otras herramientas no pueden tener.
GTK-Doc permite a su documentación para ser escrito en 2 formas:
a) incrustado en el código fuente en los comentarios con formato especial.
o
b) Añadido a los archivos 'plantilla' que emite gtk-doc después de escanear todos los archivos de cabecera y analizar las declaraciones.
A partir de estos comentarios de código fuente y los archivos de plantilla GTK-Doc genera un Docbook XML (o SGML) documento, que se transforma en HTML. La documentación HTML generado se puede examinar en un navegador web común o utilizando el navegador API Devhelp especial (ver http://developer.imendio.com/wiki/Devhelp).

What es nueva en esta versión:

• gtk-doc admite un subconjunto de rebajas (rúbricas y listas) - ver
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc no genera edad devhelp archivos más. Esto reduce doc
• tiempo de generación y trabaja para devhelp & gt;. = 0,11 (se estrenó en 2005)
• cambios para construir dir fuera de la fuente causaron la rotura de los proyectos utilizando
• DOC_SOURCE_DIR con una ruta relativa (a builddir). Se recomienda utilizar
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• cambios
• 590927: AM_SILENT_RULES apoyo para medidas doc-build
• 617 121: / * & lt; privada & gt; * / Aún se muestran las declaraciones en las enumeraciones
• 627 758: Una forma de ignorar un símbolo
• 639145: sintaxis abreviada para los títulos
• 644291: rompe Enum analizador de asignación de ')'
• 646870: ya no está en EXTRA_DIST HTML_IMAGES
• 648 289:. Gtkdoc-mkdb no compila
• 648 331:. Especifique las opciones compatibles para 'destacado' consistentemente
• 649269: gtkdoc-scanobj debería establecer algunas de sus propias CFLAGS / LDFLAGS
• 650 407: Edificios docs mientras distchecking produce miles de € oNo declaración fundaciones € ?? advertencias, entonces falla.
• 652 746: La documentación de estructuras en caja de civil roto
• 652764: Actualizar autotools config un poco
• 655711: resumir salida depscan por paquete
• 656453: Mejoras de rendimiento (PATCH)
• 656658: gtk-doc.make: instalar objetivo no instala docs en la construcción en un directorio independiente
• 656773: gtk-doc no encuentra un símbolo declarado como 'const char *'
• 656946: gtk-doc incapaz de manejar 'short int extern'
• 657377: srcdir = builddir construye deseche contenido de tmpl
• Colaboradores
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? como
• Javier JardA³n
• Jorge González
• Mario BlA¤ttermann
• Matthias Clasen
• MichaÅ, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Requisitos

• Perl v5
• libxslt y libxml2 2.3.6
• DocBook XSL hojas de estilo
• DocBook XML DTD
• DocBook SGML DTD
• v1.1 Jade o OpenJade 1.3.1
• DocBook DSSSL hojas de estilo