Clarify docs a little. (#311727, Tristan van Berkom)

2005-08-15  Matthias Clasen  <mclasen@redhat.com>

	* glib/gqueue.c (g_queue_find_custom): Clarify docs
	a little.  (#311727, Tristan van Berkom)

diff --git a/ChangeLog b/ChangeLog
index d94f01f373a11ee907d1a325e6e248b9f5143f84..5df555cb004edd79a12f003284a35bfa99f73f6e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2005-08-15  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/gqueue.c (g_queue_find_custom): Clarify docs
+       a little.  (#311727, Tristan van Berkom)
+
        * glib/abicheck.sh, gobject/abicheck.sh: Make the 
        check work on ia64 too, where some symbols ended up 
        in yet another section.

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index d94f01f373a11ee907d1a325e6e248b9f5143f84..5df555cb004edd79a12f003284a35bfa99f73f6e 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,5 +1,8 @@
 2005-08-15  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/gqueue.c (g_queue_find_custom): Clarify docs
+       a little.  (#311727, Tristan van Berkom)
+
        * glib/abicheck.sh, gobject/abicheck.sh: Make the 
        check work on ia64 too, where some symbols ended up 
        in yet another section.

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index d94f01f373a11ee907d1a325e6e248b9f5143f84..5df555cb004edd79a12f003284a35bfa99f73f6e 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,5 +1,8 @@
 2005-08-15  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/gqueue.c (g_queue_find_custom): Clarify docs
+       a little.  (#311727, Tristan van Berkom)
+
        * glib/abicheck.sh, gobject/abicheck.sh: Make the 
        check work on ia64 too, where some symbols ended up 
        in yet another section.

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index d94f01f373a11ee907d1a325e6e248b9f5143f84..5df555cb004edd79a12f003284a35bfa99f73f6e 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,5 +1,8 @@
 2005-08-15  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/gqueue.c (g_queue_find_custom): Clarify docs
+       a little.  (#311727, Tristan van Berkom)
+
        * glib/abicheck.sh, gobject/abicheck.sh: Make the 
        check work on ia64 too, where some symbols ended up 
        in yet another section.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 3e7ba64ec72807f259a25ed3b54dbea57a6624d8..319adbceb2b64825922bb2985daa3e30682094c9 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+2005-08-15  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/tmpl/linked_lists_single.sgml: 
+       * glib/tmpl/linked_lists_double.sgml: Clarify docs
+       a little.  (#311727, Tristan van Berkom)
+
 2005-08-12  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.8.0 ===

diff --git a/docs/reference/glib/tmpl/linked_lists_double.sgml b/docs/reference/glib/tmpl/linked_lists_double.sgml
index f0398bb1c01a93b43b9b29c2675bbbf9c08acf77..4500af9aae67b1f6a1b54cd812a858ca56a20539 100644 (file)
--- a/docs/reference/glib/tmpl/linked_lists_double.sgml
+++ b/docs/reference/glib/tmpl/linked_lists_double.sgml
@@ -293,10 +293,11 @@ Sorts a #GList using the given comparison function.
 </para>
 
 @list: a #GList.
-@compare_func: the comparison function used to sort the #GList. This function
-is passed 2 elements of the #GList and should return 0 if they are equal,
-a negative value if the first element comes before the second, or a positive
-value if the first element comes after the second.
+@compare_func: the comparison function used to sort the #GList. 
+This function is passed the data from 2 elements of the #GList and should 
+return 0 if they are equal, a negative value if the first element 
+comes before the second, or a positive value if the first element 
+comes after the second.
 @Returns: the start of the sorted #GList.
 
 
@@ -456,8 +457,8 @@ Finds an element in a #GList, using a supplied function to find the desired
 element.
 It iterates over the list, calling the given function which should return 0
 when the desired element is found.
-The function takes two #gconstpointer arguments, the #GList element's data
-and the given user data.
+The function takes two #gconstpointer arguments, the #GList element's data as
+the first argument and the given user data.
 </para>
 
 @list: a #GList.

diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml
index 64b7cf705f188d12240019398f2e9278a31dcb81..7d3c3fd9c20796a45bd97d913e0ba32a028a3381 100644 (file)
--- a/docs/reference/glib/tmpl/linked_lists_single.sgml
+++ b/docs/reference/glib/tmpl/linked_lists_single.sgml
@@ -284,8 +284,12 @@ Sorts a #GSList using the given comparison function.
 </para>
 
 @list: a #GSList.
-@compare_func: <function>qsort()</function>-style comparison function.
-@Returns: the start of the sorted #GList.
+@compare_func: the comparison function used to sort the #GSList. 
+This function is passed the data from 2 elements of the #GSList and should 
+return 0 if they are equal, a negative value if the first element 
+comes before the second, or a positive value if the first element 
+comes after the second.
+@Returns: the start of the sorted #GSList.
 
 
 <!-- ##### FUNCTION g_slist_sort_with_data ##### -->
@@ -377,8 +381,8 @@ Finds an element in a #GSList, using a supplied function to find the desired
 element.
 It iterates over the list, calling the given function which should return 0
 when the desired element is found.
-The function takes two #gconstpointer arguments, the #GSList element's data
-and the given user data.
+The function takes two #gconstpointer arguments, the #GSList element's data as
+the first argument and the given user data.
 </para>
 
 @list: a #GSList.

diff --git a/glib/gqueue.c b/glib/gqueue.c
index 5159f255cb0579da159c11c46cda97178c0b61e5..035194271c23a0a4aa6ecd96cdab84931fc6d160 100644 (file)
--- a/glib/gqueue.c
+++ b/glib/gqueue.c
@@ -229,8 +229,8 @@ g_queue_find (GQueue        *queue,
  * Finds an element in a #GQueue, using a supplied function to find the
  * desired element. It iterates over the queue, calling the given function
  * which should return 0 when the desired element is found. The function
- * takes two gconstpointer arguments, the #GQueue element's data and the
- * given user data.
+ * takes two gconstpointer arguments, the #GQueue element's data as the
+ * first argument and the given user data as the second argument.
  * 
  * Return value: The found link, or %NULL if it wasn't found
  *