aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJulian Orth <ju.orth@gmail.com>2025-03-12 21:13:40 +0100
committerSimon Ser <contact@emersion.fr>2025-03-15 23:07:39 +0000
commit7033e74857a01cd8fc07cd2e6336d8bfe43cbed5 (patch)
tree1ae75f71efa78541d207beeca3c72fc526e9431c
parentscanner: use separate guards for validator functions (diff)
downloadwayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.tar
wayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.tar.gz
wayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.tar.bz2
wayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.tar.lz
wayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.tar.xz
wayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.tar.zst
wayland-7033e74857a01cd8fc07cd2e6336d8bfe43cbed5.zip
client: document get_listener behavior for dispatchers
This seems to have been the case since 2013. This is useful for wrappers that need two pointers to identify proxies. One pointer (stored in the user data) pointing to a singleton object to identify that the proxy has a known structure. And one pointer (stored in the dispatcher data) pointing to per-proxy data. Signed-off-by: Julian Orth <ju.orth@gmail.com>
-rw-r--r--src/wayland-client.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/wayland-client.c b/src/wayland-client.c
index 8df160b..3d0ef7b 100644
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -674,6 +674,9 @@ wl_proxy_add_listener(struct wl_proxy *proxy,
* This function is useful in clients with multiple listeners on the same
* interface to allow the identification of which code to execute.
*
+ * If \ref wl_proxy_add_dispatcher was used, this function returns the
+ * dispatcher_data pointer instead.
+ *
* \memberof wl_proxy
*/
WL_EXPORT const void *