From bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1 Mon Sep 17 00:00:00 2001 From: Aaron Faanes Date: Sun, 15 Sep 2013 13:37:06 -0500 Subject: [PATCH] utils: Reference some useful methods in wl_signal's doxygen 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 f345d2a5..2e616c1c 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;