[glib] Clarify g_ptr_array_set_size() docs re: free_func



commit f393e805874db16334c5c4f4aa7fa1c73964ca34
Author: Dan Winship <danw gnome org>
Date:   Tue Sep 8 11:19:13 2009 -0400

    Clarify g_ptr_array_set_size() docs re: free_func

 docs/reference/glib/tmpl/arrays_pointer.sgml |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/glib/tmpl/arrays_pointer.sgml b/docs/reference/glib/tmpl/arrays_pointer.sgml
index 07c4569..6cf53bc 100644
--- a/docs/reference/glib/tmpl/arrays_pointer.sgml
+++ b/docs/reference/glib/tmpl/arrays_pointer.sgml
@@ -252,8 +252,11 @@ the array.
 
 <!-- ##### FUNCTION g_ptr_array_set_size ##### -->
 <para>
-Sets the size of the array, expanding it if necessary.
-New elements are set to %NULL.
+Sets the size of the array. When making the array larger, newly-added
+elements will be set to %NULL. When making it smaller, if @array has a
+non-%NULL #GDestroyNotify function then it will be called for the
+removed elements.
+
 </para>
 
 @array: a #GPtrArray.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]