From 657428da90bec3b77c768d28dd51c2a1103bf88d Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 9 Dec 2002 23:26:17 +0000 Subject: [PATCH] Add docs. * gobject/tmpl/generic_values.sgml: * gobject/tmpl/gtype.sgml: * gobject/tmpl/enumerations_flags.sgml: Add docs. --- docs/reference/ChangeLog | 6 +++++ .../gobject/tmpl/enumerations_flags.sgml | 16 ++++++------- .../gobject/tmpl/generic_values.sgml | 6 +++-- docs/reference/gobject/tmpl/gtype.sgml | 23 +++++++++++-------- 4 files changed, 32 insertions(+), 19 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index f324c046c..f8c02f612 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +2002-12-10 Matthias Clasen + + * gobject/tmpl/generic_values.sgml: + * gobject/tmpl/gtype.sgml: + * gobject/tmpl/enumerations_flags.sgml: Add docs. + 2002-12-09 Matthias Clasen * gobject/tmpl/gtype.sgml: diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index df93c1203..b429f8ead 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -27,18 +27,18 @@ Enumeration and flags types - +Returns the type identifier from a given #GEnumClass structure. -@class: +@class: a #GEnumClass - +Returns the static type name from a given #GEnumClass structure. -@class: +@class: a #GEnumClass @@ -93,18 +93,18 @@ or derived. - +Returns the type identifier from a given #GFlagsClass structure. -@class: +@class: a #GFlagsClass - +Returns the static type name from a given #GFlagsClass structure. -@class: +@class: a #GFlagsClass diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml index 7d37766f6..a27fb58d1 100644 --- a/docs/reference/gobject/tmpl/generic_values.sgml +++ b/docs/reference/gobject/tmpl/generic_values.sgml @@ -66,10 +66,12 @@ of the #GTypeValueTable functions required for a type to create a #GValue of. - +Returns %TRUE if @type is an abstract value type. An abstract value type +introduces a value table, but can't be used for g_value_init() and is normally +used as an abstract base type for derived value types. -@type: +@type: A #GType value. diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml index 42303a63f..84748406f 100644 --- a/docs/reference/gobject/tmpl/gtype.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -103,7 +103,8 @@ Returns %TRUE if @type is a fundamental type. - +Returns %TRUE if @type is a value type which can be used for +g_value_init(). @type: A #GType value. @@ -448,17 +449,17 @@ to a specified anchestor type @g_type of the instance. @instance: Location of the #GTypeInstance structure. @g_type: The anchestor type of the class to be returned. -@c_type: The corresponding C type of @g_Type. +@c_type: The corresponding C type of @g_type. - +Returns the interface structure for interface @g_type of a given @instance. -@instance: -@g_type: -@c_type: +@instance: Location of the #GTypeInstance structure. +@g_type: The interface type to be returned. +@c_type: The corresponding C type of @g_type. @@ -565,7 +566,7 @@ Similar to g_type_init(), but additionally sets debug flags. -Return the unique name that is assigned to a type ID (this is the preferred method +Returns the unique name that is assigned to a type ID (this is the preferred method to find out whether a specific type has been registered for the passed in ID yet). @@ -987,7 +988,9 @@ Bit masks used to check or determine characteristics of a type. @G_TYPE_FLAG_ABSTRACT: Indicates an abstract type. No instances can be created for an abstract type. -@G_TYPE_FLAG_VALUE_ABSTRACT: +@G_TYPE_FLAG_VALUE_ABSTRACT: Indicates an abstract value type, i.e. a type + that introduces a value table, but can't be used for + g_value_init(). @@ -1151,7 +1154,9 @@ Frees an instance of a type, returning it to the instance pool for the type, if there is one. -Like g_type_create_instance(), this function is reserved for implementors of +Like g_type_create_i * gobject/tmpl/gtype.sgml: + * gobject/tmpl/enumerations_flags.sgml: Add docs. +nstance(), this function is reserved for implementors of fundamental types.