mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-03-20 05:34:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

util: Clarify documentation of wl_dispatcher_func_t

Browse source 
Adjust the brief, clarify the behavior and arguments, correct a grammar
error, document the parameters, and document the return type.

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
Reviewed-by: Daniel Stone <daniels@collabora.com>
This commit is contained in:
Yong Bakos 2016-11-21 05:44:44 -08:00 • committed by Daniel Stone
parent a26ed0949e
commit 024200745f
1 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

27
src/wayland-util.h
View file

@ -662,21 +662,28 @@ union wl_argument {
}; };
/** /**
* \brief A function pointer type for a dispatcher. * Dispatcher function type alias
* *
* A dispatcher is a function that handles the emitting of callbacks in client * A dispatcher is a function that handles the emitting of callbacks in client
* code. For programs directly using the C library, this is done by using * code. For programs directly using the C library, this is done by using
* libffi to call function pointers. When binding to languages other than C, * libffi to call function pointers. When binding to languages other than C,
* dispatchers provide a way to abstract the function calling process to be * dispatchers provide a way to abstract the function calling process to be
* friendlier to other function calling systems. * friendlier to other function calling systems.
* *
* A dispatcher takes five arguments: The first is the dispatcher-specific * A dispatcher takes five arguments: The first is the dispatcher-specific
* implementation data associated with the target object. The second is the * implementation associated with the target object. The second is the object
* object on which the callback is being invoked (either wl_proxy or * upon which the callback is being invoked (either wl_proxy or wl_resource).
* wl_resource). The third and fourth arguments are the opcode the wl_message * The third and fourth arguments are the opcode and the wl_message
* structure corresponding to the callback being emitted. The final argument * corresponding to the callback. The final argument is an array of arguments
* is an array of arguments received from the other process via the wire * received from the other process via the wire protocol.
* protocol. *
* \param "const void *" Dispatcher-specific implementation data
* \param "void *" Callback invocation target (wl_proxy or `wl_resource`)
* \param uint32_t Callback opcode
* \param "const struct wl_message *" Callback message signature
* \param "union wl_argument *" Array of received arguments
*
* \return 0 on success, or -1 on failure
*/ */
typedef int (*wl_dispatcher_func_t)(const void *, void *, uint32_t, typedef int (*wl_dispatcher_func_t)(const void *, void *, uint32_t,
const struct wl_message *, const struct wl_message *,