From a4dace7e307577e39fd4bb354defcbc171a2dc92 Mon Sep 17 00:00:00 2001 From: Ander Conselvan de Oliveira Date: Wed, 17 Oct 2012 21:26:09 +0300 Subject: [PATCH] doc: Update wl_display_get_error() documentation --- src/wayland-client.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/wayland-client.c b/src/wayland-client.c index 9ac4edb..ccf8174 100644 --- a/src/wayland-client.c +++ b/src/wayland-client.c @@ -860,10 +860,16 @@ wl_display_dispatch_pending(struct wl_display *display) return dispatch_queue(display, &display->queue, 0); } -/** Retrieve the last error sent by the server +/** Retrieve the last error occured on a display * * \param display The display context object - * \return The last error sent asynchronously by \c display + * \return The last error occured on \c display or 0 if no error occured + * + * Return the last error occured on the display. This may be an error sent + * by the server or caused by the local client. + * + * \note Errors are \b fatal. If this function returns non-zero the display + * can no longer be used. * * \memberof wl_display */