[PATCH wayland 5/6] doc: Fix function membership
Jonas Ådahl
jadahl at gmail.com
Mon Dec 28 18:10:13 PST 2015
Put the various misplaced functions in the right class; partly because
its where they belong, and partly to make intra-class \ref(erences)
happy.
Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
---
src/wayland-client-core.h | 4 ++--
src/wayland-client.c | 10 +++++-----
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/wayland-client-core.h b/src/wayland-client-core.h
index 8b4b4b8..a729395 100644
--- a/src/wayland-client-core.h
+++ b/src/wayland-client-core.h
@@ -103,8 +103,8 @@ struct wl_proxy;
* queue, reading all the data from the display fd. If the application
* would call \em poll(2) after that it would block, even though there
* might be events queued on the default queue. Those events should be
- * dispatched with \ref wl_display_dispatch_(queue_)pending() before
- * flushing and blocking.
+ * dispatched with \ref wl_display_dispatch_pending() or \ref
+ * wl_display_dispatch_queue_pending() before flushing and blocking.
*/
struct wl_display;
diff --git a/src/wayland-client.c b/src/wayland-client.c
index 613767e..2796030 100644
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -309,7 +309,7 @@ wl_event_queue_destroy(struct wl_event_queue *queue)
* \return A new event queue associated with this display or NULL on
* failure.
*
- * \memberof wl_event_queue
+ * \memberof wl_display
*/
WL_EXPORT struct wl_event_queue *
wl_display_create_queue(struct wl_display *display)
@@ -965,7 +965,7 @@ static const struct wl_callback_listener sync_listener = {
* with calling wl_display_prepare_read() and wl_display_read_events())
*
* \sa wl_display_roundtrip()
- * \memberof wl_event_queue
+ * \memberof wl_display
*/
WL_EXPORT int
wl_display_roundtrip_queue(struct wl_display *display, struct wl_event_queue *queue)
@@ -1465,7 +1465,7 @@ wl_display_prepare_read_queue(struct wl_display *display,
* with the default queue passed as the queue.
*
* \sa wl_display_prepare_read_queue
- * \memberof wl_event_queue
+ * \memberof wl_display
*/
WL_EXPORT int
wl_display_prepare_read(struct wl_display *display)
@@ -1527,7 +1527,7 @@ wl_display_cancel_read(struct wl_display *display)
* \sa wl_display_dispatch(), wl_display_dispatch_pending(),
* wl_display_dispatch_queue_pending()
*
- * \memberof wl_event_queue
+ * \memberof wl_display
*/
WL_EXPORT int
wl_display_dispatch_queue(struct wl_display *display,
@@ -1599,7 +1599,7 @@ wl_display_dispatch_queue(struct wl_display *display,
* event queue. On failure -1 is returned and errno set appropriately.
* If there are no events queued, this function returns immediately.
*
- * \memberof wl_event_queue
+ * \memberof wl_display
* \since 1.0.2
*/
WL_EXPORT int
--
2.4.3
More information about the wayland-devel
mailing list