[glib/wip/rishi/docs-garray: 1/2] docs: Use the correct terminology for g_array_free



commit 30ccd6f01bb37d02c55b0ae459e03932c1357423
Author: Debarshi Ray <debarshir gnome org>
Date:   Mon Sep 24 15:44:10 2018 +0200

    docs: Use the correct terminology for g_array_free
    
    GArray uses the term clear_func (eg., g_array_set_clear_func), while
    element_free_func comes from GPtrArray.
    
    https://gitlab.gnome.org/GNOME/glib/merge_requests/348

 glib/garray.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
---
diff --git a/glib/garray.c b/glib/garray.c
index a6cbd57bb..488d62bb4 100644
--- a/glib/garray.c
+++ b/glib/garray.c
@@ -319,11 +319,11 @@ g_array_get_element_size (GArray *array)
  *
  * Frees the memory allocated for the #GArray. If @free_segment is
  * %TRUE it frees the memory block holding the elements as well and
- * also each element if @array has a @element_free_func set. Pass
- * %FALSE if you want to free the #GArray wrapper but preserve the
- * underlying array for use elsewhere. If the reference count of @array
- * is greater than one, the #GArray wrapper is preserved but the size
- * of @array will be set to zero.
+ * also each element if @array has a @clear_func set. Pass %FALSE if
+ * you want to free the #GArray wrapper but preserve the underlying
+ * array for use elsewhere. If the reference count of @array is
+ * greater than one, the #GArray wrapper is preserved but the size of
+ * @array will be set to zero.
  *
  * If array elements contain dynamically-allocated memory, they should
  * be freed separately.


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