+2007-11-29 Behdad Esfahbod <behdad@gnome.org>
+
+ Bug 500361 – Improve docs for g_array_free() and g_ptr_array_free()
+
+ * glib/tmpl/arrays.sgml:
+ * glib/tmpl/arrays_pointer.sgml:
+ Document how to free the return value.
+
2007-11-28 Matthias Clasen <mclasen@redhat.com>
* gio/gio-sections.txt: More cleanup
<note>
<para>
If array elements contain dynamically-allocated memory, they should be freed
-first.
+separately.
</para>
</note>
@array: a #GArray.
@free_segment: if %TRUE the actual element data is freed as well.
-@Returns: the element data if @free_segment is %FALSE, otherwise %NULL
+@Returns: the element data if @free_segment is %FALSE, otherwise %NULL.
+ The element data should be freed using g_free().
<!-- ##### FUNCTION g_ptr_array_free ##### -->
<para>
-Frees all of the memory allocated for the pointer array.
+Frees the memory allocated for the #GPtrArray.
+If @free_segment is %TRUE it frees the memory block holding the elements
+as well. Pass %FALSE if you want to free the #GPtrArray wrapper but preserve
+the underlying array for use elsewhere.
</para>
+<note>
+<para>
+If array contents point to dynamically-allocated memory, they should be freed
+separately.
+</para>
+</note>
@array: a #GPtrArray.
-@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.
-
+@free_seg: if %TRUE the actual pointer array is freed as well.
+@Returns: the pointer array if @free_seg is %FALSE, otherwise %NULL.
+ The pointer array should be freed using g_free().
<!-- ##### FUNCTION g_ptr_array_foreach ##### -->
<para>