Document ->constructed().

2007-04-02  Ryan Lortie  <desrt@desrt.ca>

        * gobject/tmpl/objects.sgml: Document ->constructed().

svn path=/trunk/; revision=5440

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 9e286d4..4c8fc27 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2007-04-02  Ryan Lortie  <desrt@desrt.ca>
+
+       * gobject/tmpl/objects.sgml: Document ->constructed().
+
 2007-03-18  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/thread_pools.sgml:

diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml
index babe8ad..44d101e 100644 (file)
--- a/docs/reference/gobject/tmpl/objects.sgml
+++ b/docs/reference/gobject/tmpl/objects.sgml
@@ -156,6 +156,13 @@ my_singleton_constructor (GType                  type,
   of properties. Overriding @dispatch_properties_changed should be rarely 
   needed.
 @notify: the class closure for the notify signal
+@constructed: the @constructed function is called by g_object_new() as the
+  final step of the object creation process.  At the point of the call, all
+  construction properties have been set on the object.  The purpose of this
+  call is to allow for object initialisation steps that can only be performed
+  after construction properties have been set.  @constructed implementors
+  should chain up to the @constructed call of their parent class to allow it
+  to complete its initialisation.
 
 <!-- ##### STRUCT GObjectConstructParam ##### -->
 <para>