libpurple/ntlm.h

branch
soc.2013.gobjectification.plugins
changeset 37023
d9bcdc9a91e6
parent 37021
04c99b24db84
child 37034
9d6765962b22
--- a/libpurple/ntlm.h	Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/ntlm.h	Wed Jan 29 10:49:02 2014 +0530
@@ -32,9 +32,9 @@
 /**
  * Generates the base64 encoded type 1 message needed for NTLM authentication
  *
- * @hostname: Your hostname
- * @domain: The domain to authenticate to
- * Returns: base64 encoded string to send to the server.  This should
+ * @param hostname Your hostname
+ * @param domain The domain to authenticate to
+ * @return base64 encoded string to send to the server.  This should
  *         be g_free'd by the caller.
  */
 gchar *purple_ntlm_gen_type1(const gchar *hostname, const gchar *domain);
@@ -42,10 +42,10 @@
 /**
  * Parses the ntlm type 2 message
  *
- * @type2: String containing the base64 encoded type2 message
- * @flags: If not %NULL, this will store the flags for the message
+ * @param type2 String containing the base64 encoded type2 message
+ * @param flags If not @c NULL, this will store the flags for the message
  *
- * Returns: The nonce for use in message type3.  This is a statically
+ * @return The nonce for use in message type3.  This is a statically
  *         allocated 8 byte binary string.
  */
 guint8 *purple_ntlm_parse_type2(const gchar *type2, guint32 *flags);
@@ -53,13 +53,13 @@
 /**
  * Generates a type3 message
  *
- * @username: The username
- * @passw: The password
- * @hostname: The hostname
- * @domain: The domain to authenticate against
- * @nonce: The nonce returned by purple_ntlm_parse_type2
- * @flags: Pointer to the flags returned by purple_ntlm_parse_type2
- * Returns: A base64 encoded type3 message.  This should be g_free'd by
+ * @param username The username
+ * @param passw The password
+ * @param hostname The hostname
+ * @param domain The domain to authenticate against
+ * @param nonce The nonce returned by purple_ntlm_parse_type2
+ * @param flags Pointer to the flags returned by purple_ntlm_parse_type2
+ * @return A base64 encoded type3 message.  This should be g_free'd by
  *         the caller.
  */
 gchar *purple_ntlm_gen_type3(const gchar *username, const gchar *passw, const gchar *hostname, const gchar *domain, const guint8 *nonce, guint32 *flags);

mercurial