[glib: 1/2] gsignal: Document class init before signals can be looked up



commit 9ca97b8b0b224341385d9feeb84aca72a452910e
Author: Philip Withnall <withnall endlessm com>
Date:   Fri Sep 20 11:23:08 2019 +0200

    gsignal: Document class init before signals can be looked up
    
    Fixes: #767
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 gobject/gsignal.c | 4 ++++
 1 file changed, 4 insertions(+)
---
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.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]