From 3ce97fa284cbefdc2eb957f50a3a76d6ef923464 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 27 Feb 2004 21:11:51 +0000 Subject: [PATCH] Documentation updates. --- ChangeLog | 8 ++++++++ ChangeLog.pre-2-10 | 8 ++++++++ ChangeLog.pre-2-12 | 8 ++++++++ ChangeLog.pre-2-4 | 8 ++++++++ ChangeLog.pre-2-6 | 8 ++++++++ ChangeLog.pre-2-8 | 8 ++++++++ docs/reference/ChangeLog | 8 ++++++++ docs/reference/glib/tmpl/limits.sgml | 4 ++-- docs/reference/glib/tmpl/modules.sgml | 25 +++++++++++-------------- glib/ghash.c | 15 ++++++++------- glib/gqueue.c | 6 +++--- 11 files changed, 80 insertions(+), 26 deletions(-) diff --git a/ChangeLog b/ChangeLog index 3eabce1..6c0e659 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +Fri Feb 27 22:13:22 2004 Matthias Clasen + + * glib/gqueue.c: Trivial doc changes. + +Fri Feb 27 21:58:20 2004 Matthias Clasen + + * glib/ghash.c (g_hash_table_find): Add "Since: 2.4" + 2004-02-27 Sebastian Wilhelmi * glib/gasyncqueue.c, glib/gasyncqueue.h: Use diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 3eabce1..6c0e659 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,11 @@ +Fri Feb 27 22:13:22 2004 Matthias Clasen + + * glib/gqueue.c: Trivial doc changes. + +Fri Feb 27 21:58:20 2004 Matthias Clasen + + * glib/ghash.c (g_hash_table_find): Add "Since: 2.4" + 2004-02-27 Sebastian Wilhelmi * glib/gasyncqueue.c, glib/gasyncqueue.h: Use diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 3eabce1..6c0e659 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,11 @@ +Fri Feb 27 22:13:22 2004 Matthias Clasen + + * glib/gqueue.c: Trivial doc changes. + +Fri Feb 27 21:58:20 2004 Matthias Clasen + + * glib/ghash.c (g_hash_table_find): Add "Since: 2.4" + 2004-02-27 Sebastian Wilhelmi * glib/gasyncqueue.c, glib/gasyncqueue.h: Use diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 3eabce1..6c0e659 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,11 @@ +Fri Feb 27 22:13:22 2004 Matthias Clasen + + * glib/gqueue.c: Trivial doc changes. + +Fri Feb 27 21:58:20 2004 Matthias Clasen + + * glib/ghash.c (g_hash_table_find): Add "Since: 2.4" + 2004-02-27 Sebastian Wilhelmi * glib/gasyncqueue.c, glib/gasyncqueue.h: Use diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 3eabce1..6c0e659 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,11 @@ +Fri Feb 27 22:13:22 2004 Matthias Clasen + + * glib/gqueue.c: Trivial doc changes. + +Fri Feb 27 21:58:20 2004 Matthias Clasen + + * glib/ghash.c (g_hash_table_find): Add "Since: 2.4" + 2004-02-27 Sebastian Wilhelmi * glib/gasyncqueue.c, glib/gasyncqueue.h: Use diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 3eabce1..6c0e659 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,11 @@ +Fri Feb 27 22:13:22 2004 Matthias Clasen + + * glib/gqueue.c: Trivial doc changes. + +Fri Feb 27 21:58:20 2004 Matthias Clasen + + * glib/ghash.c (g_hash_table_find): Add "Since: 2.4" + 2004-02-27 Sebastian Wilhelmi * glib/gasyncqueue.c, glib/gasyncqueue.h: Use diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 5916f00..ae9e4e2 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,11 @@ +Fri Feb 27 22:10:25 2004 Matthias Clasen + + * glib/tmpl/modules.sgml: Reformat a bit. + +Fri Feb 27 22:05:23 2004 Matthias Clasen + + * glib/tmpl/limits.sgml: Document G_MAXSIZE. + 2004-02-26 Sebastian Wilhelmi * glib/tmpl/threads.sgml: Updated to reflect removal of the PID diff --git a/docs/reference/glib/tmpl/limits.sgml b/docs/reference/glib/tmpl/limits.sgml index a7b891b..90a5a56 100644 --- a/docs/reference/glib/tmpl/limits.sgml +++ b/docs/reference/glib/tmpl/limits.sgml @@ -173,10 +173,10 @@ The maximum value which can be held in a #guint64. - +The maximum value which can be held in a #gssize. - +@Since: 2.4 diff --git a/docs/reference/glib/tmpl/modules.sgml b/docs/reference/glib/tmpl/modules.sgml index ffd70ba..4e9829e 100644 --- a/docs/reference/glib/tmpl/modules.sgml +++ b/docs/reference/glib/tmpl/modules.sgml @@ -115,20 +115,17 @@ OR of any of the #GModuleFlags. -Flags passed to g_module_open(). -#G_MODULE_BIND_LAZY specifies that symbols are only resolved when needed. -The default action is to bind all symbols when the module is loaded. -(#G_MODULE_BIND_LAZY is not supported on all platforms.) -#G_MODULE_BIND_LOCAL specifies that symbols in the module should -not be added to the global name space. The default action on most -platforms is to place symbols in the module in the global name space, -which may cause conflicts with existing symbols. -(#G_MODULE_BIND_LOCAL is not supported on all platforms.) - - -@G_MODULE_BIND_LAZY: -@G_MODULE_BIND_LOCAL: -@G_MODULE_BIND_MASK: +Flags passed to g_module_open(). Note that these flags are +not supported on all platforms. + + +@G_MODULE_BIND_LAZY: specifies that symbols are only resolved when needed. + The default action is to bind all symbols when the module is loaded. +@G_MODULE_BIND_LOCAL:specifies that symbols in the module should + not be added to the global name space. The default action on most + platforms is to place symbols in the module in the global name space, + which may cause conflicts with existing symbols. +@G_MODULE_BIND_MASK: mask for all flags. diff --git a/glib/ghash.c b/glib/ghash.c index a909db9..ecc5c96 100644 --- a/glib/ghash.c +++ b/glib/ghash.c @@ -565,15 +565,16 @@ g_hash_table_foreach (GHashTable *hash_table, * @predicate: function to test the key/value pairs for a certain property. * @user_data: user data to pass to the function. * - * Calls the given function for key/value pairs in the - * #GHashTable until @predicate returns %TRUE. The function is passed - * the key and value of each pair, and the given @user_data parameter. - * The hash table may not - * be modified while iterating over it (you can't add/remove - * items). + * Calls the given function for key/value pairs in the #GHashTable until + * @predicate returns %TRUE. The function is passed the key and value of + * each pair, and the given @user_data parameter. The hash table may not + * be modified while iterating over it (you can't add/remove items). + * * Return value: The value of the first key/value pair is returned, for which * func evaluates to %TRUE. If no pair with the requested property is found, - * %NULL is returned + * %NULL is returned. + * + * Since: 2.4 **/ gpointer g_hash_table_find (GHashTable *hash_table, diff --git a/glib/gqueue.c b/glib/gqueue.c index f7fce05..5d5ef09 100644 --- a/glib/gqueue.c +++ b/glib/gqueue.c @@ -144,7 +144,7 @@ g_queue_reverse (GQueue *queue) * g_queue_copy: * @queue: a #GQueue * - * Copy a @queue. Note that is a shallow copy. If the elements in the + * Copies a @queue. Note that is a shallow copy. If the elements in the * queue consist of pointers to data, the pointers are copied, but the * actual data is not. * @@ -298,7 +298,7 @@ g_queue_push_head (GQueue *queue, * larger than the number of elements in the @queue, the element is * added to the end of the queue. * - * Insert a new element into @queue at the given position + * Inserts a new element into @queue at the given position * * Since: 2.4 **/ @@ -399,7 +399,7 @@ g_queue_push_tail_link (GQueue *queue, * @queue. * @link_: the link to add to @queue * - * Insert @link into @queue at the given position. + * Inserts @link into @queue at the given position. * * Since: 2.4 **/ -- 2.7.4