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>
This commit is contained in:
Julian Orth 2025-03-12 21:13:40 +01:00 committed by Simon Ser
parent dbfa8d784e
commit 7033e74857

View file

@ -674,6 +674,9 @@ wl_proxy_add_listener(struct wl_proxy *proxy,
* This function is useful in clients with multiple listeners on the same * This function is useful in clients with multiple listeners on the same
* interface to allow the identification of which code to execute. * 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 * \memberof wl_proxy
*/ */
WL_EXPORT const void * WL_EXPORT const void *