Small additions.

2005-05-02  Matthias Clasen  <mclasen@redhat.com>

	* 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.
This commit is contained in:
Matthias Clasen 2005-05-02 15:29:43 +00:00 committed by Matthias Clasen
parent 5f8e5f8f6a
commit 728ab5ff7e
8 changed files with 48 additions and 14 deletions

View File

@ -1,3 +1,13 @@
2005-05-02 Matthias Clasen <mclasen@redhat.com>
* 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 <mclasen@redhat.com>
* glib/tmpl/completions.sgml: Document

View File

@ -13,13 +13,16 @@ Enumeration and flags types
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GEnumClass ##### -->
<para>
The class of an enumeration type holds information about its
possible values.
</para>
@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.
</para>
@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

View File

@ -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.
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO G_VALUE_HOLDS ##### -->
<para>
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.
</para>
@value:
@type:
@value: A #GValue structure.
@type: A #GType value.
<!-- ##### MACRO G_VALUE_TYPE ##### -->

View File

@ -45,6 +45,9 @@ any of '-_+'.
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### TYPEDEF GType ##### -->
<para>
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.
</para>
@type_flags:
@type_flags: #GTypeFundamentalFlags describing the characteristics of the fundamental type
<!-- ##### STRUCT GInterfaceInfo ##### -->
<para>
@ -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.
<!-- ##### FUNCTION g_type_init_with_debug_flags ##### -->
<para>
@ -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).
<!-- ##### FUNCTION g_type_register_static ##### -->

View File

@ -52,13 +52,16 @@ in #GTypeModuleClass.
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GTypeModule ##### -->
<para>
The members of the <structname>GTypeModule</structname> structure should not
be accessed directly, except for the @name field.
</para>
@name:
@name: the name of the module
<!-- ##### STRUCT GTypeModuleClass ##### -->
<para>
@ -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.
</para>
@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

View File

@ -24,6 +24,9 @@ All other characters are replaced by a '-' during construction.
#GParamSpec, #GValue, g_object_class_install_property().
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO G_IS_PARAM_SPEC_BOOLEAN ##### -->
<para>
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.
<!-- ##### FUNCTION g_param_spec_float ##### -->
<para>
@ -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.
<!-- ##### FUNCTION g_param_spec_double ##### -->
<para>

View File

@ -70,6 +70,9 @@ wildcard and matches any detail argument passed in to emission.
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GSignalInvocationHint ##### -->
<para>
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.

View File

@ -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()
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GValueArray ##### -->
<para>
A #GValueArray contains an array of #GValue elements.
@ -60,7 +63,7 @@ contents.
Free a #GValueArray including its contents.
</para>
@value_array:
@value_array: #GValueArray to free
<!-- ##### FUNCTION g_value_array_append ##### -->