gtk/docs/reference
Daniel Elstner 0bf3652e1d Bug 563994 – Input method module interface not documented
* gtk/gtkimcontext.h: Add public/private markers.
* gtk/gtkimcontext.c: Add section documentation which explains how
to add a new input method module to GTK+.  Document the signals and
virtual functions of GtkIMContextClass.
* gtk/gtkimmodule.c: Document struct GtkIMContextInfo.
* docs/reference/gtk/gtk-sections.txt: Add GtkIMContextClass and
GtkIMContextInfo to section GtkIMContext.
* docs/reference/gtk/Makefile.am (IGNORE_HFILES): Remove
gtkimmodule.h from the list in order to pick up GtkIMContextInfo.
* docs/reference/gtk/tmpl/gtkimcontext.sgml: Remove file from
repository since all the hand-edited content has been migrated to
source file comments.

svn path=/trunk/; revision=21870
2008-12-11 11:38:59 +00:00
..
gdk Use a new gtk-doc feature to generate much nicer indices. 2008-11-21 08:21:28 +00:00
gdk-pixbuf Use a new gtk-doc feature to generate much nicer indices. 2008-11-21 08:21:28 +00:00
gtk Bug 563994 – Input method module interface not documented 2008-12-11 11:38:59 +00:00
libgail-util Use xi:include instead of entities to ease maintenance and speed up 2008-09-06 09:47:18 +00:00
AUTHORS Initial revision 1999-08-16 18:51:52 +00:00
ChangeLog Improve GTK_MODULES docs 2008-12-10 18:00:02 +00:00
COPYING Initial revision 1999-08-16 18:51:52 +00:00
Makefile.am Integrate gail into gtk+. Bug #169488. 2007-12-18 13:51:12 +00:00
README Initial revision 1999-08-16 18:51:52 +00:00
README.cvs-commits Initial revision 1999-08-16 18:51:52 +00:00

This package contains the reference documentation
for GTK+. For more information about GTK+
see:

 http://www.gtk.org

For information about contributing to the
GLib/GTK+ reference documentation project, see:

 http://www.gtk.org/rdp/

The GTK+ reference documentation is freely redistributable,
see the file COPYING for details.


REQUIREMENTS
============

To build the documentation, you must have the gtk-doc
package installed. To rebuild the template files,
you must have the current version of the GTK+
header files installed.


BUILD
=====

First, run configure to generate the makefiles for this
module. There is one option specific to this package

  --with-html-dir=DIR   top of installed HTML documentation tree


The Makefiles in the gdk/ and gtk/ subdirs each define three targets:

 templates:
  
  Scan the headers and merge the results with the current 
  template files

 sgml:

  Generate SGML files using the DocBook DTD from
  the template files

 html:

  Generate HTML from the SGML files.

To build the documentation, do:

 make sgml
 make html

You should only run the 'make templates' step if you
need to regenerate the templates for a more recent
version of the GTK+ sources.

INSTALLATION
============

 make install