Clarify the docs for g_ptr_array_free. (#170149, Jared Lash)

2005-03-29  Matthias Clasen  <mclasen@redhat.com>

	* glib/tmpl/arrays_pointer.sgml: Clarify the docs for
	g_ptr_array_free.  (#170149, Jared Lash)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 3529912f18083391e50d64fd425a8d2a1a219b93..0f24aa0eb12a8fbaf6569245b9a798c89d9cf9d6 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2005-03-29  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/tmpl/arrays_pointer.sgml: Clarify the docs for
+       g_ptr_array_free.  (#170149, Jared Lash)
+
 2005-03-29  Tor Lillqvist  <tml@novell.com>
 
        * glib/tmpl/spawn.sgml: Add Win32 warnings regarding the child

diff --git a/docs/reference/glib/tmpl/arrays_pointer.sgml b/docs/reference/glib/tmpl/arrays_pointer.sgml
index cbf7ae46c2e0f182b161a6031481165f001193f4..605f1b53c0eb78792d9c3afa343b225f2a3f4e23 100644 (file)
--- a/docs/reference/glib/tmpl/arrays_pointer.sgml
+++ b/docs/reference/glib/tmpl/arrays_pointer.sgml
@@ -222,8 +222,9 @@ Frees all of the memory allocated for the pointer array.
 </para>
 
 @array: a #GPtrArray.
-@free_seg: if %TRUE the actual element data is freed as well.
-@Returns: 
+@free_seg: if %TRUE the array of pointers (@pdata) is freed.
+@Returns: %NULL if @free_seg is %TRUE, otherwise the array of 
+pointers (@pdata) is returned.
 
 
 <!-- ##### FUNCTION g_ptr_array_foreach ##### -->