mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-05 13:29:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Document change of return value of dispatch functions

Browse source
This commit is contained in:
Ander Conselvan de Oliveira 2012-10-16 17:29:08 +03:00 • committed by Kristian Høgsberg
parent 1c10723dfe
commit 244fe474dd
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/wayland-client.c
View file

@ -616,6 +616,7 @@ static const struct wl_callback_listener sync_listener = {
/** Block until all pending request are processed by the server /** Block until all pending request are processed by the server
* *
* \param display The display context object * \param display The display context object
* \return The number of dispatched events on success or -1 on failure
* *
* Blocks until the server process all currently issued requests and * Blocks until the server process all currently issued requests and
* sends out pending events on all event queues. * sends out pending events on all event queues.
@ -818,7 +819,7 @@ err_unlock:
* *
* \param display The display context object * \param display The display context object
* \param queue The event queue to dispatch * \param queue The event queue to dispatch
* \return 0 on success; -1 on failure * \return The number of dispatched events on success or -1 on failure
* *
* Dispatch all incoming events for objects assigned to the given * Dispatch all incoming events for objects assigned to the given
* event queue. On failure -1 is returned and errno set appropriately. * event queue. On failure -1 is returned and errno set appropriately.
@ -835,7 +836,7 @@ wl_display_dispatch_queue(struct wl_display *display,
/** Dispatch a display's main event queue /** Dispatch a display's main event queue
* *
* \param display The display context object * \param display The display context object
* \return 0 on success or -1 on failure * \return The number of dispatched events on success or -1 on failure
* *
* Dispatch the display's main event queue. * Dispatch the display's main event queue.
* *