GTK-Doc-1.0

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 pre-built documentation to your system.

Package information

Installation of GTK-Doc

Install GTK-Doc by running the following commands:

./configure --prefix=/usr &&
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

These are all Perl scripts used by Makefile scripts to generate documentation for the package.