1
0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-04 15:12:10 +01:00

Clarify docs a little. (, Tristan van Berkom)

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

	* glib/gqueue.c (g_queue_find_custom): Clarify docs
	a little.  (, Tristan van Berkom)
This commit is contained in:
Matthias Clasen 2005-08-15 18:28:12 +00:00 committed by Matthias Clasen
parent fd29de0c97
commit 95ffa1e5af
8 changed files with 35 additions and 12 deletions

@ -1,5 +1,8 @@
2005-08-15 Matthias Clasen <mclasen@redhat.com> 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 * glib/abicheck.sh, gobject/abicheck.sh: Make the
check work on ia64 too, where some symbols ended up check work on ia64 too, where some symbols ended up
in yet another section. in yet another section.

@ -1,5 +1,8 @@
2005-08-15 Matthias Clasen <mclasen@redhat.com> 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 * glib/abicheck.sh, gobject/abicheck.sh: Make the
check work on ia64 too, where some symbols ended up check work on ia64 too, where some symbols ended up
in yet another section. in yet another section.

@ -1,5 +1,8 @@
2005-08-15 Matthias Clasen <mclasen@redhat.com> 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 * glib/abicheck.sh, gobject/abicheck.sh: Make the
check work on ia64 too, where some symbols ended up check work on ia64 too, where some symbols ended up
in yet another section. in yet another section.

@ -1,5 +1,8 @@
2005-08-15 Matthias Clasen <mclasen@redhat.com> 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 * glib/abicheck.sh, gobject/abicheck.sh: Make the
check work on ia64 too, where some symbols ended up check work on ia64 too, where some symbols ended up
in yet another section. in yet another section.

@ -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> 2005-08-12 Matthias Clasen <mclasen@redhat.com>
* === Released 2.8.0 === * === Released 2.8.0 ===

@ -293,10 +293,11 @@ Sorts a #GList using the given comparison function.
</para> </para>
@list: a #GList. @list: a #GList.
@compare_func: the comparison function used to sort the #GList. This function @compare_func: the comparison function used to sort the #GList.
is passed 2 elements of the #GList and should return 0 if they are equal, This function is passed the data from 2 elements of the #GList and should
a negative value if the first element comes before the second, or a positive return 0 if they are equal, a negative value if the first element
value if the first element comes after the second. comes before the second, or a positive value if the first element
comes after the second.
@Returns: the start of the sorted #GList. @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. element.
It iterates over the list, calling the given function which should return 0 It iterates over the list, calling the given function which should return 0
when the desired element is found. when the desired element is found.
The function takes two #gconstpointer arguments, the #GList element's data The function takes two #gconstpointer arguments, the #GList element's data as
and the given user data. the first argument and the given user data.
</para> </para>
@list: a #GList. @list: a #GList.

@ -284,8 +284,12 @@ Sorts a #GSList using the given comparison function.
</para> </para>
@list: a #GSList. @list: a #GSList.
@compare_func: <function>qsort()</function>-style comparison function. @compare_func: the comparison function used to sort the #GSList.
@Returns: the start of the sorted #GList. 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 ##### --> <!-- ##### 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. element.
It iterates over the list, calling the given function which should return 0 It iterates over the list, calling the given function which should return 0
when the desired element is found. when the desired element is found.
The function takes two #gconstpointer arguments, the #GSList element's data The function takes two #gconstpointer arguments, the #GSList element's data as
and the given user data. the first argument and the given user data.
</para> </para>
@list: a #GSList. @list: a #GSList.

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