GUACAMOLE-424: Add doc comment for guac_common_cursor_alloc

This commit is contained in:
itsankoff 2017-11-13 14:49:44 +02:00
parent bbafa00df0
commit da0fc1a6d8

View File

@ -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));