[3/7] incubator-guacamole-server git commit: GUACAMOLE-424: Add doc comment for guac_common_cursor_alloc

[mj...@apache.org]

GUACAMOLE-424: Add doc comment for guac_common_cursor_alloc


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/da0fc1a6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/tree/da0fc1a6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/diff/da0fc1a6

Branch: refs/heads/master
Commit: da0fc1a6d8c2296eec2c43ca06cb9f37df18d9f7
Parents: bbafa00
Author: itsankoff <iv...@gmail.com>
Authored: Mon Nov 13 14:49:44 2017 +0200
Committer: itsankoff <iv...@gmail.com>
Committed: Mon Nov 13 14:49:44 2017 +0200

----------------------------------------------------------------------
 src/common/cursor.c | 8 ++++++++
 1 file changed, 8 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/da0fc1a6/src/common/cursor.c
----------------------------------------------------------------------
diff --git a/src/common/cursor.c b/src/common/cursor.c
index f956f6a..616f23b 100644
--- a/src/common/cursor.c
+++ b/src/common/cursor.c
@@ -34,6 +34,14 @@
 #include <stdlib.h>
 #include <string.h>
 
+
+/**
+ * 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.
+ */
 guac_common_cursor* guac_common_cursor_alloc(guac_client* client) {
 
     guac_common_cursor* cursor = malloc(sizeof(guac_common_cursor));