Add a note about double indirection in g_ptr_array_sort[_with_data]().

2003-07-18  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/arrays_pointer.sgml: Add a note about double indirection in
	g_ptr_array_sort[_with_data]().  (#113697, Owen Taylor)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 1ca5e48..e5c06e6 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2003-07-18  Matthias Clasen  <maclas@gmx.de>
+
+       * glib/tmpl/arrays_pointer.sgml: Add a note about double indirection in 
+       g_ptr_array_sort[_with_data]().  (#113697, Owen Taylor)
+
 2003-07-12  Matthias Clasen  <maclas@gmx.de>
 
        * glib/tmpl/string_utils.sgml: Add a paragraph about string precision, add links to it.

diff --git a/docs/reference/glib/tmpl/arrays_pointer.sgml b/docs/reference/glib/tmpl/arrays_pointer.sgml
index 23fda03..e609b44 100644 (file)
--- a/docs/reference/glib/tmpl/arrays_pointer.sgml
+++ b/docs/reference/glib/tmpl/arrays_pointer.sgml
@@ -161,6 +161,10 @@ Sorts the array, using @compare_func which should be a <function>qsort()</functi
 function (returns -1 for first arg is less than second arg, 0 for equal, 1 if
 first arg is greater than second arg).
 </para>
+<note><para>
+The comparison function for g_ptr_array_sort() doesn't take the pointers from the array as arguments, 
+it takes pointers to the pointers in the array.
+</para></note>
 
 @array: a #GPtrArray.
 @compare_func: comparison function.
@@ -170,6 +174,10 @@ first arg is greater than second arg).
 <para>
 Like g_ptr_array_sort(), but the comparison function has a user data argument.
 </para>
+<note><para>
+The comparison function for g_ptr_array_sort_with_data() doesn't take the pointers from the array as arguments, 
+it takes pointers to the pointers in the array.
+</para></note>
 
 @array: a #GPtrArray.
 @compare_func: comparison function.