From 99c34e58dbc9357527d374abf3bb5ca952d91942 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jonas=20=C3=85dahl?= Date: Fri, 2 Oct 2015 17:32:56 +0800 Subject: [PATCH] client: Improve wl_display_roundtrip(_queue)() documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Bryce Harrington --- src/wayland-client.c | 16 ++++++++++++---- 1 file 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 -- 2.7.4