doc: Document the restriction of destroying queues before the display
authorAnder Conselvan de Oliveira <ander.conselvan.de.oliveira@intel.com>
Tue, 16 Oct 2012 14:29:07 +0000 (17:29 +0300)
committerKristian Høgsberg <krh@bitplanet.net>
Tue, 16 Oct 2012 14:50:14 +0000 (10:50 -0400)
src/wayland-client.c

index 2de80fd..1c660ef 100644 (file)
@@ -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