summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <withnall@endlessm.com>2019-09-20 11:23:08 +0200
committerPhilip Withnall <withnall@endlessm.com>2019-09-20 11:23:08 +0200
commit9ca97b8b0b224341385d9feeb84aca72a452910e (patch)
tree1148ad736aa42105351caa3beb34d0261b6dfdb1
parentc4ec302932981502e2bb5d5e0931b89575cb2824 (diff)
downloadglib-9ca97b8b0b224341385d9feeb84aca72a452910e.tar.gz
gsignal: Document class init before signals can be looked up
Fixes: #767 Signed-off-by: Philip Withnall <withnall@endlessm.com>
-rw-r--r--gobject/gsignal.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/gobject/gsignal.c b/gobject/gsignal.c
index 77d8f211e..4982d4a21 100644
--- a/gobject/gsignal.c
+++ b/gobject/gsignal.c
@@ -1224,6 +1224,10 @@ g_signal_stop_emission_by_name (gpointer instance,
*
* Also tries the ancestors of the given type.
*
+ * The type class passed as @itype must already have been instantiated (for
+ * example, using g_type_class_ref()) for this function to work, as signals are
+ * always installed during class initialization.
+ *
* See g_signal_new() for details on allowed signal names.
*
* Returns: the signal's identifying number, or 0 if no signal was found.