GUACAMOLE-424: Update doc comments

This commit is contained in:
itsankoff 2017-11-15 14:58:06 +02:00
parent e139b20d12
commit aa6d81d6f9
2 changed files with 7 additions and 2 deletions

View File

@ -37,10 +37,12 @@
/** /**
* Allocates a cursor as well as an image buffer where the cursor is rendered. * 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 * @param client
* The client owning the cursor. * 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) { guac_common_cursor* guac_common_cursor_alloc(guac_client* client) {

View File

@ -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 * 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 * @param client
* The client owning the cursor. * The client owning the cursor.
@ -111,6 +111,9 @@ static void guac_common_display_free_layers(guac_common_display_layer* layers,
* *
* @param height * @param height
* The desired height of the display. * 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, guac_common_display* guac_common_display_alloc(guac_client* client,
int width, int height) { int width, int height) {