Beyond Linux® From Scratch - Version svn-20091103

Chapter 10. General Utilities

GTK-Doc-1.11

Introduction to GTK-Doc

The GTK-Doc package contains a code documenter. 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

Required

GNOME Doc Utils-0.18.0, DocBook XML DTD-4.5, and DocBook XSL Stylesheets-1.75.2

Recommended

Python-2.6.2

Optional

ScrollKeeper-0.3.14, OpenJade-1.3.2, DocBook SGML DTD-4.5, DocBook DSSSL Stylesheets-1.79, also GLib-2.22.0 (for the testsuite)

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc

Installation of GTK-Doc

Install GTK-Doc by running the following commands: 

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

Now, as the root user: 

make install

The test suite requires that the package has been installed first, but there's no reason to run it as there is a missing file which causes the test suite to fail. If you insist on seeing the results, an an unprivileged user run: make check.

Contents

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

Short Descriptions

gtkdoc*

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

Last updated on 2009-07-23 18:36:20 +0000