This commit adds a bit more detail on the lifecycle of a signal.
---
src/wayland-server.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/src/wayland-server.h b/src/wayland-server.h
index f345d2a..2e616c1 100644
--- a/src/wayland-server.h
+++ b/src/wayland-server.h
@@ -185,7 +185,12 @@ struct wl_listener {
*
* Signals are recognized points where significant events can be observed.
* Compositors as well as the server can provide signals. Observers are
- * added through \ref wl_signal_add.
+ * wl_listener's that are added through #wl_signal_add. Signals are emitted
+ * using #wl_signal_emit, which will invoke all listeners until that
+ * listener is removed by #wl_list_remove (or whenever the signal is
+ * destroyed).
+ *
+ * \sa wl_listener for more information on using wl_signal
*/
struct wl_signal {
struct wl_list listener_list;
--
1.8.3.1
_______________________________________________
wayland-devel mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/wayland-devel
