gtk-doc-0.9

Introduction to gtk-doc

Download location (HTTP):       http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/0.9/gtk-doc-0.9.tar.bz2
Download location (FTP):        ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/0.9/gtk-doc-0.9.tar.bz2
Version used:                   0.9
Package size:                   124 KB
Estimated Disk space required:  832 KB

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 pre-built documentation to your system. If you choose to install this package, you will need to follow the hint titled Installing Docbook DTDs and Tools to centralize the catalogs, add additional dtd's and dsssl templates and install openjade. If sgml-common will not install:

ln -s /usr/share/automake-1.6 /usr/share/automake

You also need to add dtd v3.0 to your collection, and finally, you need to modify dtd-3.1 by adding png-support-3.1.dtd to /usr/share/sgml/docbook/sgml-dtd-3.1 and placing:

PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"

gtk-doc depends on:
OpenJade

Installation of gtk-doc

Install gtk-doc by running the following commands:

./configure --prefix=/opt/gnome2 &&
make install

Contents

The gtk-doc package contains gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj and gtkdoc-scanobj.

Description

This are all perl scripts used by Makefile scripts to generate documentation for the package.