Hacking:API documentation

From GIMP Developer Wiki
Revision as of 10:16, 26 May 2013 by Scl (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

See API documentation at developer.gimp.org (outdated).

To always have an up-to-date API documentation, do the following.

1. configure --prefix=$PREFIX --enable-gtk-doc --enable-gtk-doc-app
If you got the sources directly from the Git repository, use autogen.sh instead of configure.
The parameters have the following meaning:
--enable-gtk-doc : use gtk-doc to build documentation
--enable-gtk-doc-app : build developer documentation for app (not only the libgimp* libraries).
To find out more parameters, run configure --help
$PREFIX is a variable for the directory you will install GIMP in.
2. make
3. make install
4. cd $PREFIX/share/gtk-doc/html
5. From the desired subdirectory open the file index.html for an overview of that module.