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

doc: Added \code tags around sample code in doxygen comments

Browse source 
Also removed \comment and used C++ comments. There does not appear
to be any other way to put comments into code samples.

Reviewed-by: Bryce Harrington <b.harrington@samsung.com>
This commit is contained in:
Bill Spitzak 2014-11-11 18:42:59 -08:00 • committed by Pekka Paalanen
parent dd534a1fde
commit 40aa80a408
3 changed files with 32 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/wayland-client.c
View file

@ -1326,10 +1326,12 @@ wl_display_prepare_read_queue(struct wl_display *display,
* it will assume the file descriptor is readable and read events from
* the fd by calling wl_display_dispatch(). Simplified, we have:
*
* wl_display_dispatch_pending(display);
* wl_display_flush(display);
* poll(fds, nfds, -1);
* wl_display_dispatch(display);
* \code
* wl_display_dispatch_pending(display);
* wl_display_flush(display);
* poll(fds, nfds, -1);
* wl_display_dispatch(display);
* \endcode
*
* There are two races here: first, before blocking in poll(), the fd
* could become readable and another thread reads the events. Some of
@ -1344,13 +1346,14 @@ wl_display_prepare_read_queue(struct wl_display *display,
* fds in the event loop.
*
* A correct sequence would be:
*
* while (wl_display_prepare_read(display) != 0)
* wl_display_dispatch_pending(display);
* wl_display_flush(display);
* poll(fds, nfds, -1);
* wl_display_read_events(display);
* wl_display_dispatch_pending(display);
* \code
* while (wl_display_prepare_read(display) != 0)
* wl_display_dispatch_pending(display);
* wl_display_flush(display);
* poll(fds, nfds, -1);
* wl_display_read_events(display);
* wl_display_dispatch_pending(display);
* \endcode
*
* Here we call wl_display_prepare_read(), which ensures that between
* returning from that call and eventually calling