dbus-protocol: Add a note for _send_signal that by default the signal isn't

actually sent.

diff --git a/src/pulsecore/protocol-dbus.h b/src/pulsecore/protocol-dbus.h
index c6b630a..38ba8a1 100644 (file)
--- a/src/pulsecore/protocol-dbus.h
+++ b/src/pulsecore/protocol-dbus.h
@@ -149,6 +149,10 @@ void pa_dbus_protocol_add_signal_listener(pa_dbus_protocol *p, DBusConnection *c
  * do anything in that case either. */
 void pa_dbus_protocol_remove_signal_listener(pa_dbus_protocol *p, DBusConnection *conn, const char *signal);
 
+/* Sends the given signal to all interested clients. By default no signals are
+ * sent - clients have to explicitly to request signals by calling
+ * .Core1.ListenForSignal. That method's handler then calls
+ * pa_dbus_protocol_add_signal_listener(). */
 void pa_dbus_protocol_send_signal(pa_dbus_protocol *p, DBusMessage *signal);
 
 /* Returns an array of extension identifier strings. The strings pointers point