Introduction to GTK-Doc

The GTK-Doc package contains a code documentor. This is useful for extracting specially formatted comments from the code to create API documentation. This package is optional; if it is not installed, packages will not build the documentation. This does not mean that you will not have any documentation. If GTK-Doc is not available, the install process will copy any pre-built documentation to your system.

Package Information

GTK-Doc Dependencies


libxslt-1.1.22, DocBook XML DTD-4.5, and DocBook XSL Stylesheets-1.71.1


pkg-config-0.22, ScrollKeeper-0.3.14, OpenJade-1.3.2, DocBook SGML DTD-4.5, and DocBook DSSSL Stylesheets-1.79

User Notes:

Installation of GTK-Doc

Install GTK-Doc by running the following commands:

./configure --prefix=/usr --localstatedir=/var/lib &&

This package does not come with a test suite.

Now, as the root user:

make install

Command Explanations

--localstatedir=/var/lib: This parameter is used so that all ScrollKeeper files are installed in, and the ScrollKeeper database is properly updated in /var/lib/scrollkeeper instead of some files being installed in $GNOME_PREFIX/var/scrollkeeper.


Installed Programs: gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj
Installed Libraries: None
Installed Directories: The following subdirectories of /usr/share/: doc/gtk-doc-1.8, gnome/help/gtk-doc-manual, gtk-doc/data and {omf,sgml}/gtk-doc

Short Descriptions


these are all Perl scripts used by package Makefile scripts to generate documentation for the package being built.

Last updated on 2007-04-04 14:42:53 -0500