gtkstylecontext: Clarify memory allocation behaviour of getters

It wasn’t clear that gtk_style_context_get[_valist]() behave like
g_object_get() — i.e. pointer-based types are returned newly-allocated.
Clarify that.

https://bugzilla.gnome.org/show_bug.cgi?id=773954
This commit is contained in:
Philip Withnall 2016-11-04 20:16:06 +00:00 committed by Philip Withnall
parent f4fa111e32
commit 1dbdbecd39

View File

@ -774,6 +774,12 @@ gtk_style_context_get_property (GtkStyleContext *context,
*
* See gtk_style_context_get_property() for details.
*
* As with g_object_get(), a copy is made of the property contents for
* pointer-valued properties, and the caller is responsible for freeing the
* memory in the appropriate manner for the type. For example, by calling
* g_free() or g_object_unref(). Non-pointer-valued properties, such as
* integers, are returned by value and do not need to be freed.
*
* Since: 3.0
*/
void
@ -819,6 +825,12 @@ gtk_style_context_get_valist (GtkStyleContext *context,
*
* See gtk_style_context_get_property() for details.
*
* As with g_object_get(), a copy is made of the property contents for
* pointer-valued properties, and the caller is responsible for freeing the
* memory in the appropriate manner for the type. For example, by calling
* g_free() or g_object_unref(). Non-pointer-valued properties, such as
* integers, are returned by value and do not need to be freed.
*
* Since: 3.0
*/
void