From e80c828a42c61daee8a986d6b89a8fdf94e336e3 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 23 Nov 2002 22:57:35 +0000 Subject: [PATCH] Add missing short descriptions, standardize them to start with a capital * 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. --- docs/reference/ChangeLog | 17 +++++++++++++++++ docs/reference/glib/tmpl/arrays.sgml | 4 ++-- docs/reference/glib/tmpl/macros.sgml | 2 +- docs/reference/glib/tmpl/memory_chunks.sgml | 4 ++-- .../gobject/tmpl/enumerations_flags.sgml | 2 +- docs/reference/gobject/tmpl/gboxed.sgml | 2 +- docs/reference/gobject/tmpl/gclosure.sgml | 2 +- docs/reference/gobject/tmpl/generic_values.sgml | 2 +- docs/reference/gobject/tmpl/gparamspec.sgml | 10 +++++----- docs/reference/gobject/tmpl/gtypemodule.sgml | 2 +- docs/reference/gobject/tmpl/gtypeplugin.sgml | 2 +- docs/reference/gobject/tmpl/objects.sgml | 2 +- .../gobject/tmpl/param_value_types.sgml | 2 +- docs/reference/gobject/tmpl/signals.sgml | 3 +-- .../gobject/tmpl/value_collection.sgml | 2 +- 15 files changed, 37 insertions(+), 21 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index f8cbc25c0..1c71aea8f 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,22 @@ 2002-11-23 Matthias Clasen + * 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): diff --git a/docs/reference/glib/tmpl/arrays.sgml b/docs/reference/glib/tmpl/arrays.sgml index 6602e13b1..61babb305 100644 --- a/docs/reference/glib/tmpl/arrays.sgml +++ b/docs/reference/glib/tmpl/arrays.sgml @@ -31,7 +31,7 @@ To set the size of an array, use g_array_set_size(). To free an array, use g_array_free(). -Using a <structname>GArray</structname> to store gint values. +Using a <structname>GArray</structname> to store <type>gint</type> values 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. -Getting a pointer to an element in a <structname>GArray</structname>. +Getting a pointer to an element in a <structname>GArray</structname> EDayViewEvent *event; diff --git a/docs/reference/glib/tmpl/macros.sgml b/docs/reference/glib/tmpl/macros.sgml index 6ccb903c7..3749d28d1 100644 --- a/docs/reference/glib/tmpl/macros.sgml +++ b/docs/reference/glib/tmpl/macros.sgml @@ -66,7 +66,7 @@ It returns %TRUE if the GLib library is the same or newer than the given version. -Checking the version of the GLib library. +Checking the version of the GLib library if (!GLIB_CHECK_VERSION (1, 2, 0)) g_error ("GLib version 1.2.0 or above is needed"); diff --git a/docs/reference/glib/tmpl/memory_chunks.sgml b/docs/reference/glib/tmpl/memory_chunks.sgml index 8336f86a5..2fbe0c0ac 100644 --- a/docs/reference/glib/tmpl/memory_chunks.sgml +++ b/docs/reference/glib/tmpl/memory_chunks.sgml @@ -56,7 +56,7 @@ To help debug memory chunks, use g_mem_chunk_info() and g_mem_chunk_print(). -Using a GMemChunk. +Using a <structname>GMemChunk</structname> 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(). -Using a GMemChunk with data structures. +Using a <structname>GMemChunk</structname> with data structures GMemChunk *array_mem_chunk; GRealArray *array; diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index 44cbe2cda..3a170eecb 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -2,7 +2,7 @@ Enums and Flags -Enumeration and flags types. +Enumeration and flags types diff --git a/docs/reference/gobject/tmpl/gboxed.sgml b/docs/reference/gobject/tmpl/gboxed.sgml index 44ada5808..fbe602b6d 100644 --- a/docs/reference/gobject/tmpl/gboxed.sgml +++ b/docs/reference/gobject/tmpl/gboxed.sgml @@ -2,7 +2,7 @@ GBoxed -Mechanism to wrap opaque C structures registered by the type system. +A mechanism to wrap opaque C structures registered by the type system diff --git a/docs/reference/gobject/tmpl/gclosure.sgml b/docs/reference/gobject/tmpl/gclosure.sgml index 42774bec1..062681649 100644 --- a/docs/reference/gobject/tmpl/gclosure.sgml +++ b/docs/reference/gobject/tmpl/gclosure.sgml @@ -2,7 +2,7 @@ Closures - +Functions as first-class objects diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml index 3c34e8c5f..7d37766f6 100644 --- a/docs/reference/gobject/tmpl/generic_values.sgml +++ b/docs/reference/gobject/tmpl/generic_values.sgml @@ -2,7 +2,7 @@ Generic Values -A polymorphic type that can hold values of any other type. +A polymorphic type that can hold values of any other type diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml index 45a79dddf..d372ab57d 100644 --- a/docs/reference/gobject/tmpl/gparamspec.sgml +++ b/docs/reference/gobject/tmpl/gparamspec.sgml @@ -2,11 +2,11 @@ GParamSpec -Meta data object for parameter specifications. +Metadata for parameter specifications -#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. @@ -69,7 +69,7 @@ Retrieve the #GParamSpecClass of a #GParamSpec. -Retrive the #GType of this @pspec. +Retrieve the #GType of this @pspec. @pspec: a valid #GParamSpec @@ -77,7 +77,7 @@ Retrive the #GType of this @pspec. -Retrive the #GType name of this @pspec. +Retrieve the #GType name of this @pspec. @pspec: a valid #GParamSpec @@ -85,7 +85,7 @@ Retrive the #GType name of this @pspec. -Retrive the #GType to intiialize a #GValue for this parameter. +Retrieve the #GType to intiialize a #GValue for this parameter. @pspec: a valid #GParamSpec diff --git a/docs/reference/gobject/tmpl/gtypemodule.sgml b/docs/reference/gobject/tmpl/gtypemodule.sgml index 095199357..a6e4bf5d0 100644 --- a/docs/reference/gobject/tmpl/gtypemodule.sgml +++ b/docs/reference/gobject/tmpl/gtypemodule.sgml @@ -2,7 +2,7 @@ GTypeModule -Type Loading Modules +Type loading modules diff --git a/docs/reference/gobject/tmpl/gtypeplugin.sgml b/docs/reference/gobject/tmpl/gtypeplugin.sgml index 284c74f44..5091bd0ed 100644 --- a/docs/reference/gobject/tmpl/gtypeplugin.sgml +++ b/docs/reference/gobject/tmpl/gtypeplugin.sgml @@ -2,7 +2,7 @@ GTypePlugin - +An interface for dynamically loadable types diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index 29ec9ad6f..246d2ab50 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -2,7 +2,7 @@ GObject -The base object type. +The base object type diff --git a/docs/reference/gobject/tmpl/param_value_types.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml index 04210f7a9..8db4da530 100644 --- a/docs/reference/gobject/tmpl/param_value_types.sgml +++ b/docs/reference/gobject/tmpl/param_value_types.sgml @@ -2,7 +2,7 @@ Parameters and Values -Standard Parameter and Value Types. +Standard Parameter and Value Types diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml index 408a8c28d..06d91a774 100644 --- a/docs/reference/gobject/tmpl/signals.sgml +++ b/docs/reference/gobject/tmpl/signals.sgml @@ -2,8 +2,7 @@ Signals -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 diff --git a/docs/reference/gobject/tmpl/value_collection.sgml b/docs/reference/gobject/tmpl/value_collection.sgml index 1ee2e9b28..0694b2aca 100644 --- a/docs/reference/gobject/tmpl/value_collection.sgml +++ b/docs/reference/gobject/tmpl/value_collection.sgml @@ -2,7 +2,7 @@ Varargs Value Collection - +Converting varargs to generic values -- 2.34.1