aboutsummaryrefslogtreecommitdiffstats
path: root/src/wayland-server.h
diff options
context:
space:
mode:
authorAaron Faanes <dafrito@gmail.com>2013-09-15 13:37:06 -0500
committerKristian Høgsberg <krh@bitplanet.net>2013-09-16 21:59:00 -0700
commitbc30c5eb8a88f4e99555de72d4b098d1cb1efdf1 (patch)
tree716c1c56e4eb58d5f9dc3ce9b18e64ec72ac4e46 /src/wayland-server.h
parentwayland-server: Document wl_listener (diff)
downloadwayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.tar
wayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.tar.gz
wayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.tar.bz2
wayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.tar.lz
wayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.tar.xz
wayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.tar.zst
wayland-bc30c5eb8a88f4e99555de72d4b098d1cb1efdf1.zip
utils: Reference some useful methods in wl_signal's doxygen
This commit adds a bit more detail on the lifecycle of a signal.
Diffstat (limited to 'src/wayland-server.h')
-rw-r--r--src/wayland-server.h7
1 files changed, 6 insertions, 1 deletions
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;