summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSoeren Sandmann <sandmann@daimi.au.dk>2002-09-01 13:04:02 +0000
committerSøren Sandmann Pedersen <ssp@src.gnome.org>2002-09-01 13:04:02 +0000
commit4acacec101e4fb1456bcdf7f0b503f8e5d809cd1 (patch)
tree9832b485771feedf6334201df110c7b274d0d0f7 /docs
parent5f7945dea99027dbd93cadbf59d51aaaa5e84b40 (diff)
Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss)
2002-09-01 Soeren Sandmann <sandmann@daimi.au.dk> * docs/reference/glib/tmpl/datalist.sgml, glib/gmain.c: Documentation fixes: (#75255, Martin Schulze; #76104, Daryll Strauss)
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/glib/tmpl/datalist.sgml26
-rw-r--r--docs/reference/glib/tmpl/main.sgml14
-rw-r--r--docs/reference/glib/tmpl/markup.sgml9
-rw-r--r--docs/reference/glib/tmpl/unicode.sgml10
-rw-r--r--docs/reference/gobject/tmpl/gtypeplugin.sgml4
5 files changed, 44 insertions, 19 deletions
diff --git a/docs/reference/glib/tmpl/datalist.sgml b/docs/reference/glib/tmpl/datalist.sgml
index 60c2bf418..fea61b65e 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.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
The #GQuark methods are quicker, since the strings have to be converted to
#GQuarks anyway.
</para>
<para>
-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.
</para>
<para>
@@ -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.
<!-- ##### FUNCTION g_datalist_id_set_data_full ##### -->
@@ -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.
<!-- ##### FUNCTION g_datalist_id_get_data ##### -->
<para>
-Gets a data element.
+Retrieves the data element corresponding to @key_id.
</para>
@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.
<!-- ##### MACRO g_datalist_set_data_full ##### -->
@@ -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.
<!-- ##### MACRO g_datalist_get_data ##### -->
diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml
index 44970ee07..ce5a12fe2 100644
--- a/docs/reference/glib/tmpl/main.sgml
+++ b/docs/reference/glib/tmpl/main.sgml
@@ -626,6 +626,13 @@ an event source.
</para>
+<!-- ##### USER_FUNCTION GSourceDummyMarshal ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### STRUCT GSourceFuncs ##### -->
<para>
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.
-<!-- ##### USER_FUNCTION GSourceDummyMarshal ##### -->
-<para>
-
-</para>
-
-
-
<!-- ##### FUNCTION g_source_new ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/markup.sgml b/docs/reference/glib/tmpl/markup.sgml
index b34d6ec2e..d3831a079 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:
+<!-- ##### FUNCTION g_markup_parse_context_get_element ##### -->
+<para>
+
+</para>
+
+@context:
+@Returns:
+
+
<!-- ##### FUNCTION g_markup_parse_context_new ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/unicode.sgml b/docs/reference/glib/tmpl/unicode.sgml
index 45f884f45..e762a92d4 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:
+<!-- ##### FUNCTION g_utf8_strreverse ##### -->
+<para>
+
+</para>
+
+@str:
+@len:
+@Returns:
+
+
<!-- ##### FUNCTION g_utf8_validate ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/gtypeplugin.sgml b/docs/reference/gobject/tmpl/gtypeplugin.sgml
index c254eafb5..284c74f44 100644
--- a/docs/reference/gobject/tmpl/gtypeplugin.sgml
+++ b/docs/reference/gobject/tmpl/gtypeplugin.sgml
@@ -53,8 +53,8 @@ GTypePlugin
</para>
@plugin:
-@interface_type:
@instance_type:
+@interface_type:
@info:
@@ -91,8 +91,8 @@ GTypePlugin
</para>
@plugin:
-@interface_type:
@instance_type:
+@interface_type:
@info: