Clarify GInitable docs

Mention explicitly that the object is unrefed on error.
Pointed out by Philip Van Hoof,
https://bugzilla.gnome.org/show_bug.cgi?id=641363
This commit is contained in:
Matthias Clasen 2011-02-07 23:35:21 -05:00
parent 761fc9a8e7
commit 626f197ee3

View File

@ -43,7 +43,8 @@
* in various ways. For C applications you generally just call
* g_initable_new() directly, or indirectly via a foo_thing_new() wrapper.
* This will call g_initable_init() under the cover, returning %NULL and
* setting a %GError on failure.
* setting a #GError on failure (at which point the instance is
* unreferenced).
*
* For bindings in languages where the native constructor supports
* exceptions the binding could check for objects implemention %GInitable