From 728ab5ff7e77d186a8cae2bb6e47f007a02ab303 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 2 May 2005 15:29:43 +0000 Subject: [PATCH] Small additions. 2005-05-02 Matthias Clasen * gobject/tmpl/signals.sgml: * gobject/tmpl/generic_values.sgml: * gobject/tmpl/gtype.sgml: * gobject/tmpl/value_arrays.sgml: * gobject/tmpl/param_value_types.sgml: * gobject/tmpl/gtypemodule.sgml: * gobject/tmpl/enumerations_flags.sgml: Small additions. --- docs/reference/ChangeLog | 10 ++++++++++ docs/reference/gobject/tmpl/enumerations_flags.sgml | 7 +++++-- docs/reference/gobject/tmpl/generic_values.sgml | 7 +++++-- docs/reference/gobject/tmpl/gtype.sgml | 9 ++++++--- docs/reference/gobject/tmpl/gtypemodule.sgml | 7 +++++-- docs/reference/gobject/tmpl/param_value_types.sgml | 10 ++++++++-- docs/reference/gobject/tmpl/signals.sgml | 7 +++++-- docs/reference/gobject/tmpl/value_arrays.sgml | 5 ++++- 8 files changed, 48 insertions(+), 14 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 6028819..c99575b 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,13 @@ +2005-05-02 Matthias Clasen + + * gobject/tmpl/signals.sgml: + * gobject/tmpl/generic_values.sgml: + * gobject/tmpl/gtype.sgml: + * gobject/tmpl/value_arrays.sgml: + * gobject/tmpl/param_value_types.sgml: + * gobject/tmpl/gtypemodule.sgml: + * gobject/tmpl/enumerations_flags.sgml: Small additions. + 2005-05-01 Matthias Clasen * glib/tmpl/completions.sgml: Document diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index d65dfa5..384fbf2 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -13,13 +13,16 @@ Enumeration and flags types + + + The class of an enumeration type holds information about its possible values. -@g_type_class: +@g_type_class: the parent class @minimum: the smallest possible value. @maximum: the largest possible value. @n_values: the number of possible values. @@ -32,7 +35,7 @@ The class of a flags type holds information about its possible values. -@g_type_class: +@g_type_class: the parent class @mask: a mask covering all possible values. @n_values: the number of possible values. @values: an array of #GFlagsValue structs describing the diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml index 6b237bc..2839e3a 100644 --- a/docs/reference/gobject/tmpl/generic_values.sgml +++ b/docs/reference/gobject/tmpl/generic_values.sgml @@ -26,6 +26,9 @@ can be used as a type initializer for g_value_init() are defined by a separate interface. See the Standard Values API for details. + + + Returns #TRUE if @value holds (or contains) a value of @type. @@ -33,8 +36,8 @@ This macro will also check for @value != #NULL and issue a warning if the check fails. -@value: -@type: +@value: A #GValue structure. +@type: A #GType value. diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml index 096dab3..1688e62 100644 --- a/docs/reference/gobject/tmpl/gtype.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -45,6 +45,9 @@ any of '-_+'. + + + A numerical value which represents the unique identifier of a registered @@ -229,7 +232,7 @@ A structure that provides information to the type system which is used specifically for managing fundamental types. -@type_flags: +@type_flags: #GTypeFundamentalFlags describing the characteristics of the fundamental type @@ -628,7 +631,7 @@ Note that the messages can also be triggered by setting the @G_TYPE_DEBUG_NONE: Print no messages. @G_TYPE_DEBUG_OBJECTS: Print messages about object bookkeeping. @G_TYPE_DEBUG_SIGNALS: Print messages about signal emissions. -@G_TYPE_DEBUG_MASK: +@G_TYPE_DEBUG_MASK: Mask covering all debug flags. @@ -1203,7 +1206,7 @@ fundamental type. @G_TYPE_FLAG_CLASSED: Indicates a classed type. @G_TYPE_FLAG_INSTANTIATABLE: Indicates an instantiable type (implies classed). -@G_TYPE_FLAG_DERIVABLE: Indicates a flat derivable type. +@G_TYPE_FLAG_DERIVABLE: Indicates a flat derivable type. @G_TYPE_FLAG_DEEP_DERIVABLE: Indicates a deep derivable type (implies derivable). diff --git a/docs/reference/gobject/tmpl/gtypemodule.sgml b/docs/reference/gobject/tmpl/gtypemodule.sgml index 625f7bc..a240de1 100644 --- a/docs/reference/gobject/tmpl/gtypemodule.sgml +++ b/docs/reference/gobject/tmpl/gtypemodule.sgml @@ -52,13 +52,16 @@ in #GTypeModuleClass. + + + The members of the GTypeModule structure should not be accessed directly, except for the @name field. -@name: +@name: the name of the module @@ -66,7 +69,7 @@ In order to implement dynamic loading of types based on #GTypeModule, the @load and @unload functions in #GTypeModuleClass must be implemented. -@parent_class: +@parent_class: the parent class @load: loads the module and registers one or more types using g_type_module_register_type(). @unload: unloads the module diff --git a/docs/reference/gobject/tmpl/param_value_types.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml index 72e6a2b..1fb32ec 100644 --- a/docs/reference/gobject/tmpl/param_value_types.sgml +++ b/docs/reference/gobject/tmpl/param_value_types.sgml @@ -24,6 +24,9 @@ All other characters are replaced by a '-' during construction. #GParamSpec, #GValue, g_object_class_install_property(). + + + Return whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN. @@ -749,7 +752,8 @@ A #GParamSpec derived structure that contains the meta data for float properties @minimum: minimum value for the property specified @maximum: maximum value for the property specified @default_value: default value for the property specified -@epsilon: +@epsilon: values closer than @epsilon will be considered identical + by g_param_values_cmp(); the default value is 1e-30. @@ -827,7 +831,9 @@ A #GParamSpec derived structure that contains the meta data for double propertie @minimum: minimum value for the property specified @maximum: maximum value for the property specified @default_value: default value for the property specified -@epsilon: +@epsilon: values closer than @epsilon will be considered identical + by g_param_values_cmp(); the default value is 1e-90. + diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml index 8b69ec3..a99603e 100644 --- a/docs/reference/gobject/tmpl/signals.sgml +++ b/docs/reference/gobject/tmpl/signals.sgml @@ -70,6 +70,9 @@ wildcard and matches any detail argument passed in to emission. + + + The #GSignalInvocationHint structure is used to pass on additional information @@ -95,8 +98,8 @@ value returned by the last callback. @ihint: Signal invocation hint, see #GSignalInvocationHint. @return_accu: Accumulator to collect callback return values in, this is the return value of the current signal emission. -@handler_return: -@data: +@handler_return: A #GValue holding the return value of the signal handler. +@data: Callback data that was specified when creating the signal. @Returns: The accumulator function returns whether the signal emission should be aborted. Returning %FALSE means to abort the current emission and %TRUE is returned for continuation. diff --git a/docs/reference/gobject/tmpl/value_arrays.sgml b/docs/reference/gobject/tmpl/value_arrays.sgml index 8b3e08c..36a560c 100644 --- a/docs/reference/gobject/tmpl/value_arrays.sgml +++ b/docs/reference/gobject/tmpl/value_arrays.sgml @@ -16,6 +16,9 @@ in order for it to be used as a boxed type through %G_TYPE_VALUE_ARRAY. #GValue, #GParamSpecValueArray, g_param_spec_value_array() + + + A #GValueArray contains an array of #GValue elements. @@ -60,7 +63,7 @@ contents. Free a #GValueArray including its contents. -@value_array: +@value_array: #GValueArray to free -- 2.7.4