diff options
| author | Ander Conselvan de Oliveira <ander.conselvan.de.oliveira@intel.com> | 2012-10-16 17:29:08 +0300 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2012-10-16 10:50:28 -0400 |
| commit | 244fe474dd6243e2d54229287a7f4e5aefcba47e (patch) | |
| tree | 0158c63e37e48026429afb8c7dee42d37e582dc8 /src/wayland-client.c | |
| parent | 1c10723dfe953fd893b095d62acab0dca954b923 (diff) | |
doc: Document change of return value of dispatch functions
Diffstat (limited to 'src/wayland-client.c')
| -rw-r--r-- | src/wayland-client.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/wayland-client.c b/src/wayland-client.c index 1c660ef..2eaecc9 100644 --- a/src/wayland-client.c +++ b/src/wayland-client.c @@ -616,6 +616,7 @@ static const struct wl_callback_listener sync_listener = { /** Block until all pending request are processed by the server * * \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 * sends out pending events on all event queues. @@ -818,7 +819,7 @@ err_unlock: * * \param display The display context object * \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 * 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 * * \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. * |