From 4a29291187c5d1b267ab87378a4f89abf4f013e0 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <matthiasc@src.gnome.org>
Date: Mon, 20 Oct 2003 20:07:45 +0000
Subject: [PATCH] Documentation additions.

---
 docs/reference/ChangeLog                        | 10 ++++++++++
 docs/reference/gobject/gobject-sections.txt     |  2 +-
 .../gobject/tmpl/enumerations_flags.sgml        | 17 +++++++++--------
 docs/reference/gobject/tmpl/gtypeplugin.sgml    |  4 +++-
 docs/reference/gobject/tmpl/objects.sgml        | 17 +++++++++++++++++
 gobject/ChangeLog                               |  5 +++++
 gobject/gobject.h                               |  4 +++-
 7 files changed, 48 insertions(+), 11 deletions(-)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 83299fb0..63549751 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -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...
diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt
index be397945..c85c8db4 100644
--- a/docs/reference/gobject/gobject-sections.txt
+++ b/docs/reference/gobject/gobject-sections.txt
@@ -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>
diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml
index 87f276eb..ed46dfd0 100644
--- a/docs/reference/gobject/tmpl/enumerations_flags.sgml
+++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml
@@ -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>
diff --git a/docs/reference/gobject/tmpl/gtypeplugin.sgml b/docs/reference/gobject/tmpl/gtypeplugin.sgml
index eeaf40ee..d3391483 100644
--- a/docs/reference/gobject/tmpl/gtypeplugin.sgml
+++ b/docs/reference/gobject/tmpl/gtypeplugin.sgml
@@ -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>
 
 
diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml
index 93571663..fccb76ae 100644
--- a/docs/reference/gobject/tmpl/objects.sgml
+++ b/docs/reference/gobject/tmpl/objects.sgml
@@ -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>
diff --git a/gobject/ChangeLog b/gobject/ChangeLog
index c975e80c..1f0ed815 100644
--- a/gobject/ChangeLog
+++ b/gobject/ChangeLog
@@ -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 >*/
diff --git a/gobject/gobject.h b/gobject/gobject.h
index 6690793c..733ce0af 100644
--- a/gobject/gobject.h
+++ b/gobject/gobject.h
@@ -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];
 };
-- 
2.34.1