Add missing short descriptions, standardize them to start with a capital
authorMatthias Clasen <matthiasc@src.gnome.org>
Sat, 23 Nov 2002 22:57:35 +0000 (22:57 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sat, 23 Nov 2002 22:57:35 +0000 (22:57 +0000)
* gobject/tmpl/gclosure.sgml:
* gobject/tmpl/signals.sgml:
* gobject/tmpl/gparamspec.sgml:
* gobject/tmpl/value_collection.sgml:
* gobject/tmpl/generic_values.sgml:
* gobject/tmpl/param_value_types.sgml:
* gobject/tmpl/gboxed.sgml:
* gobject/tmpl/enumerations_flags.sgml:
* gobject/tmpl/objects.sgml:
* gobject/tmpl/gtypemodule.sgml:
* gobject/tmpl/gtypeplugin.sgml: Add missing short descriptions,
standardize them to start with a capital and end without a period.

* glib/tmpl/arrays.sgml:
* glib/tmpl/memory_chunks.sgml:
* glib/tmpl/macros.sgml: Remove periods from titles in examples.

15 files changed:
docs/reference/ChangeLog
docs/reference/glib/tmpl/arrays.sgml
docs/reference/glib/tmpl/macros.sgml
docs/reference/glib/tmpl/memory_chunks.sgml
docs/reference/gobject/tmpl/enumerations_flags.sgml
docs/reference/gobject/tmpl/gboxed.sgml
docs/reference/gobject/tmpl/gclosure.sgml
docs/reference/gobject/tmpl/generic_values.sgml
docs/reference/gobject/tmpl/gparamspec.sgml
docs/reference/gobject/tmpl/gtypemodule.sgml
docs/reference/gobject/tmpl/gtypeplugin.sgml
docs/reference/gobject/tmpl/objects.sgml
docs/reference/gobject/tmpl/param_value_types.sgml
docs/reference/gobject/tmpl/signals.sgml
docs/reference/gobject/tmpl/value_collection.sgml

index f8cbc25..1c71aea 100644 (file)
@@ -1,5 +1,22 @@
 2002-11-23  Matthias Clasen  <maclas@gmx.de>
 
+       * gobject/tmpl/gclosure.sgml: 
+       * gobject/tmpl/signals.sgml: 
+       * gobject/tmpl/gparamspec.sgml: 
+       * gobject/tmpl/value_collection.sgml: 
+       * gobject/tmpl/generic_values.sgml: 
+       * gobject/tmpl/param_value_types.sgml: 
+       * gobject/tmpl/gboxed.sgml: 
+       * gobject/tmpl/enumerations_flags.sgml: 
+       * gobject/tmpl/objects.sgml: 
+       * gobject/tmpl/gtypemodule.sgml: 
+       * gobject/tmpl/gtypeplugin.sgml: Add missing short descriptions, 
+       standardize them to start with a capital and end without a period. 
+
+       * glib/tmpl/arrays.sgml: 
+       * glib/tmpl/memory_chunks.sgml: 
+       * glib/tmpl/macros.sgml: Remove periods from titles in examples.
+
        * glib/building.sgml: Explain --enable-include-printf.
 
        * glib/Makefile.am (extra_files): 
index 6602e13..61babb3 100644 (file)
@@ -31,7 +31,7 @@ To set the size of an array, use g_array_set_size().
 To free an array, use g_array_free().
 </para>
 <example>
-<title>Using a <structname>GArray</structname> to store gint values.</title>
+<title>Using a <structname>GArray</structname> to store <type>gint</type> values</title>
 <programlisting>
   GArray *garray;
   gint i;
@@ -240,7 +240,7 @@ Returns the element of a #GArray at the given index.
 The return value is cast to the given type.
 
 <example>
-<title>Getting a pointer to an element in a <structname>GArray</structname>.</title>
+<title>Getting a pointer to an element in a <structname>GArray</structname></title>
 <programlisting>
   EDayViewEvent *event;
 
index 6ccb903..3749d28 100644 (file)
@@ -66,7 +66,7 @@ It returns %TRUE if the GLib library is the same or newer than the given
 version.
 
 <example>
-<title>Checking the version of the GLib library.</title>
+<title>Checking the version of the GLib library</title>
 <programlisting>
   if (!GLIB_CHECK_VERSION (1, 2, 0))
     g_error ("GLib version 1.2.0 or above is needed");
index 8336f86..2fbe0c0 100644 (file)
@@ -56,7 +56,7 @@ To help debug memory chunks, use g_mem_chunk_info() and g_mem_chunk_print().
 </para>
 
 <example>
-<title>Using a GMemChunk.</title>
+<title>Using a <structname>GMemChunk</structname></title>
 <programlisting>
   GMemChunk *mem_chunk;
   gchar *mem[10000];
@@ -89,7 +89,7 @@ To help debug memory chunks, use g_mem_chunk_info() and g_mem_chunk_print().
 </programlisting></example>
 
 <example>
-<title>Using a GMemChunk with data structures.</title>
+<title>Using a <structname>GMemChunk</structname> with data structures</title>
 <programlisting>
   GMemChunk *array_mem_chunk;
   GRealArray *array;
index 44cbe2c..3a170ee 100644 (file)
@@ -2,7 +2,7 @@
 Enums and Flags
 
 <!-- ##### SECTION Short_Description ##### -->
-Enumeration and flags types.
+Enumeration and flags types
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 44ada58..fbe602b 100644 (file)
@@ -2,7 +2,7 @@
 GBoxed
 
 <!-- ##### SECTION Short_Description ##### -->
-Mechanism to wrap opaque C structures registered by the type system.
+A mechanism to wrap opaque C structures registered by the type system
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 42774be..0626816 100644 (file)
@@ -2,7 +2,7 @@
 Closures
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Functions as first-class objects
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 3c34e8c..7d37766 100644 (file)
@@ -2,7 +2,7 @@
 Generic Values
 
 <!-- ##### SECTION Short_Description ##### -->
-A polymorphic type that can hold values of any other type.
+A polymorphic type that can hold values of any other type
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 45a79dd..d372ab5 100644 (file)
@@ -2,11 +2,11 @@
 GParamSpec
 
 <!-- ##### SECTION Short_Description ##### -->
-Meta data object for parameter specifications.
+Metadata for parameter specifications
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-#GParamSpec is an object structure that encapsulates the meta data
+#GParamSpec is an object structure that encapsulates the metadata
 required to specify parameters, such as e.g. #GObject properties.
 </para>
 
@@ -69,7 +69,7 @@ Retrieve the #GParamSpecClass of a #GParamSpec.
 
 <!-- ##### MACRO G_PARAM_SPEC_TYPE ##### -->
 <para>
-Retrive the #GType of this @pspec.
+Retrieve the #GType of this @pspec.
 </para>
 
 @pspec: a valid #GParamSpec
@@ -77,7 +77,7 @@ Retrive the #GType of this @pspec.
 
 <!-- ##### MACRO G_PARAM_SPEC_TYPE_NAME ##### -->
 <para>
-Retrive the #GType name of this @pspec.
+Retrieve the #GType name of this @pspec.
 </para>
 
 @pspec: a valid #GParamSpec
@@ -85,7 +85,7 @@ Retrive the #GType name of this @pspec.
 
 <!-- ##### MACRO G_PARAM_SPEC_VALUE_TYPE ##### -->
 <para>
-Retrive the #GType to intiialize a #GValue for this parameter.
+Retrieve the #GType to intiialize a #GValue for this parameter.
 </para>
 
 @pspec: a valid #GParamSpec
index 0951993..a6e4bf5 100644 (file)
@@ -2,7 +2,7 @@
 GTypeModule
 
 <!-- ##### SECTION Short_Description ##### -->
-Type Loading Modules
+Type loading modules
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 284c74f..5091bd0 100644 (file)
@@ -2,7 +2,7 @@
 GTypePlugin
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An interface for dynamically loadable types
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 29ec9ad..246d2ab 100644 (file)
@@ -2,7 +2,7 @@
 GObject
 
 <!-- ##### SECTION Short_Description ##### -->
-The base object type.
+The base object type
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 04210f7..8db4da5 100644 (file)
@@ -2,7 +2,7 @@
 Parameters and Values
 
 <!-- ##### SECTION Short_Description ##### -->
-Standard Parameter and Value Types.
+Standard Parameter and Value Types
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 408a8c2..06d91a7 100644 (file)
@@ -2,8 +2,7 @@
 Signals
 
 <!-- ##### SECTION Short_Description ##### -->
-Signals provide a means for customization of object behaviour and are used
-as general purpose notification mechanism.
+A means for customization of object behaviour and a general purpose notification mechanism
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 1ee2e9b..0694b2a 100644 (file)
@@ -2,7 +2,7 @@
 Varargs Value Collection
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Converting varargs to generic values
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>