GUAC-298: Add missing comment. Update documentation style.

This commit is contained in:
Michael Jumper 2015-07-27 17:51:03 -07:00
parent 80a4d37173
commit 7bfd7ce0ca
2 changed files with 14 additions and 6 deletions

View File

@ -225,12 +225,16 @@ static rfbClient* __guac_vnc_get_client(guac_client* client) {
* Configure the VNC clipboard reader/writer based on configured encoding.
* Defaults to standard ISO8859-1 encoding if an invalid format is encountered.
*
* @param guac_client_data Structure containing VNC client configuration.
* @param name Encoding name.
* @return Returns 0 if standard ISO8859-1 encoding is used, 1 otherwise.
* @param guac_client_data
* Structure containing VNC client configuration.
*
* @param name
* Encoding name.
*
* @return
* Returns 0 if standard ISO8859-1 encoding is used, 1 otherwise.
*/
int __guac_client_configure_clipboard_encoding(vnc_guac_client_data* guac_client_data,
const char* name) {
int __guac_client_configure_clipboard_encoding(vnc_guac_client_data* guac_client_data, const char* name) {
/* Configure clipboard reader/writer based on encoding name */
if (strcmp(name, "UTF-8") == 0) {

View File

@ -211,9 +211,13 @@ typedef struct vnc_guac_client_data {
#endif
/**
* Clipboard encoding specific reader and writer.
* Clipboard encoding-specific reader.
*/
guac_iconv_read* clipboard_reader;
/**
* Clipboard encoding-specific writer.
*/
guac_iconv_write* clipboard_writer;
} vnc_guac_client_data;