From 14adec6a54c8e9fd2fcf8a8ee283f213c96e9062 Mon Sep 17 00:00:00 2001 From: Logan Rathbone Date: Wed, 22 Jan 2025 13:29:50 -0500 Subject: [PATCH] docs: Clarify that g_array_unref() works like g_ptr_array_unref(). This makes the documentation for this function more consistent with that of g_ptr_array_unref(), which makes it clear that it acts like g_(ptr_)array_free with free_segment=TRUE. --- glib/garray.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/glib/garray.c b/glib/garray.c index 0272cad02..a4fe4878c 100644 --- a/glib/garray.c +++ b/glib/garray.c @@ -448,9 +448,9 @@ static gchar *array_free (GRealArray *, ArrayFreeFlags); * @array: A #GArray * * Atomically decrements the reference count of @array by one. If the - * reference count drops to 0, all memory allocated by the array is - * released. This function is thread-safe and may be called from any - * thread. + * reference count drops to 0, the effect is the same as calling + * g_array_free() with @free_segment set to %TRUE. This function is + * thread-safe and may be called from any thread. * * Since: 2.22 */