luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-05 08:56:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
803bae66a3
glib/docs/reference
History
Matthias Clasen 803bae66a3 Move some docs inline, and add deprecation information. To see the list of 
* glib/gutils.c:
	* glib/gtree.c:
	* glib/gstring.c:
	* glib/gstrfuncs.c:
	* glib/giochannel.c: Move some docs inline, and add deprecation
	information. To see the list of affected functions, grep for
	"Deprecated:".

	* glib/tmpl/strings.sgml:
	* glib/tmpl/string_utils.sgml:
	* glib/tmpl/misc_utils.sgml: Move some docs inline.
2002-11-28 20:46:29 +00:00
..
glib Move some docs inline, and add deprecation information. To see the list of 2002-11-28 20:46:29 +00:00
gobject Mark 2.2 API additions. 2002-11-28 00:15:45 +00:00
.cvsignore Updates to .cvsignore. 1999-08-17 12:40:49 +00:00
AUTHORS Initial revision 1999-08-16 17:58:30 +00:00
ChangeLog Move some docs inline, and add deprecation information. To see the list of 2002-11-28 20:46:29 +00:00
COPYING Initial revision 1999-08-16 17:58:30 +00:00
Makefile.am A couple of small fixes. 2001-03-17 22:51:41 +00:00
NEWS Initial revision 1999-08-16 17:58:30 +00:00
README Added some simple build instructions. 1999-08-16 18:28:01 +00:00
README.cvs-commits A few more notes about mechanism and policy. 1999-08-16 18:38:22 +00:00

README 

This package contains the reference documentation
for GLib. For more information about Glib,
see:

 http://www.gtk.org

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

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

The GLib 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 GLib
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 for this module 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 GLib sources.


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

 make install