Add long descriptions.

2005-05-09  Matthias Clasen  <mclasen@redhat.com>

	* gobject/tmpl/value_collection.sgml:
	* gobject/tmpl/gboxed.sgml:
	* gobject/tmpl/enumerations_flags.sgml:
	* gobject/tmpl/objects.sgml: Add long descriptions.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6511da76ae5aaff87a73f78a09a788e40bdf260b..68212a882c3c9b9c6d5c98da84c0c9a59f3e266e 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,10 @@
+2005-05-09  Matthias Clasen  <mclasen@redhat.com>
+
+       * gobject/tmpl/value_collection.sgml: 
+       * gobject/tmpl/gboxed.sgml: 
+       * gobject/tmpl/enumerations_flags.sgml: 
+       * gobject/tmpl/objects.sgml: Add long descriptions.
+
 2005-05-05  Owen Taylor  <otaylor@redhat.com>
 
        * glib/Makefile.am glib/glib-sections.txt gobject/gobject-sections.txt:

diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml
index 384fbf2c4055ffe3ce866803db36bbfcb6c8637a..9745882067710e0ce3708f6992d539c4a670b571 100644 (file)
--- a/docs/reference/gobject/tmpl/enumerations_flags.sgml
+++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml
@@ -6,11 +6,24 @@ Enumeration and flags types
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+The GLib type system provides fundamental types for enumeration and flags types. (Flags types
+are like enumerations, but allow their values to be combined by bitwise or). A registered 
+enumeration or flags type associates a name and a nickname with each allowed value, and 
+the methods g_enum_get_value_by_name(), g_enum_get_value_by_nick(), g_flags_get_value_by_name()
+and g_flags_get_value_by_nick() can look up values by their name or nickname.
+When an enumeration or flags type is registered with the GLib type system, it can
+be used as value type for object properties, using g_param_spec_enum() or 
+g_param_spec_flags().
+</para>
+<para>
+GObject ships with a utility called <link linkend="glib-mkenums">glib-mkenums</link> that can 
+construct suitable type registration functions from C enumeration definitions.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(), g_param_spec_flags(), 
+<link linkend="glib-mkenums">glib-mkenums</link>
 </para>
 
 <!-- ##### SECTION Stability_Level ##### -->
@@ -213,9 +226,8 @@ with that nickname
 Registers a new static enumeration type with the name @name. 
 </para>
 <para>
-It is normally more convenient to let 
-<link linkend="glib-mkenums">glib-mkenums</link> generate a 
-my_enum_get_type() function from a usual C enumeration definition
+It is normally more convenient to let <link linkend="glib-mkenums">glib-mkenums</link> 
+generate a my_enum_get_type() function from a usual C enumeration definition
 than to write one yourself using g_enum_register_static().
 </para>
 
@@ -231,9 +243,8 @@ than to write one yourself using g_enum_register_static().
 Registers a new static flags type with the name @name. 
 </para>
 <para>
-It is normally more convenient to let 
-<link linkend="glib-mkenums">glib-mkenums</link> generate a 
-my_flags_get_type() function from a usual C enumeration definition
+It is normally more convenient to let <link linkend="glib-mkenums">glib-mkenums</link> 
+generate a my_flags_get_type() function from a usual C enumeration definition
 than to write one yourself using g_flags_register_static().
 </para>
 

diff --git a/docs/reference/gobject/tmpl/gboxed.sgml b/docs/reference/gobject/tmpl/gboxed.sgml
index fd178e2538eaf9c60bc0a09babf6619cb19cde7e..db434ad01a15bb5ab098e1d6d994dbfdeef138f0 100644 (file)
--- a/docs/reference/gobject/tmpl/gboxed.sgml
+++ b/docs/reference/gobject/tmpl/gboxed.sgml
@@ -6,7 +6,14 @@ A mechanism to wrap opaque C structures registered by the type system
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+GBoxed is a generic wrapper mechanism for arbitrary C structures. The only
+thing the type system needs to know about the structures is how to copy and
+free them, beyond that they are treated as opaque chunks of memory.
+</para>
+<para>
+Boxed types are useful for simple value-holder structures like rectangles or
+points. They can also be used for wrapping structures defined in non-GObject
+based libraries.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->

diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml
index 3ac2f9dd2eeb13f2d583886a3c6a215ca574eaf4..1546e07fd0f27cf264070172e1446e564a40fb1c 100644 (file)
--- a/docs/reference/gobject/tmpl/objects.sgml
+++ b/docs/reference/gobject/tmpl/objects.sgml
@@ -6,12 +6,15 @@ The base object type
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+GObject is the fundamental type providing the common attributes and methods for all object
+types in GTK+, Pango and other libraries based on GObject. The GObject class provides methods 
+for object construction and destruction, property access methods, and signal support. 
+Signals are described in detail in <xref linkend="gobject-Signals"/>.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GParamSpecObject, g_param_spec_object()
 </para>
 
 <!-- ##### SECTION Stability_Level ##### -->

diff --git a/docs/reference/gobject/tmpl/value_collection.sgml b/docs/reference/gobject/tmpl/value_collection.sgml
index 2f7ec68f6ca2d8be9d303f6da498ea867823200f..18cbf503fd9ca4c3e47825c858c73781b996d29c 100644 (file)
--- a/docs/reference/gobject/tmpl/value_collection.sgml
+++ b/docs/reference/gobject/tmpl/value_collection.sgml
@@ -6,12 +6,15 @@ Converting varargs to generic values
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+The macros in this section provide the varargs parsing support needed
+in variadic GObject functions such as g_object_new() or g_object_set().
+They currently support the collection of integral types, floating point 
+types and pointers.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GValueTable
 </para>
 
 <!-- ##### SECTION Stability_Level ##### -->

diff --git a/docs/reference/gobject/tut_gobject.xml b/docs/reference/gobject/tut_gobject.xml
index acdf8eec2bc6a373f9d19e28c64ffa8607278de5..638f41fd9499940f48f1e5a2d13ade2f9e62a984 100644 (file)
--- a/docs/reference/gobject/tut_gobject.xml
+++ b/docs/reference/gobject/tut_gobject.xml
@@ -17,7 +17,7 @@
        <listitem><para>Generic per-object properties with set/get function pairs</para></listitem>
        <listitem><para>Easy use of signals</para></listitem>
       </itemizedlist>
-      All the GTK+ objects and all of the objects in Gnome libraries which use the glib type
+      All the GTK+ objects and all of the objects in Gnome libraries which use the GLib type
       system inherit from <type><link linkend="GObject">GObject</link></type> which is why it is important to understand
       the details of how it works.
     </para>