GUACAMOLE-424: Update doc comments
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/commit/aa6d81d6 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/tree/aa6d81d6 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/diff/aa6d81d6 Branch: refs/heads/master Commit: aa6d81d6f944df6654c74ab4b514b1fa388c4850 Parents: e139b20 Author: itsankoff <ivaylotsanko...@gmail.com> Authored: Wed Nov 15 14:58:06 2017 +0200 Committer: itsankoff <ivaylotsanko...@gmail.com> Committed: Wed Nov 15 15:02:08 2017 +0200 ---------------------------------------------------------------------- src/common/cursor.c | 4 +++- src/common/display.c | 5 ++++- 2 files changed, 7 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/aa6d81d6/src/common/cursor.c ---------------------------------------------------------------------- diff --git a/src/common/cursor.c b/src/common/cursor.c index 616f23b..f621b94 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) { http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/aa6d81d6/src/common/display.c ---------------------------------------------------------------------- diff --git a/src/common/display.c b/src/common/display.c index ff70c58..5d8ce9f 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) {
