Documentation additions.
authorMatthias Clasen <matthiasc@src.gnome.org>
Mon, 20 Oct 2003 20:07:45 +0000 (20:07 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Mon, 20 Oct 2003 20:07:45 +0000 (20:07 +0000)
docs/reference/ChangeLog
docs/reference/gobject/gobject-sections.txt
docs/reference/gobject/tmpl/enumerations_flags.sgml
docs/reference/gobject/tmpl/gtypeplugin.sgml
docs/reference/gobject/tmpl/objects.sgml
gobject/ChangeLog
gobject/gobject.h

index 83299fb..6354975 100644 (file)
@@ -1,3 +1,13 @@
+Mon Oct 20 22:05:37 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gobject/tmpl/objects.sgml: 
+       * gobject/tmpl/enumerations_flags.sgml: 
+       * gobject/tmpl/gtypeplugin.sgml: Additions.
+
+Mon Oct 20 22:04:45 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gobject/gobject-sections.txt: Add GObjectConstructParam.
+
 Mon Oct 20 20:38:06 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gobject/gobject.i: Removed...
index be39794..c85c8db 100644 (file)
@@ -192,6 +192,7 @@ G_TYPE_MODULE_GET_CLASS
 <FILE>objects</FILE>
 GObject
 GObjectClass
+GObjectConstructParam
 GObjectGetPropertyFunc
 GObjectSetPropertyFunc
 GObjectFinalizeFunc
@@ -243,7 +244,6 @@ g_object_run_dispose
 G_OBJECT_WARN_INVALID_PROPERTY_ID
 <SUBSECTION Private>
 G_OBJECT_WARN_INVALID_PSPEC
-GObjectConstructParam
 </SECTION>
 
 <SECTION>
index 87f276e..ed46dfd 100644 (file)
@@ -118,22 +118,23 @@ Returns the static type name from a given #GFlagsClass structure.
 
 <!-- ##### STRUCT GEnumValue ##### -->
 <para>
-A structure which contains a single enum value, its name, and it's
+A structure which contains a single enum value, it's name, and it's
 nickname.
 </para>
 
-@value: 
-@value_name: 
-@value_nick: 
+@value: the enum value
+@value_name: the name of the value
+@value_nick: the nickname of the value
 
 <!-- ##### STRUCT GFlagsValue ##### -->
 <para>
-
+A structure which contains a single flags value, it's name, and it's
+nickname.
 </para>
 
-@value: 
-@value_name: 
-@value_nick: 
+@value: the flags value
+@value_name: the name of the value
+@value_nick: the nickname of the value
 
 <!-- ##### FUNCTION g_enum_get_value ##### -->
 <para>
index eeaf40e..d339148 100644 (file)
@@ -72,7 +72,9 @@ handles multiple registered types per module.
 
 <!-- ##### STRUCT GTypePlugin ##### -->
 <para>
-
+The <structname>GTypePlugin</structname> typedef is used as a placeholder 
+for objects that implement the <structname>GTypePlugin</structname> 
+interface.
 </para>
 
 
index 9357166..fccb76a 100644 (file)
@@ -38,6 +38,23 @@ the setter for the property is called to reinstate the previous value.
 </para>
 
 @g_type_class: 
+@constructor: 
+@set_property: 
+@get_property: 
+@dispose: 
+@finalize: 
+@dispatch_properties_changed: 
+@notify: 
+
+<!-- ##### STRUCT GObjectConstructParam ##### -->
+<para>
+The <structname>GObjectConstructParam</structname> struct is an auxiliary 
+structure used to hand #GParamSpec/#GValue pairs to the @constructor of
+a #GObjectClass.
+</para>
+
+@pspec: the #GParamSpec of the construct parameter 
+@value: the value to set the parameter to
 
 <!-- ##### USER_FUNCTION GObjectGetPropertyFunc ##### -->
 <para>
index c975e80..1f0ed81 100644 (file)
@@ -1,3 +1,8 @@
+Mon Oct 20 22:06:12 2003  Matthias Clasen  <maclas@gmx.de>
+
+       * gobject.h (struct  _GObjectClass): Add /*< public >*/
+       and /*< private >*/ markers for documentation purposes.
+
 Sat Oct 18 01:24:14 2003  Matthias Clasen  <maclas@gmx.de>
 
        * gtypeplugin.h (struct _GTypePluginClass): Add /*< public >*/
index 6690793..733ce0a 100644 (file)
@@ -75,7 +75,8 @@ struct  _GObjectClass
   /*< private >*/
   GSList      *construct_properties;
 
-  /* public overridable methods */
+  /*< public >*/
+  /* overridable methods */
   GObject*   (*constructor)     (GType                  type,
                                  guint                  n_construct_properties,
                                  GObjectConstructParam *construct_properties);
@@ -98,6 +99,7 @@ struct  _GObjectClass
   /* signals */
   void      (*notify)                  (GObject        *object,
                                         GParamSpec     *pspec);
+  /*< private >*/
   /* padding */
   gpointer     pdummy[8];
 };