[PATCH 2/4] wayland-server: Document wl_listener

Aaron Faanes dafrito at gmail.com
Wed Aug 28 16:02:00 PDT 2013


---
 src/wayland-server.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/wayland-server.h b/src/wayland-server.h
index d77050d..59fa43a 100644
--- a/src/wayland-server.h
+++ b/src/wayland-server.h
@@ -129,6 +129,15 @@ wl_client_get_object(struct wl_client *client, uint32_t id);
 void
 wl_client_post_no_memory(struct wl_client *client);
 
+/** \class wl_listener
+ *
+ * \brief A single listener for Wayland events and signals
+ *
+ * Many Wayland events use wl_listener for notification of significant
+ * events, like destruction. Clients should create these objects manually
+ * and register them as listeners using the registration methods (usually
+ * suffixed with "_add" and "_notify") provided by other objects.
+ */
 struct wl_listener {
 	struct wl_list link;
 	wl_notify_func_t notify;
-- 
1.8.3.1



More information about the wayland-devel mailing list