From aa6d81d6f944df6654c74ab4b514b1fa388c4850 Mon Sep 17 00:00:00 2001
From: itsankoff <ivaylotsankov93@gmail.com>
Date: Wed, 15 Nov 2017 14:58:06 +0200
Subject: [PATCH] GUACAMOLE-424: Update doc comments

---
 src/common/cursor.c  | 4 +++-
 src/common/display.c | 5 ++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/common/cursor.c b/src/common/cursor.c
index 616f23b5..f621b942 100644
--- a/src/common/cursor.c
+++ b/src/common/cursor.c
@@ -37,10 +37,12 @@
 
 /**
  * Allocates a cursor as well as an image buffer where the cursor is rendered.
- * If the allocation fails then the function returns NULL.
  *
  * @param client
  *     The client owning the cursor.
+ *
+ * @return
+ *     The newly-allocated cursor or NULL if cursor cannot be allocated.
  */
 guac_common_cursor* guac_common_cursor_alloc(guac_client* client) {
 
diff --git a/src/common/display.c b/src/common/display.c
index ff70c587..5d8ce9f1 100644
--- a/src/common/display.c
+++ b/src/common/display.c
@@ -101,7 +101,7 @@ static void guac_common_display_free_layers(guac_common_display_layer* layers,
 
 /**
  * Allocates a display and a cursor which are used to represent the remote
- * display and cursor. If the allocation fails then the function returns NULL.
+ * display and cursor.
  *
  * @param client
  *     The client owning the cursor.
@@ -111,6 +111,9 @@ static void guac_common_display_free_layers(guac_common_display_layer* layers,
  *
  * @param height
  *     The desired height of the display.
+ *
+ * @return
+ *     The newly-allocated display or NULL if display cannot be allocated.
  */
 guac_common_display* guac_common_display_alloc(guac_client* client,
         int width, int height) {