From b1c13e1fa60092b8154b37def95fa37b160fb99c Mon Sep 17 00:00:00 2001 From: James Muehlner Date: Sat, 9 Mar 2013 15:56:01 -0800 Subject: [PATCH] Ticket #255: Added comments about the functionality of convert() --- protocols/vnc/include/convert.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/protocols/vnc/include/convert.h b/protocols/vnc/include/convert.h index 5e5b7a71..d6cf1258 100644 --- a/protocols/vnc/include/convert.h +++ b/protocols/vnc/include/convert.h @@ -40,7 +40,14 @@ #include -char * convert (const char *from_charset, const char *to_charset, const char *input); +/** + * Converts a string from one charset to another. Returns a newly allocated string. + * @param from_charset The string representing the character set to convert from. + * @param to_charset The string representing the character set to convert to. + * @return A newly allocated string that is the result of the conversion, or NULL + * if an error has occured. + */ +char* convert (const char* from_charset, const char* to_charset, char* input); #endif