GTK-Doc 1.18

GTK-Doc is a GTK+ DocBook Documentation Generator.
GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as the GTK+ and GNOME libraries, but it can also be used to document application code.

Note that GTK-Doc wasn't originally intended to be a general-purpose documentation tool, so it can be a bit awkward to setup and use. For a more polished general-purpose documentation tool you may want to look at Doxygen (http://www.doxygen.org/). However GTK-Doc has some special code to document the signals and properties of GTK+ widgets and GObject classes which other tools may not have.

GTK-Doc allows your documentation to be written in 2 ways:

a) Embedded inside the source code in specially-formatted comments.

or

b) Added to the 'template' files which gtk-doc outputs after scanning all the header files and parsing the declarations.

From these source code comments and template files GTK-Doc generates a Docbook XML (or SGML) document, which is then transformed into HTML. The generated HTML documentation can be browsed in an ordinary web browser or by using the special Devhelp API browser (see http://developer.imendio.com/wiki/Devhelp).

last updated on:
September 20th, 2011, 6:28 GMT
price:
FREE!
homepage:
download.gnome.org
license type:
LGPL (GNU Lesser General Public License) 
developed by:
Damon Chaplin and Owen Taylor
category:
ROOT \ Documentation
GTK-Doc
Download Button

In a hurry? Add it to your Download Basket!

user rating 21

2.3/5
 

0/5

Rate it!
What's New in This Release:
  • gtk-doc supports a subset of markdown (headings and lists) - see
  • http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
  • gtk-doc does not generate old devhelp files any more. This cuts down doc
  • generation time and works for devhelp >=0.11 (was released in 2005).
read full changelog

Add your review!

SUBMIT