diff options
| author | Jonas Ådahl <jadahl@gmail.com> | 2015-10-02 17:32:56 +0800 |
|---|---|---|
| committer | Bryce Harrington <bryce@osg.samsung.com> | 2015-10-05 17:28:53 -0700 |
| commit | 99c34e58dbc9357527d374abf3bb5ca952d91942 (patch) | |
| tree | 13ee998db01264e5bc9057ce1306730eb82c09b0 /src | |
| parent | client: Be more clear about when one must call wl_display_flush (diff) | |
| download | wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.tar wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.tar.gz wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.tar.bz2 wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.tar.lz wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.tar.xz wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.tar.zst wayland-99c34e58dbc9357527d374abf3bb5ca952d91942.zip | |
client: Improve wl_display_roundtrip(_queue)() documentation
Change the wording a bit to describe how it is done (which explains to
the name of the function) as well as a note about that we actually will
dispatch events that are received.
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/wayland-client.c | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/src/wayland-client.c b/src/wayland-client.c index 007de0f..97966b8 100644 --- a/src/wayland-client.c +++ b/src/wayland-client.c @@ -962,8 +962,12 @@ static const struct wl_callback_listener sync_listener = { * \param queue The queue on which to run the roundtrip * \return The number of dispatched events on success or -1 on failure * - * Blocks until the server processes all currently issued requests and - * sends out pending events on the event queue. + * This function blocks until the server has processed all currently issued + * requests by sending a request to the display server and waiting for a + * reply before returning. + * + * \note This function may dispatch other events being received on the given + * queue. * * \note This function uses wl_display_dispatch_queue() internally. If you * are using wl_display_read_events() from more threads, don't use this function @@ -999,8 +1003,12 @@ wl_display_roundtrip_queue(struct wl_display *display, struct wl_event_queue *qu * \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 the default event queue. + * This function blocks until the server has processed all currently issued + * requests by sending a request to the display server and waiting for a reply + * before returning. + * + * \note This function may dispatch other events being received on the default + * queue. * * \note This function uses wl_display_dispatch_queue() internally. If you * are using wl_display_read_events() from more threads, don't use this function |