From 4acacec101e4fb1456bcdf7f0b503f8e5d809cd1 Mon Sep 17 00:00:00 2001 From: Soeren Sandmann Date: Sun, 1 Sep 2002 13:04:02 +0000 Subject: [PATCH] Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) 2002-09-01 Soeren Sandmann * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) --- ChangeLog | 6 ++++++ ChangeLog.pre-2-10 | 6 ++++++ ChangeLog.pre-2-12 | 6 ++++++ ChangeLog.pre-2-2 | 6 ++++++ ChangeLog.pre-2-4 | 6 ++++++ ChangeLog.pre-2-6 | 6 ++++++ ChangeLog.pre-2-8 | 6 ++++++ docs/reference/glib/tmpl/datalist.sgml | 26 ++++++++++++++++---------- docs/reference/glib/tmpl/main.sgml | 14 +++++++------- docs/reference/glib/tmpl/markup.sgml | 9 +++++++++ docs/reference/glib/tmpl/unicode.sgml | 10 ++++++++++ docs/reference/gobject/tmpl/gtypeplugin.sgml | 4 ++-- glib/gmain.c | 10 +++++++++- 13 files changed, 95 insertions(+), 20 deletions(-) diff --git a/ChangeLog b/ChangeLog index 43223dc..6d76009 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 43223dc..6d76009 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 43223dc..6d76009 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 43223dc..6d76009 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 43223dc..6d76009 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 43223dc..6d76009 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 43223dc..6d76009 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,9 @@ +2002-09-01 Soeren Sandmann + + * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: + + Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss) + 2002-08-26 Tor Lillqvist * configure.in (G_LIBS_EXTRA): Don't link with -lwsock32 on diff --git a/docs/reference/glib/tmpl/datalist.sgml b/docs/reference/glib/tmpl/datalist.sgml index 60c2bf4..fea61b6 100644 --- a/docs/reference/glib/tmpl/datalist.sgml +++ b/docs/reference/glib/tmpl/datalist.sgml @@ -7,15 +7,16 @@ lists of data elements which are accessible by a string or #GQuark identifier. Keyed data lists provide lists of arbitrary data elements which can be accessed -either with a string or with a #GQuark corresponding to the string. +either with a string or with a #GQuark corresponding to the +string. The #GQuark methods are quicker, since the strings have to be converted to #GQuarks anyway. -Data lists are used in GTK+ for associating arbitrary data with -#GtkObjects, using gtk_object_set_data() and related functions. +Data lists are used for associating arbitrary data with +#GObjects, using g_object_set_data() and related functions. @@ -72,7 +73,8 @@ destroy function is called. @dl: a datalist. @q: the #GQuark to identify the data element. -@d: the data element. +@d: the data element, or %NULL to remove any previous element +corresponding to @q. @@ -85,15 +87,17 @@ destroy function is called. @datalist: a datalist. @key_id: the #GQuark to identify the data element. -@data: the data element. +@data: the data element or %NULL to remove any previous element +corresponding to @key_id. @destroy_func: the function to call when the data element is removed. This function will be called with the data element and can be used to free any -memory allocated for it. +memory allocated for it. If @data is %NULL, then @destroy_func must +also be %NULL. -Gets a data element. +Retrieves the data element corresponding to @key_id. @datalist: a datalist. @@ -127,7 +131,8 @@ Sets the data element corresponding to the given string identifier. @dl: a datalist. @k: the string to identify the data element. -@d: the data element. +@d: the data element, or %NULL to remove any previous element +corresponding to @k. @@ -138,10 +143,11 @@ function to be called when the data element is removed. @dl: a datalist. @k: the string to identify the data element. -@d: the data element. +@d: the data element, or %NULL to remove any previous element corresponding to +@k. @f: the function to call when the data element is removed. This function will be called with the data element and can be used to free any -memory allocated for it. +memory allocated for it. If @d is %NULL, then @f must also be %NULL. diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml index 44970ee..ce5a12f 100644 --- a/docs/reference/glib/tmpl/main.sgml +++ b/docs/reference/glib/tmpl/main.sgml @@ -626,6 +626,13 @@ an event source. + + + + + + + The #GSourceFuncs struct contains a table of functions used to handle @@ -719,13 +726,6 @@ functions for managing callback objects. @unref: Called when a reference to the callback object is dropped. @get: Called to extract the callback function and data from the callback object. - - - - - - - diff --git a/docs/reference/glib/tmpl/markup.sgml b/docs/reference/glib/tmpl/markup.sgml index b34d6ec..d3831a0 100644 --- a/docs/reference/glib/tmpl/markup.sgml +++ b/docs/reference/glib/tmpl/markup.sgml @@ -181,6 +181,15 @@ passthrough text back out in the same position @char_number: + + + + + +@context: +@Returns: + + diff --git a/docs/reference/glib/tmpl/unicode.sgml b/docs/reference/glib/tmpl/unicode.sgml index 45f884f..e762a92 100644 --- a/docs/reference/glib/tmpl/unicode.sgml +++ b/docs/reference/glib/tmpl/unicode.sgml @@ -463,6 +463,16 @@ that may contain invalid UTF-8. @ch: + + + + + +@str: +@len: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/gtypeplugin.sgml b/docs/reference/gobject/tmpl/gtypeplugin.sgml index c254eaf..284c74f 100644 --- a/docs/reference/gobject/tmpl/gtypeplugin.sgml +++ b/docs/reference/gobject/tmpl/gtypeplugin.sgml @@ -53,8 +53,8 @@ GTypePlugin @plugin: -@interface_type: @instance_type: +@interface_type: @info: @@ -91,8 +91,8 @@ GTypePlugin @plugin: -@interface_type: @instance_type: +@interface_type: @info: diff --git a/glib/gmain.c b/glib/gmain.c index 02e8793..14e09ac 100644 --- a/glib/gmain.c +++ b/glib/gmain.c @@ -1111,7 +1111,15 @@ static GSourceCallbackFuncs g_source_callback_funcs = { * @data: the data to pass to callback function * @notify: a function to call when @data is no longer in use, or %NULL. * - * Sets the callback function for a source. + * Sets the callback function for a source. The callback for a source is + * called from the source's dispatch function. + * + * The exact type of @func depends on the type of source; ie. you + * should not count on @func being called with @data as its first + * parameter. + * + * Typically, you won't use this function. Instead use functions specific + * to the type of source you are using. **/ void g_source_set_callback (GSource *source, -- 2.7.4