gtk-doc-1.0

Introduction to gtk-doc

Download location (HTTP):       http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.0/gtk-doc-1.0.tar.bz2
Download location (FTP):        ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.0/gtk-doc-1.0.tar.bz2
Version used:                   1.0
Package size:                   120 KB
Estimated Disk space required:  956 KB
Additional downloads:
png-support-3.1.dtd

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.

gtk-doc depends on:
openjade-1.3.2, libxslt-1.0.29, xml-dtd-4.2, 
sgml-dtd-3.1 and sgml-dtd-4.2

Installation of gtk-doc

Install gtk-doc by running the following commands:

./configure --prefix=/usr &&
make install

You should either save png-support-3.1.dtd to /usr/share/sgml/docbook/sgml-dtd-3.1 or move the file to that location. Some configuration steps need to be performed that are listed at sgml-dtd-3.1.

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.