doc: Document the restriction of destroying queues before the display

[profile/ivi/wayland.git] / src / wayland-client.c

diff --git a/src/wayland-client.c b/src/wayland-client.c
index 2de80fd..1c660ef 100644 (file)
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -139,6 +139,10 @@ wl_event_queue_release(struct wl_event_queue *queue)
  * Destroy the given event queue. Any pending event on that queue is
  * discarded.
  *
+ * The \ref wl_display object used to create the queue should not be
+ * destroyed until all event queues created with it are destroyed with
+ * this function.
+ *
  * \memberof wl_event_queue
  */
 WL_EXPORT void