From 9b6f47f9b4fa3191ca1c5a3de8c4b974bd9f1ff7 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 30 Mar 2006 20:38:09 +0000 Subject: [PATCH] Update the floating docs wrt to GInitiallyUnowned. 2006-03-30 Matthias Clasen * gobject/tmpl/objects.sgml: Update the floating docs wrt to GInitiallyUnowned. --- docs/reference/ChangeLog | 3 +++ docs/reference/gobject/tmpl/objects.sgml | 14 ++++++++------ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 752fb836..09e2061c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,8 @@ 2006-03-30 Matthias Clasen + * gobject/tmpl/objects.sgml: Update the floating docs wrt + to GInitiallyUnowned. + * gobject/tmpl/param_value_types.sgml: * gobject/tmpl/objects.sgml: * gobject/tmpl/gtype.sgml: Additions diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index d862e920..522896e6 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -13,11 +13,12 @@ property access methods, and signal support. Signals are described in detail in . -The initial reference a #GObject is created with is flagged as a -floating reference. +#GInitiallyUnowned is derived from #GObject. The only difference between +the two is that the initial reference of a #GInitiallyUnowned is flagged +as a floating reference. This means that it is not specifically claimed to be "owned" by any code portion. The main motivation for providing floating references is -C convenience. In particular, it allowes code to be written as: +C convenience. In particular, it allows code to be written as: container = create_container(); container_add_child (container, create_child()); @@ -39,7 +40,7 @@ an ordinary reference by calling g_object_ref_sink(). For already sunken objects (objects that don't have a floating reference anymore), g_object_ref_sink() is equivalent to g_object_ref() and returns a new reference. -Since floating references are useful allmost exclusively for C convenience, +Since floating references are useful almost exclusively for C convenience, language bindings that provide automated reference and memory ownership maintenance (such as smart pointers or garbage collection) therefore don't need to expose floating references in their API. @@ -145,6 +146,7 @@ my_singleton_constructor (GType type, needed. @notify: the class closure for the notify signal + The GObjectConstructParam struct is an auxiliary @@ -484,8 +486,8 @@ reference. This function is intended for #GObject implementations to re-enforce a floating object reference. Doing this is seldomly required, all -#GObjects are created with a floating reference which usually -just needs to be sunken by calling g_object_ref_sink(). +#GInitiallyUnowneds are created with a floating reference which +usually just needs to be sunken by calling g_object_ref_sink(). @object: a #GObject -- 2.34.1