Documentation updates.

This commit is contained in:
Matthias Clasen
2004-02-27 21:11:51 +00:00
parent d77011caf4
commit 3ce97fa284
11 changed files with 78 additions and 24 deletions

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:13:22 2004 Matthias Clasen <maclas@gmx.de>
* glib/gqueue.c: Trivial doc changes.
Fri Feb 27 21:58:20 2004 Matthias Clasen <maclas@gmx.de>
* glib/ghash.c (g_hash_table_find): Add "Since: 2.4"
2004-02-27 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-27 Sebastian Wilhelmi <seppi@seppi.de>
* glib/gasyncqueue.c, glib/gasyncqueue.h: Use * glib/gasyncqueue.c, glib/gasyncqueue.h: Use

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:13:22 2004 Matthias Clasen <maclas@gmx.de>
* glib/gqueue.c: Trivial doc changes.
Fri Feb 27 21:58:20 2004 Matthias Clasen <maclas@gmx.de>
* glib/ghash.c (g_hash_table_find): Add "Since: 2.4"
2004-02-27 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-27 Sebastian Wilhelmi <seppi@seppi.de>
* glib/gasyncqueue.c, glib/gasyncqueue.h: Use * glib/gasyncqueue.c, glib/gasyncqueue.h: Use

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:13:22 2004 Matthias Clasen <maclas@gmx.de>
* glib/gqueue.c: Trivial doc changes.
Fri Feb 27 21:58:20 2004 Matthias Clasen <maclas@gmx.de>
* glib/ghash.c (g_hash_table_find): Add "Since: 2.4"
2004-02-27 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-27 Sebastian Wilhelmi <seppi@seppi.de>
* glib/gasyncqueue.c, glib/gasyncqueue.h: Use * glib/gasyncqueue.c, glib/gasyncqueue.h: Use

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:13:22 2004 Matthias Clasen <maclas@gmx.de>
* glib/gqueue.c: Trivial doc changes.
Fri Feb 27 21:58:20 2004 Matthias Clasen <maclas@gmx.de>
* glib/ghash.c (g_hash_table_find): Add "Since: 2.4"
2004-02-27 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-27 Sebastian Wilhelmi <seppi@seppi.de>
* glib/gasyncqueue.c, glib/gasyncqueue.h: Use * glib/gasyncqueue.c, glib/gasyncqueue.h: Use

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:13:22 2004 Matthias Clasen <maclas@gmx.de>
* glib/gqueue.c: Trivial doc changes.
Fri Feb 27 21:58:20 2004 Matthias Clasen <maclas@gmx.de>
* glib/ghash.c (g_hash_table_find): Add "Since: 2.4"
2004-02-27 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-27 Sebastian Wilhelmi <seppi@seppi.de>
* glib/gasyncqueue.c, glib/gasyncqueue.h: Use * glib/gasyncqueue.c, glib/gasyncqueue.h: Use

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:13:22 2004 Matthias Clasen <maclas@gmx.de>
* glib/gqueue.c: Trivial doc changes.
Fri Feb 27 21:58:20 2004 Matthias Clasen <maclas@gmx.de>
* glib/ghash.c (g_hash_table_find): Add "Since: 2.4"
2004-02-27 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-27 Sebastian Wilhelmi <seppi@seppi.de>
* glib/gasyncqueue.c, glib/gasyncqueue.h: Use * glib/gasyncqueue.c, glib/gasyncqueue.h: Use

View File

@@ -1,3 +1,11 @@
Fri Feb 27 22:10:25 2004 Matthias Clasen <maclas@gmx.de>
* glib/tmpl/modules.sgml: Reformat a bit.
Fri Feb 27 22:05:23 2004 Matthias Clasen <maclas@gmx.de>
* glib/tmpl/limits.sgml: Document G_MAXSIZE.
2004-02-26 Sebastian Wilhelmi <seppi@seppi.de> 2004-02-26 Sebastian Wilhelmi <seppi@seppi.de>
* glib/tmpl/threads.sgml: Updated to reflect removal of the PID * glib/tmpl/threads.sgml: Updated to reflect removal of the PID

View File

@@ -173,10 +173,10 @@ The maximum value which can be held in a #guint64.
<!-- ##### MACRO G_MAXSIZE ##### --> <!-- ##### MACRO G_MAXSIZE ##### -->
<para> <para>
The maximum value which can be held in a #gssize.
</para> </para>
@Since: 2.4
<!-- ##### MACRO G_MINFLOAT ##### --> <!-- ##### MACRO G_MINFLOAT ##### -->
<para> <para>

View File

@@ -115,20 +115,17 @@ OR of any of the #GModuleFlags.
<!-- ##### ENUM GModuleFlags ##### --> <!-- ##### ENUM GModuleFlags ##### -->
<para> <para>
Flags passed to g_module_open(). Flags passed to g_module_open(). Note that these flags are
#G_MODULE_BIND_LAZY specifies that symbols are only resolved when needed. not supported on all platforms.
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.)
</para> </para>
@G_MODULE_BIND_LAZY: @G_MODULE_BIND_LAZY: specifies that symbols are only resolved when needed.
@G_MODULE_BIND_LOCAL: The default action is to bind all symbols when the module is loaded.
@G_MODULE_BIND_MASK: @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.
<!-- ##### FUNCTION g_module_symbol ##### --> <!-- ##### FUNCTION g_module_symbol ##### -->
<para> <para>

View File

@@ -565,15 +565,16 @@ g_hash_table_foreach (GHashTable *hash_table,
* @predicate: function to test the key/value pairs for a certain property. * @predicate: function to test the key/value pairs for a certain property.
* @user_data: user data to pass to the function. * @user_data: user data to pass to the function.
* *
* Calls the given function for key/value pairs in the * Calls the given function for key/value pairs in the #GHashTable until
* #GHashTable until @predicate returns %TRUE. The function is passed * @predicate returns %TRUE. The function is passed the key and value of
* the key and value of each pair, and the given @user_data parameter. * each pair, and the given @user_data parameter. The hash table may not
* The hash table may not * be modified while iterating over it (you can't add/remove items).
* 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 * 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, * func evaluates to %TRUE. If no pair with the requested property is found,
* %NULL is returned * %NULL is returned.
*
* Since: 2.4
**/ **/
gpointer gpointer
g_hash_table_find (GHashTable *hash_table, g_hash_table_find (GHashTable *hash_table,

View File

@@ -144,7 +144,7 @@ g_queue_reverse (GQueue *queue)
* g_queue_copy: * g_queue_copy:
* @queue: a #GQueue * @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 * queue consist of pointers to data, the pointers are copied, but the
* actual data is not. * 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 * larger than the number of elements in the @queue, the element is
* added to the end of the queue. * 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 * Since: 2.4
**/ **/
@@ -399,7 +399,7 @@ g_queue_push_tail_link (GQueue *queue,
* @queue. * @queue.
* @link_: the link to add to @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 * Since: 2.4
**/ **/