mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-26 15:36:14 +01:00
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.
This commit is contained in:
parent
940d8a269d
commit
e80c828a42
@ -1,5 +1,22 @@
|
|||||||
2002-11-23 Matthias Clasen <maclas@gmx.de>
|
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/building.sgml: Explain --enable-include-printf.
|
||||||
|
|
||||||
* glib/Makefile.am (extra_files):
|
* glib/Makefile.am (extra_files):
|
||||||
|
@ -31,7 +31,7 @@ To set the size of an array, use g_array_set_size().
|
|||||||
To free an array, use g_array_free().
|
To free an array, use g_array_free().
|
||||||
</para>
|
</para>
|
||||||
<example>
|
<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>
|
<programlisting>
|
||||||
GArray *garray;
|
GArray *garray;
|
||||||
gint i;
|
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.
|
The return value is cast to the given type.
|
||||||
|
|
||||||
<example>
|
<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>
|
<programlisting>
|
||||||
EDayViewEvent *event;
|
EDayViewEvent *event;
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ It returns %TRUE if the GLib library is the same or newer than the given
|
|||||||
version.
|
version.
|
||||||
|
|
||||||
<example>
|
<example>
|
||||||
<title>Checking the version of the GLib library.</title>
|
<title>Checking the version of the GLib library</title>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
if (!GLIB_CHECK_VERSION (1, 2, 0))
|
if (!GLIB_CHECK_VERSION (1, 2, 0))
|
||||||
g_error ("GLib version 1.2.0 or above is needed");
|
g_error ("GLib version 1.2.0 or above is needed");
|
||||||
|
@ -56,7 +56,7 @@ To help debug memory chunks, use g_mem_chunk_info() and g_mem_chunk_print().
|
|||||||
</para>
|
</para>
|
||||||
|
|
||||||
<example>
|
<example>
|
||||||
<title>Using a GMemChunk.</title>
|
<title>Using a <structname>GMemChunk</structname></title>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
GMemChunk *mem_chunk;
|
GMemChunk *mem_chunk;
|
||||||
gchar *mem[10000];
|
gchar *mem[10000];
|
||||||
@ -89,7 +89,7 @@ To help debug memory chunks, use g_mem_chunk_info() and g_mem_chunk_print().
|
|||||||
</programlisting></example>
|
</programlisting></example>
|
||||||
|
|
||||||
<example>
|
<example>
|
||||||
<title>Using a GMemChunk with data structures.</title>
|
<title>Using a <structname>GMemChunk</structname> with data structures</title>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
GMemChunk *array_mem_chunk;
|
GMemChunk *array_mem_chunk;
|
||||||
GRealArray *array;
|
GRealArray *array;
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
Enums and Flags
|
Enums and Flags
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
Enumeration and flags types.
|
Enumeration and flags types
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
GBoxed
|
GBoxed
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### 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 ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
Closures
|
Closures
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
|
Functions as first-class objects
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
Generic Values
|
Generic Values
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### 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 ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,11 +2,11 @@
|
|||||||
GParamSpec
|
GParamSpec
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
Meta data object for parameter specifications.
|
Metadata for parameter specifications
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<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.
|
required to specify parameters, such as e.g. #GObject properties.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@ -69,7 +69,7 @@ Retrieve the #GParamSpecClass of a #GParamSpec.
|
|||||||
|
|
||||||
<!-- ##### MACRO G_PARAM_SPEC_TYPE ##### -->
|
<!-- ##### MACRO G_PARAM_SPEC_TYPE ##### -->
|
||||||
<para>
|
<para>
|
||||||
Retrive the #GType of this @pspec.
|
Retrieve the #GType of this @pspec.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@pspec: a valid #GParamSpec
|
@pspec: a valid #GParamSpec
|
||||||
@ -77,7 +77,7 @@ Retrive the #GType of this @pspec.
|
|||||||
|
|
||||||
<!-- ##### MACRO G_PARAM_SPEC_TYPE_NAME ##### -->
|
<!-- ##### MACRO G_PARAM_SPEC_TYPE_NAME ##### -->
|
||||||
<para>
|
<para>
|
||||||
Retrive the #GType name of this @pspec.
|
Retrieve the #GType name of this @pspec.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@pspec: a valid #GParamSpec
|
@pspec: a valid #GParamSpec
|
||||||
@ -85,7 +85,7 @@ Retrive the #GType name of this @pspec.
|
|||||||
|
|
||||||
<!-- ##### MACRO G_PARAM_SPEC_VALUE_TYPE ##### -->
|
<!-- ##### MACRO G_PARAM_SPEC_VALUE_TYPE ##### -->
|
||||||
<para>
|
<para>
|
||||||
Retrive the #GType to intiialize a #GValue for this parameter.
|
Retrieve the #GType to intiialize a #GValue for this parameter.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@pspec: a valid #GParamSpec
|
@pspec: a valid #GParamSpec
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
GTypeModule
|
GTypeModule
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
Type Loading Modules
|
Type loading modules
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
GTypePlugin
|
GTypePlugin
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
|
An interface for dynamically loadable types
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
GObject
|
GObject
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
The base object type.
|
The base object type
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
Parameters and Values
|
Parameters and Values
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
Standard Parameter and Value Types.
|
Standard Parameter and Value Types
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,8 +2,7 @@
|
|||||||
Signals
|
Signals
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
Signals provide a means for customization of object behaviour and are used
|
A means for customization of object behaviour and a general purpose notification mechanism
|
||||||
as general purpose notification mechanism.
|
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
Varargs Value Collection
|
Varargs Value Collection
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
|
Converting varargs to generic values
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
Loading…
Reference in New Issue
Block a user