diff options
| author | Ander Conselvan de Oliveira <ander.conselvan.de.oliveira@intel.com> | 2012-10-17 21:26:09 +0300 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2012-10-17 17:29:04 -0400 |
| commit | a4dace7e307577e39fd4bb354defcbc171a2dc92 (patch) | |
| tree | bb14a28aaa91dce8af473d79c5439c0c95a49530 | |
| parent | 0a6fabecd7f2b15cb320414d37f29a007f6e171a (diff) | |
doc: Update wl_display_get_error() documentation
| -rw-r--r-- | src/wayland-client.c | 10 |
1 files 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 */ |