From bc9e9efbaf62336ad5e6a251e0bb1eac592a3599 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 9 May 2005 05:25:21 +0000 Subject: [PATCH] Add long descriptions. 2005-05-09 Matthias Clasen * gobject/tmpl/value_collection.sgml: * gobject/tmpl/gboxed.sgml: * gobject/tmpl/enumerations_flags.sgml: * gobject/tmpl/objects.sgml: Add long descriptions. --- docs/reference/ChangeLog | 7 ++++++ .../reference/gobject/tmpl/enumerations_flags.sgml | 25 ++++++++++++++++------ docs/reference/gobject/tmpl/gboxed.sgml | 9 +++++++- docs/reference/gobject/tmpl/objects.sgml | 7 ++++-- docs/reference/gobject/tmpl/value_collection.sgml | 7 ++++-- docs/reference/gobject/tut_gobject.xml | 2 +- 6 files changed, 44 insertions(+), 13 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 6511da7..68212a8 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,10 @@ +2005-05-09 Matthias Clasen + + * 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 * 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 384fbf2..9745882 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -6,11 +6,24 @@ Enumeration and flags types +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(). + + +GObject ships with a utility called glib-mkenums that can +construct suitable type registration functions from C enumeration definitions. - +#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(), g_param_spec_flags(), +glib-mkenums @@ -213,9 +226,8 @@ with that nickname Registers a new static enumeration type with the name @name. -It is normally more convenient to let -glib-mkenums generate a -my_enum_get_type() function from a usual C enumeration definition +It is normally more convenient to let glib-mkenums +generate a my_enum_get_type() function from a usual C enumeration definition than to write one yourself using g_enum_register_static(). @@ -231,9 +243,8 @@ than to write one yourself using g_enum_register_static(). Registers a new static flags type with the name @name. -It is normally more convenient to let -glib-mkenums generate a -my_flags_get_type() function from a usual C enumeration definition +It is normally more convenient to let glib-mkenums +generate a my_flags_get_type() function from a usual C enumeration definition than to write one yourself using g_flags_register_static(). diff --git a/docs/reference/gobject/tmpl/gboxed.sgml b/docs/reference/gobject/tmpl/gboxed.sgml index fd178e2..db434ad 100644 --- 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 - +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. + + +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. diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index 3ac2f9d..1546e07 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -6,12 +6,15 @@ The base object type - +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 . - +#GParamSpecObject, g_param_spec_object() diff --git a/docs/reference/gobject/tmpl/value_collection.sgml b/docs/reference/gobject/tmpl/value_collection.sgml index 2f7ec68..18cbf50 100644 --- 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 - +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. - +#GValueTable diff --git a/docs/reference/gobject/tut_gobject.xml b/docs/reference/gobject/tut_gobject.xml index acdf8ee..638f41f 100644 --- a/docs/reference/gobject/tut_gobject.xml +++ b/docs/reference/gobject/tut_gobject.xml @@ -17,7 +17,7 @@ Generic per-object properties with set/get function pairs Easy use of signals - 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 GObject which is why it is important to understand the details of how it works. -- 2.7.4