Gtk-Doc

Download Source:	http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.7/gtk-doc-1.7.tar.bz2

---

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.

Dependencies

Required

• LibXSLT
• DocBook XML DTD-4.4
• DocBook XSL Stylesheets

Optional

• pkg-config
• ScrollKeeper
• OpenJade
• DocBook SGML DTD-4.4
• DocBook DSSSL StyleSheets

Non-Multilib or Multilib

Compile the package:

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

Install the package

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.

Contents

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.6, gnome/help/gtk-doc-manual, gtk-doc/data and {omf,sgml}/gtk-doc

Short Descriptions

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