100%

docs/reference/ChangeLog

@@ -1,3 +1,8 @@
+Sat Oct 25 01:07:45 2003  Matthias Clasen  <maclas@gmx.de>
+
+	* gobject/tmpl/gparamspec.sgml: 
+	* gobject/tmpl/objects.sgml: Additions.
+
 Thu Oct 23 14:27:54 2003  Owen Taylor  <otaylor@redhat.com>
 
 	* gobject/Makefile.am: Add a dist-hook so that the

docs/reference/gobject/tmpl/gparamspec.sgml

@@ -93,7 +93,8 @@ Retrieves the #GType to initialize a #GValue for this parameter.
 
 <!-- ##### STRUCT GParamSpec ##### -->
 <para>
-
+All fields of the <structname>GParamSpec</structname> struct are private and
+should not be used directly, except for the following:
 </para>
 
 @g_type_instance: private #GTypeInstance portion
@@ -104,16 +105,23 @@ Retrieves the #GType to initialize a #GValue for this parameter.
 
 <!-- ##### STRUCT GParamSpecClass ##### -->
 <para>
-
+The class structure for the <structname>GParamSpec</structname> type.
+Normally, <structname>GParamSpec</structname> classes are filled by
+g_param_type_register_static().
 </para>
 
-@g_type_class: 
+@g_type_class: the parent class
-@value_type: 
+@value_type: the #GValue type for this parameter
-@finalize: 
+@finalize: The instance finalization function (optional), should chain 
-@value_set_default: 
+  up to the finalize method of the parent class.
-@value_validate: 
+@value_set_default: Resets a @value to the default value for this type
-@values_cmp: 
+  (recommended, the default is g_value_reset()), see 
-@dummy: 
+  g_param_value_set_default().
+@value_validate: Ensures that the contents of @value comply with the 
+  specifications set out by this type (optional), see 
+  g_param_value_set_validate().
+@values_cmp: Compares @value1 with @value2 according to this type
+  (recommended, the default is memcmp()), see g_param_values_cmp().
 
 <!-- ##### ENUM GParamFlags ##### -->
 <para>

docs/reference/gobject/tmpl/objects.sgml

@@ -34,17 +34,33 @@ the setter for the property is called to reinstate the previous value.
 
 <!-- ##### STRUCT GObjectClass ##### -->
 <para>
-
+The class structure for the <structname>GObject</structname> type.
 </para>
 
-@g_type_class: 
+@g_type_class: the parent class
-@constructor: 
+@constructor:  the @constructor function is called by g_object_new () to 
-@set_property: 
+  complete the object initialization after all the construction properties are
-@get_property: 
+  set. The first thing a @constructor implementation must do is chain up to the
-@dispose: 
+  @constructor of the parent class. Overriding @constructor should be rarely 
-@finalize: 
+  needed.
-@dispatch_properties_changed: 
+@set_property: the generic setter for all properties of this type. Should be
-@notify: 
+  overridden for every type with properties. Implementations of @set_property
+  don't need to emit property change notification explicitly, this is handled
+  by the type system.
+@get_property: the generic getter for all properties of this type. Should be
+  overridden for every type with properties.
+@dispose: the @dispose function is supposed to drop all references to other 
+  objects, but keep the instance otherwise intact, so that client method 
+  invocations still work. It may be run multiple times (due to reference 
+  loops). Before returning, @dispose should chain up to the @dispose method 
+  of the parent class.
+@finalize: instance finalization function, should finish the finalization of 
+  the instance begun in @dispose and chain up to the @finalize method of the 
+  parent class.
+@dispatch_properties_changed: emits property change notification for a bunch
+  of properties. Overriding @dispatch_properties_changed should be rarely 
+  needed.
+@notify: the class closure for the notify signal
 
 <!-- ##### STRUCT GObjectConstructParam ##### -->
 <para>

gobject/gparam.h

@@ -98,6 +98,7 @@ struct _GParamSpecClass
   gint          (*values_cmp)           (GParamSpec   *pspec,
 					 const GValue *value1,
 					 const GValue *value2);
+  /*< private >*/
   gpointer	  dummy[4];
 };
 struct _GParameter /* auxillary structure for _setv() variants */