From 12d5c315bb0acde853607ece836cafa5f0748a74 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Tue, 1 Mar 2016 16:46:19 -0800 Subject: [PATCH] GUAC-1389: Add missing parameter comments to static functions in common. --- src/common/guac_clipboard.c | 10 ++++++++++ src/common/guac_cursor.c | 25 +++++++++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/src/common/guac_clipboard.c b/src/common/guac_clipboard.c index 302df367..12ae2ae0 100644 --- a/src/common/guac_clipboard.c +++ b/src/common/guac_clipboard.c @@ -52,6 +52,16 @@ void guac_common_clipboard_free(guac_common_clipboard* clipboard) { /** * Callback for guac_client_foreach_user() which sends clipboard data to each * connected client. + * + * @param user + * The user to send the clipboard data to. + * + * @param + * A pointer to the guac_common_clipboard structure containing the + * clipboard data that should be sent to the given user. + * + * @return + * Always NULL. */ static void* __send_user_clipboard(guac_user* user, void* data) { diff --git a/src/common/guac_cursor.c b/src/common/guac_cursor.c index 19d4bc2d..f679b079 100644 --- a/src/common/guac_cursor.c +++ b/src/common/guac_cursor.c @@ -148,6 +148,21 @@ void guac_common_cursor_move(guac_common_cursor* cursor, guac_user* user, /** * Ensures the cursor image buffer has enough room to fit an image with the * given characteristics. Existing image buffer data may be destroyed. + * + * @param cursor + * The cursor whose buffer size should be checked. If this cursor lacks + * sufficient space to contain a cursor image of the specified width, + * height, and stride, the current contents of this cursor will be + * destroyed and replaced with an new buffer having sufficient space. + * + * @param width + * The required cursor width, in pixels. + * + * @param height + * The required cursor height, in pixels. + * + * @param stride + * The number of bytes in each row of image data. */ static void guac_common_cursor_resize(guac_common_cursor* cursor, int width, int height, int stride) { @@ -171,6 +186,16 @@ static void guac_common_cursor_resize(guac_common_cursor* cursor, /** * Callback for guac_client_foreach_user() which sends the current cursor image * as PNG data to each connected client. + * + * @param user + * The user to send the cursor image to. + * + * @param data + * A pointer to the guac_common_cursor structure containing the cursor + * image that should be sent to the given user. + * + * @return + * Always NULL. */ static void* __send_user_cursor_image(guac_user* user, void* data) {