[PATCH wayland 5/8] client: Improve wl_display_roundtrip(_queue)() documentation

[Bryce Harrington]

On Fri, Oct 02, 2015 at 05:32:56PM +0800, Jonas Ådahl wrote:
> 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 at gmail.com>
Reviewed-by: Bryce Harrington <bryce at osg.samsung.com>
> ---
>  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 056d341..c472f52 100644
> --- a/src/wayland-client.c
> +++ b/src/wayland-client.c
> @@ -973,8 +973,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
> @@ -1010,8 +1014,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.4.3
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel