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

client: Improve wl_display_roundtrip(_queue)() documentation

Browse source 
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>
This commit is contained in:
Jonas Ådahl 2015-10-02 17:32:56 +08:00 • committed by Bryce Harrington
parent 5e0ed91774
commit 99c34e58db
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/wayland-client.c
View file

@ -962,8 +962,12 @@ static const struct wl_callback_listener sync_listener = {
* \param queue The queue on which to run the roundtrip * \param queue The queue on which to run the roundtrip
* \return The number of dispatched events on success or -1 on failure * \return The number of dispatched events on success or -1 on failure
* *
* Blocks until the server processes all currently issued requests and * This function blocks until the server has processed all currently issued
* sends out pending events on the event queue. * 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 * \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 * 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 * \param display The display context object
* \return The number of dispatched events on success or -1 on failure * \return The number of dispatched events on success or -1 on failure
* *
* Blocks until the server process all currently issued requests and * This function blocks until the server has processed all currently issued
* sends out pending events on the default event queue. * 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 * \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 * are using wl_display_read_events() from more threads, don't use this function