changeset 30703:27e45413d030

Document msnutils.
author masca@cpw.pidgin.im
date Tue, 23 Feb 2010 17:49:32 +0000
parents 8eb42d13cb3f
children 01bf1b3fa9dd
files libpurple/protocols/msn/msnutils.h
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/protocols/msn/msnutils.h	Tue Feb 23 17:33:33 2010 +0000
+++ b/libpurple/protocols/msn/msnutils.h	Tue Feb 23 17:49:32 2010 +0000
@@ -54,7 +54,23 @@
  */
 void msn_import_html(const char *html, char **attributes, char **message);
 
+/**
+ * Parses a socket string.
+ *
+ * @param str		A host:port string.
+ * @param ret_host 	Return string value of the host.
+ * @param ret_port	Return integer value of the port.
+ */
 void msn_parse_socket(const char *str, char **ret_host, int *ret_port);
+
+/**
+ * Handle MSN Challenge Computation
+ * This algorithm references
+ * http://imfreedom.org/wiki/index.php/MSN:NS/Challenges
+ *
+ * @param input 	Challenge input.
+ * @param output 	Callenge output.
+ */
 void msn_handle_chl(char *input, char *output);
 
 #endif /* MSN_UTILS_H */