diff options
| author | Matthias Clasen <matthiasc@src.gnome.org> | 2002-12-09 19:47:10 +0000 |
|---|---|---|
| committer | Matthias Clasen <matthiasc@src.gnome.org> | 2002-12-09 19:47:10 +0000 |
| commit | 20f6d1b814fa3918c23c97a1c712b34f77fa332a (patch) | |
| tree | 5bd1b07cbcd592733d9db6947223859389f71ce4 /docs/reference | |
| parent | bec003491839c9e7e7e26175e8a04a0f2b552d54 (diff) | |
Add docs.
* gobject/tmpl/gtype.sgml:
* gobject/tmpl/enumerations_flags.sgml: Add docs.
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/ChangeLog | 2 | ||||
| -rw-r--r-- | docs/reference/gobject/tmpl/enumerations_flags.sgml | 27 | ||||
| -rw-r--r-- | docs/reference/gobject/tmpl/gtype.sgml | 10 |
3 files changed, 20 insertions, 19 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 9eee46b18..f324c046c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,7 @@ 2002-12-09 Matthias Clasen <maclas@gmx.de> + * gobject/tmpl/gtype.sgml: + * gobject/tmpl/enumerations_flags.sgml: Add docs. * gobject/tmpl/gtype.sgml: * gobject/tmpl/gtypeplugin.sgml: diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index cfc19dd72..df93c1203 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -18,21 +18,12 @@ Enumeration and flags types </para> -@g_type_class: -@minimum: -@maximum: -@n_values: -@values: <!-- ##### STRUCT GFlagsClass ##### --> <para> </para> -@g_type_class: -@mask: -@n_values: -@values: <!-- ##### MACRO G_ENUM_CLASS_TYPE ##### --> <para> @@ -60,18 +51,19 @@ Returns whether @type "is a" %G_TYPE_ENUM. <!-- ##### MACRO G_ENUM_CLASS ##### --> <para> - +Casts a derived #GEnumClass structure into a #GEnumClass structure. </para> -@class: +@class: a valid #GEnumClass <!-- ##### MACRO G_IS_ENUM_CLASS ##### --> <para> - +Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM +or derived. </para> -@class: +@class: a #GEnumClass <!-- ##### MACRO G_TYPE_IS_FLAGS ##### --> @@ -84,18 +76,19 @@ Returns whether @type "is a" %G_TYPE_FLAGS. <!-- ##### MACRO G_FLAGS_CLASS ##### --> <para> - +Casts a derived #GFlagsClass structure into a #GFlagsClass structure. </para> -@class: +@class: a valid #GFlagsClass <!-- ##### MACRO G_IS_FLAGS_CLASS ##### --> <para> - +Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS +or derived. </para> -@class: +@class: a #GFlagsClass <!-- ##### MACRO G_FLAGS_CLASS_TYPE ##### --> diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml index f54f3df06..42303a63f 100644 --- a/docs/reference/gobject/tmpl/gtype.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -1140,16 +1140,22 @@ implementing a fundamental type. Also language bindings should <emphasis>not</em use this function but g_object_new() instead. </para> -@type: An instantiabtable type to create an instance for. +@type: An instantiatable type to create an instance for. @Returns: An allocated and initialized instance, subject to further treatment by the fundamental type implementation. <!-- ##### FUNCTION g_type_free_instance ##### --> <para> +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 +fundamental types. </para> -@instance: +@instance: an instance of a type. <!-- ##### FUNCTION g_type_add_class_cache_func ##### --> |