From 4aedc85fb35f58b602259d34b94dcebeefa198bc Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Fri, 19 Dec 2014 19:02:15 +0000 Subject: [PATCH] gobject: Mention g_clear_object() in g_object_unref() documentation https://bugzilla.gnome.org/show_bug.cgi?id=741779 --- gobject/gobject.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/gobject/gobject.c b/gobject/gobject.c index 4a8d0322e..ae6265ea6 100644 --- a/gobject/gobject.c +++ b/gobject/gobject.c @@ -3057,6 +3057,11 @@ g_object_ref (gpointer _object) * * Decreases the reference count of @object. When its reference count * drops to 0, the object is finalized (i.e. its memory is freed). + * + * If the pointer to the #GObject may be reused in future (for example, if it is + * an instance variable of another object), it is recommended to clear the + * pointer to %NULL rather than retain a dangling pointer to a potentially + * invalid #GObject instance. Use g_clear_object() for this. */ void g_object_unref (gpointer _object)