[PATCH 2/2] doc: Update wl_display_get_error() documentation

[Ander Conselvan de Oliveira]

From: Ander Conselvan de Oliveira <ander.conselvan.de.oliveira at intel.com>

---
 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 89df3ba..5d2dced 100644
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -896,10 +896,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
  */
-- 
1.7.9.5