From: Matthias Clasen <mclasen@redhat.com>
Date: Tue, 29 Mar 2005 13:47:23 +0000 (+0000)
Subject: Clarify the docs for g_ptr_array_free. (#170149, Jared Lash)
X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=46fda0cf412cb1340173eb6269c42ddb31c1b8c9;p=dana%2Fcg-glib.git

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 3529912f..0f24aa0e 100644
--- 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 cbf7ae46..605f1b53 100644
--- 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 ##### -->