gsignal: add a clarification to the docs
authorRyan Lortie <desrt@desrt.ca>
Fri, 28 Nov 2014 21:20:40 +0000 (16:20 -0500)
committerMaciej Wereski <m.wereski@partner.samsung.com>
Fri, 10 Jul 2015 09:47:42 +0000 (11:47 +0200)
As evidenced by a mistake that I made recently, this documentation could
use a little bit of clarification.

gobject/gsignal.c

index be613b6..257fc8d 100644 (file)
@@ -2867,6 +2867,12 @@ g_signal_handlers_disconnect_matched (gpointer         instance,
  * Returns whether there are any handlers connected to @instance for the
  * given signal id and detail.
  *
+ * If @detail is 0 then it will only match handlers that were connected
+ * without detail.  If @detail is non-zero then it will match handlers
+ * connected both without detail and with the given detail.  This is
+ * consistent with how a signal emitted with @detail would be delivered
+ * to those handlers.
+ *
  * One example of when you might use this is when the arguments to the
  * signal are difficult to compute. A class implementor may opt to not
  * emit the signal if no one is attached anyway, thus saving the cost