Gtk-Doc

From CBLFS
Jump to: navigation, search
Download Source: http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.11/gtk-doc-1.11.tar.bz2

Contents

Introduction to Gtk-Doc

GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as the GTK+ (Gtk1 and Gtk2) and Gnome libraries, but it can also be used to document application code.

Note that GTK-Doc wasn't originally intended to be a general-purpose documentation tool, so it can be a bit awkward to setup and use. For a more polished general-purpose documentation tool you may want to look at Doxygen. However GTK-Doc has some special code to document the signals and properties of GTK+ widgets and GObject classes which other tools may not have.

Project Homepage: http://www.gtk.org/gtk-doc/

Dependencies

Required

Optional

Non-Multilib

Compile the package:

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

Install the package

make install

Multilib

Compile the package:

export PKG_CONFIG_PATH="${PKG_CONFIG_PATH64}" &&
./configure --prefix=/usr --localstatedir=/var/lib &&
make

Install the package

make install &&
unset PKG_CONFIG_PATH

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.11., 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.
Personal tools