Commit Graph

201 Commits

Author SHA1 Message Date
Matthias Clasen
238c7c368b Doc additions.
2003-07-12  Matthias Clasen  <maclas@gmx.de>

	* glib/gprintf.c: Doc additions.

2003-07-12  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/string_utils.sgml: Add a paragraph about string precision, add links to it.
	Remove markup which is now handled better by gtk-doc.
2003-07-08 23:43:47 +00:00
Matthias Clasen
fe5c4f3e50 Support for one-time initialization functions. (#69668, Sebastian
2003-07-09  Matthias Clasen  <maclas@gmx.de>

	Support for one-time initialization functions.  (#69668, Sebastian Wilhelmi)

	* configure.in: Check whether double checked locking is safe, define g_once() in
	glibconfig.h accordingly.
	* glib/gthread.h: Add GOnce, GOnceStatus, G_ONCE_INIT and g_once_impl.
	* glib/gthread.c (g_once_impl): Fallback implementation using a mutex if double checked
	locking is unsafe.
	* tests/thread-test.c: Add tests for g_once().
2003-07-08 23:43:47 +00:00
Matthias Clasen
8940b82eb4 Move g_strfreev() docs inline.
2003-07-02  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/string_utils.sgml: Move g_strfreev() docs inline.
2003-07-01 22:15:54 +00:00
Matthias Clasen
67c48e49ee Move the documentation inline and add details. (#108505) Move
2003-06-19  Matthias Clasen  <maclas@gmx.de>

	* glib/gutils.c (g_path_get_basename): Move the documentation
	inline and add details.  (#108505)
	* glib/tmpl/misc_utils.sgml: Move g_path_get_basename() docs inline.
2003-06-18 23:12:56 +00:00
Matthias Clasen
be019f685f Add g_thread_init_glib to silence gtk-doc.
* glib/glib-sections.txt: Add g_thread_init_glib to silence gtk-doc.
2003-06-18 21:47:16 +00:00
Matthias Clasen
54f796b1b6 New macros to check for XML catalog contents and path, borrowed from
2003-06-17  Matthias Clasen  <maclas@gmx.de>

	* acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New
	macros to check for XML catalog contents and path, borrowed from
	gtk-doc.
	* configure.in: New option --enable-man to enable regeneration of
	man pages from Docbook, if the necessary tools are found.

	* gobject/Makefile.am: Add rule to regenerate man pages from
	Docbook.
	(man_MANS): Add glib-mkenums.1, glib-genmarshal.1 and gobject-query.1.
	(content_files): Add glib-mkenums.xml, glib-genmarshal.xml and
	gobject-query.xml.

	* gobject/glib-mkenums.xml:
	* gobject/glib-genmarshal.xml:
	* gobject/gobject-query.xml: New refentries.

	* gobject/glib-mkenums.1:
	* gobject/glib-genmarshal.1:
	* gobject/gobject-query.1: Man pages generated from the .xml
	sources.

	* gobject/gobject-docs.sgml: Include glib-mkenums.xml,
	glib-genmarshal.xml and gobject-query.xml.

	* glib/Makefile.am: Add rule to regenerate man pages from
	Docbook.
	(man_MANS): Add glib-gettextize.1.
	(content_files): Add glib-gettextize.xml.

	* glib/glib-gettextize.xml: New refentry.

	* glib/glib-gettextize.1: Man page generated from the .xml source.

	* glib/glib-docs.sgml: Include glib-gettextize.xml.
2003-06-17 23:08:37 +00:00
Matthias Clasen
6411bedd01 Add an autogenerated index.
2003-06-17  Matthias Clasen  <mc2@YAST_ASK>

	* gobject/gobject-docs.sgml:
	* glib/glib-docs.sgml: Add an autogenerated index.

2003-06-17  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/macros_misc.sgml: Document G_GNUC_DEPRECATED.
2003-06-16 23:01:00 +00:00
Matthias Clasen
34d2573657 A small addition.
2003-06-11  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/objects.sgml: A small addition.
2003-06-11 21:18:55 +00:00
Owen Taylor
1c5f52baa2 XML fix.
Sun Jun  8 12:28:39 2003  Owen Taylor  <otaylor@redhat.com>

        * glib/tmpl/error_reporting.sgml: XML fix.

        * glib/glib-sections.txt: Updated.
2003-06-08 16:35:16 +00:00
Matthias Clasen
a495b2cb03 Correct the documentation for G_MINFLOAT and G_MINDOUBLE. (#114513,
* glib/tmpl/limits.sgml: Correct the documentation for
	G_MINFLOAT and G_MINDOUBLE.  (#114513, Christophe Fergeau)
2003-06-06 21:20:34 +00:00
Matthias Clasen
53efcd835d Add g_vasprintf().
2003-06-06  Matthias Clasen  <maclas@gmx.de>

	* glib/glib-sections.txt: Add g_vasprintf().

	* glib/tmpl/string_utils.sgml: Add a hint about g_vasprintf() to
	the g_strdup_printf() docs.
2003-06-05 22:54:55 +00:00
Matthias Clasen
d1db6f8b36 Document that g_strdup() and g_strndup() accept NULL. (#106987, Christian
2003-05-28  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/string_utils.sgml: Document that g_strdup() and
	g_strndup() accept NULL.  (#106987, Christian Biere)
2003-05-27 22:25:03 +00:00
Matthias Clasen
a45782e8ee Fix a duplicate id left by copy-and-paste. (#112785, Owen Taylor)
2003-05-12  Matthias Clasen  <maclas@gmx.de>

	* glib/cross.sgml: Fix a duplicate id left by copy-and-paste.
	(#112785, Owen Taylor)
2003-05-11 22:29:50 +00:00
Matthias Clasen
b9415110b1 Correct the documentation GSignalEmissionHook (#110906) and some cleanups.
2003-04-18  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/signals.sgml: Correct the documentation
	GSignalEmissionHook (#110906) and some cleanups.
2003-04-18 00:17:16 +00:00
Matthias Clasen
890792db1a Fix a few typos. 2003-04-11 21:56:50 +00:00
Matthias Clasen
754d18b050 Move install docs into reference manual. 2003-04-09 18:49:48 +00:00
Matthias Clasen
7b0da6c54a Move cross-compilation info to reference manual. 2003-04-07 23:20:57 +00:00
Matthias Clasen
91da77c5b4 Additions. 2003-04-07 00:08:19 +00:00
Matthias Clasen
aad05b82e0 Fix formatting of examples.
2003-04-01  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/error_reporting.sgml:
	* glib/tmpl/random_numbers.sgml:
	* glib/tmpl/arrays_pointer.sgml:
	* glib/tmpl/arrays.sgml: Fix formatting of examples.
2003-03-31 22:51:28 +00:00
Matthias Clasen
e4112b8b1b New function, to insert possible non-nul-terminated byte sequences into a
2003-04-01  Matthias Clasen  <maclas@gmx.de>

	* glib/gstring.[hc] (g_string_chunk_insert_len): New function, to
	insert possible non-nul-terminated byte sequences into a string
	chunk.  (#96279)
	(g_string_chunk_insert): Implement in terms of
	g_string_chunk_insert_len() now.
2003-03-31 22:08:08 +00:00
Matthias Clasen
46ae53a931 Additions. 2003-03-27 23:17:59 +00:00
Matthias Clasen
dfa521fdf7 Additions. 2003-03-24 23:28:35 +00:00
Matthias Clasen
e35363d894 Additions.
2003-03-24  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/objects.sgml: Additions.
2003-03-24 01:10:28 +00:00
Owen Taylor
e6d15f6eaf Document private instance data.
Mon Mar 10 11:33:10 2003  Owen Taylor  <otaylor@redhat.com>

        * gobject/tmpl/gtype.sgml gobject/gobject-sections.txt:
        Document private instance data.
2003-03-10 16:38:58 +00:00
Matthias Clasen
9796402280 Fix an off-by-one error in the g_strescape() docs. (#105431, Phillip
2003-02-11  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/string_utils.sgml: Fix an off-by-one error in the
	g_strescape() docs.  (#105431, Phillip Vandry)
2003-02-10 23:56:45 +00:00
Matthias Clasen
280a213b09 Move all docs out-of-line. Boy, what a waste of time.
2003-02-07  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/gtypemodule.sgml:
	* gobject/tmpl/gtype.sgml:
	* gobject/tmpl/gclosure.sgml:
	* gobject/tmpl/param_value_types.sgml:
	* gobject/tmpl/gparamspec.sgml:
	* gobject/tmpl/objects.sgml:
	* gobject/tmpl/signals.sgml: Move all docs out-of-line. Boy, what
	a waste of time.
2003-02-07 22:08:53 +00:00
Matthias Clasen
d671206b9e Document the return value of g_string_free().
2003-01-21  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/strings.sgml: Document the return value of g_string_free().
2003-01-21 22:24:00 +00:00
Matthias Clasen
7b5bfca305 Fix the description of G_TYPE_FUNDAMENTAL. (#103119, Josh Parsons)
2003-01-15  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/gtype.sgml: Fix the description of
	G_TYPE_FUNDAMENTAL.  (#103119, Josh Parsons)
2003-01-14 23:38:34 +00:00
Tor Lillqvist
7809df2a6a Remove comment that only stdout would be used on Windows, no longer true.
2003-01-01  Tor Lillqvist  <tml@iki.fi>

	* glib/tmpl/messages.sgml: Remove comment that only stdout would
	be used on Windows, no longer true.
2003-01-01 01:40:52 +00:00
Matthias Clasen
8b8616bb9c Move some docs inline.
* gobject/tmpl/param_value_types.sgml: Move some docs inline.

	* gsignal.c (g_signal_new): Typo fix.

	* gparamspecs.c:
	* gparam.c (g_param_spec_internal):
	* gobject.c (g_object_class_install_property): Add docs.
2002-12-15 02:38:49 +00:00
Matthias Clasen
7baf68502f Add gprintfint.h and trio.
2002-12-15  Matthias Clasen  <maclas@gmx.de>

	* glib/Makefile.am (IGNORE_HFILES): Add gprintfint.h and trio.

	* glib/trio/glibtrio.h: New file, redefining all trio symbols to
	fall into the _G/_g_ private glib namespace.

	* glib/trio/Makefile.am (libtrio_la_SOURCES): Add glibtrio.h

	* glib/trio/trionan.c:
	* glib/trio/triostr.c:
	* glib/trio/trio.c: Include glibtrio.h

	* glib/gprintfint.h:
	* glib/trio/trionan.c:
	* glib/trio/triostr.c:
	* glib/trio/trio.c: Include glibtrio.h
2002-12-15 00:03:46 +00:00
Matthias Clasen
ab5fe79f8a Add --ignore-files=trio to avoid gtk-doc warnings about doxygen comments.
* glib/Makefile.am (MKDB_OPTIONS): Add --ignore-files=trio to
	avoid gtk-doc warnings about doxygen comments.
2002-12-12 23:34:37 +00:00
Owen Taylor
63524f96ee Improve docs for return value and @microseconds out parameter. (Reported
Tue Dec 10 11:55:28 2002  Owen Taylor  <otaylor@redhat.com>

        * glib/tmpl/timers.sgml: Improve docs for return value
        and @microseconds out parameter. (Reported by
        Dennis Haney, #100841)
2002-12-10 16:57:25 +00:00
Matthias Clasen
657428da90 Add docs.
* gobject/tmpl/generic_values.sgml:
	* gobject/tmpl/gtype.sgml:
	* gobject/tmpl/enumerations_flags.sgml: Add docs.
2002-12-09 23:26:17 +00:00
Matthias Clasen
20f6d1b814 Add docs.
* gobject/tmpl/gtype.sgml:
	* gobject/tmpl/enumerations_flags.sgml: Add docs.
2002-12-09 19:47:10 +00:00
Matthias Clasen
bec0034918 Add GTypeClass, GTypePluginClass and GTypeModuleClass.
* gobject/tmpl/gtype.sgml:
	* gobject/tmpl/gtypeplugin.sgml:
	* gobject/tmpl/gtypemodule.sgml:
	* gobject/gobject-sections.txt: Add GTypeClass, GTypePluginClass
	and GTypeModuleClass.

	* gobject/tmpl/gboxed.sgml: Add docs.
2002-12-09 19:06:42 +00:00
Matthias Clasen
b9da696ea0 Add docs.
* gobject/tmpl/enumerations_flags.sgml:
	* gobject/tmpl/gclosure.sgml:
	* gobject/tmpl/param_value_types.sgml: Add docs.
2002-12-08 23:16:50 +00:00
Matthias Clasen
9b275961ef Typo fix. 2002-12-06 01:47:27 +00:00
Matthias Clasen
4a2fac6031 Add Since and Deprecation info for symbols documented in the templates.
* glib/tmpl/strings.sgml:
	* glib/tmpl/scanner.sgml:
	* glib/tmpl/main.sgml:
	* glib/tmpl/macros_misc.sgml:
	* glib/tmpl/hash_tables.sgml: Add Since and Deprecation info
	for symbols documented in the templates.

	* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
	info into two paragraphs.
2002-12-05 22:32:20 +00:00
Matthias Clasen
6df677db74 Sync parameter names with docs and implementation.
* gsignal.h (g_signal_add_emission_hook):
	* gtype.h (g_type_interface_get_plugin): Sync parameter names with
	docs and implementation.

	* gtype.c (g_type_add_interface_dynamic):
	(g_type_interface_get_plugin):
	(g_type_interface_peek_parent):
	(g_type_query): Add docs.

	* gobject/tmpl/gtype.sgml: Add docs.

	* gobject/tmpl/signals.sgml: Regenerated.
2002-12-03 23:54:55 +00:00
Matthias Clasen
0b93fa4048 More GSignal docs. 2002-12-02 19:56:12 +00:00
Matthias Clasen
90d5b0fced More docs.
* gsignal.c: More docs.

	* gobject/gobject-sections.txt: Mark g_signal_handlers_destroy as
	private.

	* gobject/tmpl/signals.sgml: Move some docs inline.
2002-12-01 01:32:11 +00:00
Matthias Clasen
97489993f7 Adjust to changed parameter names.
* glib/gtimer.c (g_time_val_add): Adjust to changed parameter names.

	* glib/gutils.c (g_get_application_name): Mark as 2.2. addition.

	* glib/gstrfuncs.c (g_ascii_strtoull): Mark as 2.0.7 addition.

	* glib/tmpl/main.sgml: Write something about GSourceDummyMarshal.

	* glib/tmpl/date.sgml:
	* glib/tmpl/string_utils.sgml: Remove redundant docs.

	* glib/glib-sections.txt: Add g_ascii_strtoull and
	g_get_application_name.
2002-11-28 23:11:58 +00:00
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
Matthias Clasen
e80c828a42 Add missing short descriptions, standardize them to start with a capital
* gobject/tmpl/gclosure.sgml:
	* gobject/tmpl/signals.sgml:
	* gobject/tmpl/gparamspec.sgml:
	* gobject/tmpl/value_collection.sgml:
	* gobject/tmpl/generic_values.sgml:
	* gobject/tmpl/param_value_types.sgml:
	* gobject/tmpl/gboxed.sgml:
	* gobject/tmpl/enumerations_flags.sgml:
	* gobject/tmpl/objects.sgml:
	* gobject/tmpl/gtypemodule.sgml:
	* gobject/tmpl/gtypeplugin.sgml: Add missing short descriptions,
	standardize them to start with a capital and end without a period.

	* glib/tmpl/arrays.sgml:
	* glib/tmpl/memory_chunks.sgml:
	* glib/tmpl/macros.sgml: Remove periods from titles in examples.
2002-11-23 22:57:35 +00:00
Matthias Clasen
940d8a269d Explain --enable-include-printf.
* glib/building.sgml: Explain --enable-include-printf.
2002-11-23 21:37:54 +00:00
Matthias Clasen
105183376d Add version info to API docs. 2002-11-23 01:37:17 +00:00
Owen Taylor
eaf8e13856 Add helpful comments about the encoding of a new iochannel. (Amaury
Thu Nov 21 15:52:04 2002  Owen Taylor  <otaylor@redhat.com>

        * glib/tmpl/iochannels.sgml: Add helpful comments about
        the encoding of a new iochannel. (Amaury Jacquot,
        #96444)
2002-11-21 20:54:44 +00:00
Matthias Clasen
bc54ea6edf Include a printf implementation supporting C99 snprintf and SUS
positional parameters:  (#79488)

	* glib/gstrfuncs.c:
	* glib/gspawn-win32.c:
	* glib/gscanner.c:
	* glib/gconvert.c:
	* glib/gbacktrace.c: Use _g_printf wrappers.

	* glib/gutils.c (g_vsnprintf): Simplify, since we can assume C99
	snprintf semantics now.

	* glib/gmessages.c (printf_string_upper_bound): No longer needed,
	since we can assume C99 snprintf semantics now.
	(g_logv): Simplify.

	* acinclude.m4 (AC_FUNC_PRINTF_UNIX98): New macro to check wether
	printf supports SUS positional parameters.

	* configure.in: New option --enable-included-printf to force
	compilation of trio; otherwise trio is compiled if the system
	printf misses either C99 snprintf semantics of SUS positional
	parameters.

	* glib/Makefile.am (SUBDIRS): Conditionally compile trio.
	(libglib_2_0_la_SOURCES): Add gprintf.c and gprintfint.h.
	(glibsubinclude_HEADERS): Add gprintf.h.

	* glib/gprintfint.h: New private wrapping either system printf
	or trio printf variants in _g_printf wrappers for use inside glib.

	* glib/gprintf.h: New public header declaring g_printf variants.
	* glib/gprintf.c: Corresponding implementations.

	* glib/trio/*: New directory, containing the trio-1.9 sources.

	* glib/tmpl/string_utils.sgml: Add note on including gprintf.h,
	move some docs inline.

	* glib/glib-sections.txt: Add g_printf, g_vprintf, g_fprintf,
	g_vfprintf, g_sprintf, g_vsprintf.
2002-11-21 00:35:15 +00:00
Matthias Clasen
dc645ce354 Use G_LIKELY. (#69022)
* glib/gmessages.h (g_return_if_fail):
	(g_return_val_if_fail): Use G_LIKELY.  (#69022)

	* glib/gmacros.h (G_LIKELY):
	(G_UNLIKELY): New macros for hinting the compiler about the
	expected result of expressions. For gcc 3.x, define these
	using __builtin_expect.  (#69022)

	* glib/tmpl/macros_misc.sgml: Document G_LIKELY, G_UNLIKELY.

	* glib/glib-sections.txt: Add G_LIKELY, G_UNLIKELY.
2002-11-20 21:50:16 +00:00