luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixed documentation regarding type checking macros that do and do not

Browse Source 
2008-06-10 14:06:34  Tim Janik  <timj@imendio.com>

        * gobject/tmpl/gtype.sgml: fixed documentation regarding type checking
        macros that do and do not issue warnings.


svn path=/trunk/; revision=6986
This commit is contained in:
14:06:34 Tim Janik 2008-06-10 12:07:18 +00:00 committed by Tim Janik
parent 0e1960fd6e
commit a52a14e4a9
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
2008-06-10 14:06:34 Tim Janik <timj@imendio.com>
* gobject/tmpl/gtype.sgml: fixed documentation regarding type checking
macros that do and do not issue warnings.
2008-05-28 Matthias Clasen <mclasen@redhat.com> 2008-05-28 Matthias Clasen <mclasen@redhat.com>
* glib/glib-docs.sgml: * glib/glib-docs.sgml:

10
docs/reference/gobject/tmpl/gtype.sgml
View File

@ -516,7 +516,7 @@ This macro should only be used in type implementations.
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE ##### --> <!-- ##### MACRO G_TYPE_CHECK_INSTANCE ##### -->
<para> <para>
Returns %TRUE if @instance is a valid #GTypeInstance structure, Returns %TRUE if @instance is a valid #GTypeInstance structure,
otherwise emits a warning and returns %FALSE. otherwise issues a warning and returns %FALSE.
<para> <para>
</para> </para>
This macro should only be used in type implementations. This macro should only be used in type implementations.
@ -528,7 +528,7 @@ This macro should only be used in type implementations.
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### --> <!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
<para> <para>
Checks that @instance is an instance of the type identified by @g_type Checks that @instance is an instance of the type identified by @g_type
and emits a warning if this is not the case. Returns @instance casted and issues a warning if this is not the case. Returns @instance casted
to a pointer to @c_type. to a pointer to @c_type.
</para> </para>
<para> <para>
@ -543,7 +543,7 @@ This macro should only be used in type implementations.
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### --> <!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
<para> <para>
Returns %TRUE if @instance is an instance of the type identified by @g_type. Returns %TRUE if @instance is an instance of the type identified by @g_type.
Otherwise emits a warning and returns %FALSE. Otherwise returns %FALSE.
</para> </para>
<para> <para>
This macro should only be used in type implementations. This macro should only be used in type implementations.
@ -556,7 +556,7 @@ This macro should only be used in type implementations.
<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### --> <!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
<para> <para>
Checks that @g_class is a class structure of the type identified by @g_type Checks that @g_class is a class structure of the type identified by @g_type
and emits a warning if this is not the case. Returns @g_class casted and issues a warning if this is not the case. Returns @g_class casted
to a pointer to @c_type. to a pointer to @c_type.
</para> </para>
<para> <para>
@ -571,7 +571,7 @@ This macro should only be used in type implementations.
<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### --> <!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
<para> <para>
Returns %TRUE if @g_class is a class structure of the type identified by Returns %TRUE if @g_class is a class structure of the type identified by
@g_type. Otherwise emits a warning and returns %FALSE. @g_type. Otherwise returns %FALSE.
</para> </para>
<para> <para>
This macro should only be used in type implementations. This macro should only be used in type implementations.