From 95ffa1e5af8f84e079ed760595c13974a3ed5238 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 15 Aug 2005 18:28:12 +0000 Subject: [PATCH] Clarify docs a little. (#311727, Tristan van Berkom) 2005-08-15 Matthias Clasen * glib/gqueue.c (g_queue_find_custom): Clarify docs a little. (#311727, Tristan van Berkom) --- ChangeLog | 3 +++ ChangeLog.pre-2-10 | 3 +++ ChangeLog.pre-2-12 | 3 +++ ChangeLog.pre-2-8 | 3 +++ docs/reference/ChangeLog | 6 ++++++ docs/reference/glib/tmpl/linked_lists_double.sgml | 13 +++++++------ docs/reference/glib/tmpl/linked_lists_single.sgml | 12 ++++++++---- glib/gqueue.c | 4 ++-- 8 files changed, 35 insertions(+), 12 deletions(-) diff --git a/ChangeLog b/ChangeLog index d94f01f..5df555c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2005-08-15 Matthias Clasen + * 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 d94f01f..5df555c 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,5 +1,8 @@ 2005-08-15 Matthias Clasen + * 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 d94f01f..5df555c 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,5 +1,8 @@ 2005-08-15 Matthias Clasen + * 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 d94f01f..5df555c 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,5 +1,8 @@ 2005-08-15 Matthias Clasen + * 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 3e7ba64..319adbc 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +2005-08-15 Matthias Clasen + + * 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 * === 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 f0398bb..4500af9 100644 --- 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. @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. @list: a #GList. diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml index 64b7cf7..7d3c3fd 100644 --- 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. @list: a #GSList. -@compare_func: qsort()-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. @@ -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. @list: a #GSList. diff --git a/glib/gqueue.c b/glib/gqueue.c index 5159f25..0351942 100644 --- 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 * -- 2.7.4