fixed g_type_name() docs to forbid passing in invalid type IDs.

Thu Jul 12 18:28:47 2007  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/gtype.sgml: fixed g_type_name() docs to forbid passing in
        invalid type IDs.



svn path=/trunk/; revision=5632
This commit is contained in:
Tim Janik 2007-07-12 16:29:21 +00:00 committed by Tim Janik
parent f2fa3c8593
commit 39248d5123
2 changed files with 10 additions and 2 deletions

View File

@ -1,3 +1,8 @@
Thu Jul 12 18:28:47 2007 Tim Janik <timj@gtk.org>
* gobject/tmpl/gtype.sgml: fixed g_type_name() docs to forbid passing in
invalid type IDs.
Thu Jul 12 15:45:27 2007 Tim Janik <timj@imendio.com>
* glib/tmpl/threads.sgml: document major caveat of g_private_set/g_private_get,

View File

@ -647,8 +647,11 @@ Similar to g_type_init(), but additionally sets debug flags.
<!-- ##### FUNCTION g_type_name ##### -->
<para>
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).
Returns the unique name that is assigned to a type ID.
Note that this function (like all other GType API) cannot cope with invalid
type IDs. %G_TYPE_INVALID may be passed to this function, as may be any other
validly registered type ID, but randomized type IDs should not be passed in and
will most likely lead to a crash.
</para>
@type: Type to return name for.