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

[platform/upstream/glib.git] / docs / reference / glib / tmpl / linked_lists_single.sgml

diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml
index 64b7cf7..7d3c3fd 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.