From 39248d5123ada660e48267db6b2dfb48f02f67ff Mon Sep 17 00:00:00 2001 From: Tim Janik Date: Thu, 12 Jul 2007 16:29:21 +0000 Subject: [PATCH] fixed g_type_name() docs to forbid passing in invalid type IDs. Thu Jul 12 18:28:47 2007 Tim Janik * gobject/tmpl/gtype.sgml: fixed g_type_name() docs to forbid passing in invalid type IDs. svn path=/trunk/; revision=5632 --- docs/reference/ChangeLog | 5 +++++ docs/reference/gobject/tmpl/gtype.sgml | 7 +++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index de811a19f..22dac54d4 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Thu Jul 12 18:28:47 2007 Tim Janik + + * 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 * glib/tmpl/threads.sgml: document major caveat of g_private_set/g_private_get, diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml index 75bc872cf..ace29c32b 100644 --- a/docs/reference/gobject/tmpl/gtype.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -647,8 +647,11 @@ Similar to g_type_init(), but additionally sets debug flags. -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. @type: Type to return name for.