Add docs.
authorMatthias Clasen <matthiasc@src.gnome.org>
Mon, 9 Dec 2002 23:26:17 +0000 (23:26 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Mon, 9 Dec 2002 23:26:17 +0000 (23:26 +0000)
* gobject/tmpl/generic_values.sgml:
* gobject/tmpl/gtype.sgml:
* gobject/tmpl/enumerations_flags.sgml: Add docs.

docs/reference/ChangeLog
docs/reference/gobject/tmpl/enumerations_flags.sgml
docs/reference/gobject/tmpl/generic_values.sgml
docs/reference/gobject/tmpl/gtype.sgml

index f324c04..f8c02f6 100644 (file)
@@ -1,3 +1,9 @@
+2002-12-10  Matthias Clasen  <maclas@gmx.de>
+
+       * gobject/tmpl/generic_values.sgml: 
+       * gobject/tmpl/gtype.sgml: 
+       * gobject/tmpl/enumerations_flags.sgml: Add docs.
+
 2002-12-09  Matthias Clasen  <maclas@gmx.de>
 
        * gobject/tmpl/gtype.sgml: 
index df93c12..b429f8e 100644 (file)
@@ -27,18 +27,18 @@ Enumeration and flags types
 
 <!-- ##### MACRO G_ENUM_CLASS_TYPE ##### -->
 <para>
-
+Returns the type identifier from a given #GEnumClass structure.
 </para>
 
-@class: 
+@class: a #GEnumClass
 
 
 <!-- ##### MACRO G_ENUM_CLASS_TYPE_NAME ##### -->
 <para>
-
+Returns the static type name from a given #GEnumClass structure.
 </para>
 
-@class: 
+@class: a #GEnumClass
 
 
 <!-- ##### MACRO G_TYPE_IS_ENUM ##### -->
@@ -93,18 +93,18 @@ or derived.
 
 <!-- ##### MACRO G_FLAGS_CLASS_TYPE ##### -->
 <para>
-
+Returns the type identifier from a given #GFlagsClass structure.
 </para>
 
-@class: 
+@class: a #GFlagsClass
 
 
 <!-- ##### MACRO G_FLAGS_CLASS_TYPE_NAME ##### -->
 <para>
-
+Returns the static type name from a given #GFlagsClass structure.
 </para>
 
-@class: 
+@class: a #GFlagsClass
 
 
 <!-- ##### STRUCT GEnumValue ##### -->
index 7d37766..a27fb58 100644 (file)
@@ -66,10 +66,12 @@ of the #GTypeValueTable functions required for a type to create a #GValue of.
 
 <!-- ##### MACRO G_TYPE_IS_VALUE_ABSTRACT ##### -->
 <para>
-
+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.
 </para>
 
-@type: 
+@type: A #GType value.
 
 
 <!-- ##### MACRO G_IS_VALUE ##### -->
index 42303a6..8474840 100644 (file)
@@ -103,7 +103,8 @@ Returns %TRUE if @type is a fundamental type.
 
 <!-- ##### MACRO G_TYPE_IS_VALUE_TYPE ##### -->
 <para>
-
+Returns %TRUE if @type is a value type which can be used for
+g_value_init(). 
 </para>
 
 @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.
 
 
 <!-- ##### MACRO G_TYPE_INSTANCE_GET_INTERFACE ##### -->
 <para>
-
+Returns the interface structure for interface @g_type of a given @instance.
 </para>
 
-@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.
 
 
 <!-- ##### MACRO G_TYPE_CHECK_INSTANCE ##### -->
@@ -565,7 +566,7 @@ Similar to g_type_init(), but additionally sets debug flags.
 
 <!-- ##### FUNCTION g_type_name ##### -->
 <para>
-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).
 </para>
 
@@ -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().
 
 <!-- ##### ENUM GTypeFundamentalFlags ##### -->
 <para>
@@ -1151,7 +1154,9 @@ Frees an instance of a type, returning it to the instance pool for the type,
 if there is one.
 </para>
 <para>
-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.
 </para>