Commit Graph

175 Commits

Author SHA1 Message Date
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
Matthias Clasen
f74c33fc1d Update to latest gtk-doc version. 2002-10-19 23:41:27 +00:00
Matthias Clasen
1565a2027e Add g_type_interface_prerequisites. 2002-10-15 21:16:20 +00:00
Matthias Clasen
336d715c8e Dist the xml/*.xml, not sgml/*.sgml. (#95678, Owen Taylor)
* gobject/Makefile.am (dist-hook):
	* glib/Makefile.am (dist-hook): Dist the xml/*.xml, not
	sgml/*.sgml.  (#95678, Owen Taylor)
2002-10-14 21:54:11 +00:00
Matthias Clasen
c359153dfd Adapt to latest gtk-doc changes. 2002-10-14 00:14:27 +00:00
Matthias Clasen
8ca0f66ea7 Replace G_LOG_FLAG_RECURSIVE by G_LOG_FLAG_RECURSION throughout. (#93390)
* glib/tmpl/messages.sgml: Replace G_LOG_FLAG_RECURSIVE by
	G_LOG_FLAG_RECURSION throughout.  (#93390)
2002-09-16 20:55:59 +00:00
Matthias Clasen
71f016708a Add g_markup_parse_context_get_element and g_utf8_strreverse.
* glib/glib-sections.txt: Add g_markup_parse_context_get_element
	and g_utf8_strreverse.
2002-08-12 21:28:45 +00:00
Owen Taylor
0f6d709867 Fix reference to non-existing @priority parameter. (#88500, Linux Walleij)
Thu Jul 25 18:58:29 2002  Owen Taylor  <otaylor@redhat.com>

        * glib/tmpl/threads.sgml: Fix reference to non-existing
        @priority parameter. (#88500, Linux Walleij)
2002-07-25 22:59:54 +00:00
Matthias Clasen
a2e3f606ed Replace homegrown "hash" entity by standard ISO entity "num".
* glib/gwin32.c (g_win32_get_package_installation_directory):
	Replace homegrown "hash" entity by standard ISO entity "num".

	* gobject/gobject-docs.sgml:
	* glib/glib-docs.sgml:
	* glib/tmpl/macros.sgml:
	* glib/tmpl/string_utils.sgml: Replace homegrown "nbsp", "hash"
	and "percent" entities by standard ISO entities "nbsp", "num" and
	"percnt".
2002-06-03 17:34:37 +00:00
Matthias Clasen
bca67c15fe Small formatting fixes.
* glib/tmpl/string_utils.sgml:
	* glib/tmpl/threads.sgml: Small formatting fixes.
2002-05-30 21:55:14 +00:00
Matthias Clasen
5e45a337b8 Remove references to nonexisting functions
* glib/gmain.c: Remove references to nonexisting functions
	g_source_set_callback_closure(), g_source_poll(), g_source_add()
	from docs.

	* glib/gdir.c (g_dir_open): Typo fix in docs.

	* glib/gasyncqueue.c (g_async_queue_lock):
	(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
	<link>s in docs.

	* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.

	* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.

	* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.

	* glib/tmpl/conversions.sgml: Add GIConv.

	* glib/tmpl/main.sgml: Fix references to nonexisting functions
	g_main_loop_destroy(), g_source_add(), g_source_connect().

	* glib/glib-sections.txt: Add GIConv, g_str_has_prefix, g_str_has_suffix.

	* glib/tmpl/linked_lists_single.sgml:
	* glib/tmpl/linked_lists_double.sgml: GListAllocator doesn't exist.

	* glib/glib-docs.sgml: Declare hash entity.

	* glib/tmpl/macros.sgml: Escape # in #ifdef to suppress erroneous links.

	* gobject/Makefile.am, gobject/gobject-docs.sgml, gobject/tmpl/*:
	* glib/Makefile.am, glib/glib-docs.sgml, glib/tmpl/*: Produce XML,
	not SGML.
2002-05-26 22:46:28 +00:00
Matthias Clasen
ea3db7ce06 Added proper support for CDATA sections. Updates.
* glib/gmarkup.c (g_markup_parse_context_parse): Added
	proper support for CDATA sections.
	* glib/tmpl/markup.sgml: Updates.
2002-05-20 22:59:11 +00:00
Tim Janik
7aebfd424f [merged from stable]
Sat May 18 00:44:35 2002  Tim Janik  <timj@gtk.org>

        [merged from stable]

        * glib/tmpl/scanner.sgml: fix documentation for g_scanner_unexp_token().
2002-05-17 22:49:06 +00:00
Sebastian Wilhelmi
81d6a7dd7c Clarify recursion issues with GMutex. (#78171)
2002-05-01  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>

	* glib/tmpl/threads.sgml: Clarify recursion issues with
	GMutex. (#78171)
2002-05-01 14:39:48 +00:00
Matthias Clasen
61f76fa4e5 Updates.
* gobject/gobject-sections.txt:
	* gobject/tmpl/gtype.sgml: Updates.
2002-04-23 23:18:37 +00:00
Matthias Clasen
031fb85282 Fix the description of g_string_assign. (#78728)
* glib/tmpl/strings.sgml: Fix the description of g_string_assign. (#78728)
2002-04-20 23:46:05 +00:00
Matthias Clasen
5cbcd52547 s/<!>/<!-- -->/g throughout the documentation to bring the produced
* glib/tmpl/error_reporting.sgml:
	* glib/tmpl/threads.sgml:
	* glib/tmpl/arrays_pointer.sgml:
	* glib/tmpl/arrays_byte.sgml:
	* glib/tmpl/memory_chunks.sgml: s/<!>/<!-- -->/g throughout the
	documentation to bring the produced Docbook closer to XML.
2002-04-18 22:03:38 +00:00
Sven Neumann
1543f95a77 Fixed documentation about unused struct fields and added a note about
2002-03-25  Sven Neumann  <sven@gimp.org>

	* glib/tmpl/scanner.sgml: Fixed documentation about unused struct
	fields and added a note about proper g_scanner_unexp_token() usage.
2002-03-25 11:55:14 +00:00
Matthias Clasen
3346808702 Add a note about g_strreverse() and UTF-8.
* glib/tmpl/string_utils.sgml: Add a note about g_strreverse() and UTF-8.

	* glib/gstrfuncs.c (g_strtod):
	(g_ascii_strtod):
	(g_ascii_dtostr):
	(g_ascii_formatd): Doc formatting fixes.
2002-03-11 21:38:18 +00:00
Matthias Clasen
642897a7f3 New header containing GTK_DEBUG-style debugging support for GLib.
* glib/gdebug.h: New header containing GTK_DEBUG-style debugging
	support for GLib. Currently only the fatal_warnings debug option exists.

	* glib/gmessages.c (g_log_msg_prefix_init): New one-shot function
	for parsing G_MESSAGES_PREFIXED.
	(_g_debug_init): New one-shot function for parsing G_DEBUG.
	(g_log_write_prefix): Use g_log_msg_prefix_init().
	(g_messages_init): Use g_log_msg_prefix_init() and _g_debug_init().

	* glib/Makefile.am (libglib_1_3_la_SOURCES): Add gdebug.h.


	* glib/Makefile.am (IGNORE_HFILES): Add gdebug.h.

	* glib/running.sgml: Document the G_DEBUG environment variable.

	* glib/tmpl/threads.sgml: Replace g_thread_wait() by
	g_thread_join() in two places.
2002-02-21 23:07:34 +00:00
Sven Neumann
5eced196ba gobject/gobject-sections.txt gobject/tmpl/generic_values.sgml updated for
2002-02-20  Sven Neumann  <sven@gimp.org>

	* gobject/gobject-sections.txt
	* gobject/tmpl/generic_values.sgml
	* gobject/tmpl/param_value_types.sgml: updated for GValue changes.
2002-02-20 09:51:10 +00:00
Tim Janik
f2620633c1 added GValue documentation.
Tue Feb 19 17:45:43 2002  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/generic_values.sgml: added GValue documentation.
2002-02-19 17:08:11 +00:00
Tim Janik
a1c162e123 document value transformation.
Thu Feb  7 12:07:06 2002  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/generic_values.sgml: document value transformation.
2002-02-07 11:09:26 +00:00
Tim Janik
c73fba247b doc common functions like ref/ sink/unref/invalidate.
Mon Feb  4 17:55:39 2002  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/closures.sgml: doc common functions like ref/
        sink/unref/invalidate.
2002-02-04 18:08:23 +00:00
Tim Janik
179963de91 document g_obejct_watch_closure() and qdata functions.
Mon Feb  4 17:55:39 2002  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/objects.sgml: document g_obejct_watch_closure() and
        qdata functions.
2002-02-04 17:17:44 +00:00
Owen Taylor
5a7cf7fa60 1.3.13
Tue Jan 29 11:18:44 2002  Owen Taylor  <otaylor@redhat.com>

        * 1.3.13

        * NEWS: Updated.

        * configure.in: Micro == 13, binary age, interface age 0.
        [ binary breakage was return type of g_signal_connect_object(),
        probably could have used binary age == 0, but a little safer not to.]

        * configure.in: Remove configure warning.
2002-01-29 17:10:34 +00:00
Ron Steinke
03b9590095 Some documentation fixes/elaborations I really should have gotten
in a long time ago
2002-01-28 21:17:45 +00:00