From 880553bf3e02c76f9fdf2f2f85714a1373598384 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Thu, 3 Mar 2016 12:05:41 -0800 Subject: [PATCH] GUAC-1389: Document clipboard handler parameters. --- src/protocols/vnc/clipboard.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/protocols/vnc/clipboard.h b/src/protocols/vnc/clipboard.h index f6ee59eb..b225c3c3 100644 --- a/src/protocols/vnc/clipboard.h +++ b/src/protocols/vnc/clipboard.h @@ -64,7 +64,18 @@ guac_user_blob_handler guac_vnc_clipboard_blob_handler; guac_user_end_handler guac_vnc_clipboard_end_handler; /** - * Handler for clipboard data received via VNC. + * Handler for clipboard data received via VNC, invoked by libVNCServer + * whenever text has been copied or cut within the VNC session. + * + * @param client + * The VNC client associated with the session in which the user cut or + * copied text. + * + * @param text + * The string of cut/copied text. + * + * @param textlen + * The number of bytes in the string of cut/copied text. */ void guac_vnc_cut_text(rfbClient* client, const char* text, int textlen);