Difference between revisions of "Hacking:API documentation"

From GIMP Developer Wiki
Jump to: navigation, search
(Create page)
 
(Update API doc sources)
Line 1: Line 1:
See [http://developer.gimp.org/api/2.0/index.html API documentation at developer.gimp.org] (outdated).
+
There are several ways to get GIMP's API documentation.
  
To always have an up-to-date API documentation, do the following.
+
* Read it [http://developer.gimp.org/api/2.0/index.html online].
 +
* Download the archives from [https://gimptest.flamingtext.com:9090/view/AllDownloads/ our continuous integration server]. They are in the column 'Developer documentation'.  
 +
* Generate it yourself: 
  
{|
+
:{|
 
| 1. ||  '''configure --prefix=$PREFIX --enable-gtk-doc  --enable-gtk-doc-app'''
 
| 1. ||  '''configure --prefix=$PREFIX --enable-gtk-doc  --enable-gtk-doc-app'''
 
|-
 
|-

Revision as of 14:28, 19 January 2014

There are several ways to get GIMP's API documentation.

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.