summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2023-03-01 15:14:37 +0100
committerSimon Ser <contact@emersion.fr>2023-03-07 13:22:43 +0000
commit3956948fac5c0bf29ee13fd1c299a47a16c05a6d (patch)
tree5f14db7bafad0cb49657c2fdfef6b36970ad506f
parentb01a85dfd5e8cda7170b7ba6fe66fc3800f93990 (diff)
downloadwayland-3956948fac5c0bf29ee13fd1c299a47a16c05a6d.tar.gz
client: fix wl_display_disconnect() documentation
Signed-off-by: Simon Ser <contact@emersion.fr> Closes: https://gitlab.freedesktop.org/wayland/wayland/-/issues/361
-rw-r--r--src/wayland-client.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/wayland-client.c b/src/wayland-client.c
index 054c0c7..105f9be 100644
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -1308,8 +1308,9 @@ wl_display_connect(const char *name)
*
* \param display The display context object
*
- * Close the connection to \c display and free all resources associated
- * with it.
+ * Close the connection to \c display. The \ref wl_proxy and
+ * \ref wl_event_queue objects need to be manually destroyed by the caller
+ * before disconnecting.
*
* \memberof wl_display
*/