Doc fixes for GTK-DOC.

1 files changed, 30 insertions, 25 deletions

diff --git a/lib/gnutls_auth.c b/lib/gnutls_auth.c
index 77af880807..ba15a483ae 100644
--- a/lib/gnutls_auth.c
+++ b/lib/gnutls_auth.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2008 Free Software Foundation
+ * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2008, 2009 Free Software Foundation
  *
  * Author: Nikos Mavrogiannopoulos
  *
@@ -66,30 +66,35 @@ gnutls_credentials_clear (gnutls_session_t session)
  * { algorithm, credentials, pointer to next }
  */
 /**
-  * gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm.
-  * @session: is a #gnutls_session_t structure.
-  * @type: is the type of the credentials
-  * @cred: is a pointer to a structure.
-  *
-  * Sets the needed credentials for the specified type.
-  * Eg username, password - or public and private keys etc.  
-  * The (void* cred) parameter is a structure that depends on the
-  * specified type and on the current session (client or server).
-  * [ In order to minimize memory usage, and share credentials between 
-  * several threads gnutls keeps a pointer to cred, and not the whole cred
-  * structure. Thus you will have to keep the structure allocated until   
-  * you call gnutls_deinit(). ]
-  *
-  * For GNUTLS_CRD_ANON cred should be gnutls_anon_client_credentials_t in case of a client.
-  * In case of a server it should be gnutls_anon_server_credentials_t.
-  * 
-  * For GNUTLS_CRD_SRP cred should be gnutls_srp_client_credentials_t
-  * in case of a client, and gnutls_srp_server_credentials_t, in case
-  * of a server.
-  *
-  * For GNUTLS_CRD_CERTIFICATE cred should be gnutls_certificate_credentials_t.
-  *
-  **/
+ * gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm.
+ * @session: is a #gnutls_session_t structure.
+ * @type: is the type of the credentials
+ * @cred: is a pointer to a structure.
+ *
+ * Sets the needed credentials for the specified type.  Eg username,
+ * password - or public and private keys etc.  The @cred parameter is
+ * a structure that depends on the specified type and on the current
+ * session (client or server).
+ *
+ * In order to minimize memory usage, and share credentials between
+ * several threads gnutls keeps a pointer to cred, and not the whole
+ * cred structure.  Thus you will have to keep the structure allocated
+ * until you call gnutls_deinit().
+ *
+ * For %GNUTLS_CRD_ANON, @cred should be
+ * #gnutls_anon_client_credentials_t in case of a client.  In case of
+ * a server it should be #gnutls_anon_server_credentials_t.
+ *
+ * For %GNUTLS_CRD_SRP, @cred should be #gnutls_srp_client_credentials_t
+ * in case of a client, and #gnutls_srp_server_credentials_t, in case
+ * of a server.
+ *
+ * For %GNUTLS_CRD_CERTIFICATE, @cred should be
+ * #gnutls_certificate_credentials_t.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ *   otherwise an error code is returned.
+ **/
 int
 gnutls_credentials_set (gnutls_session_t session,
 			gnutls_credentials_type_t type, void *cred)