Fix GTK-DOC warnings.

8 files changed, 49 insertions, 46 deletions

diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c
index 7775f59700..310627ca89 100644
--- a/lib/gnutls_ui.c
+++ b/lib/gnutls_ui.c
@@ -778,10 +778,11 @@ size_t len;
  * gnutls_url_is_supported:
  * @url: A PKCS 11 url
  *
- * This function will return non-zero if the given URL
- * is supported, and zero if it is not known. Depending
- * on the system libraries GnuTLS may support pkcs11 or
- * tpmkey URLs.
+ * Check whether url is supported.  Depending on the system libraries
+ * GnuTLS may support pkcs11 or tpmkey URLs.
+ *
+ * Returns: return non-zero if the given URL is supported, and zero if
+ * it is not known.
  *
  * Since: 3.1.0
  **/
diff --git a/lib/includes/gnutls/abstract.h b/lib/includes/gnutls/abstract.h
index 68e6fc3e37..245af8795e 100644
--- a/lib/includes/gnutls/abstract.h
+++ b/lib/includes/gnutls/abstract.h
@@ -227,7 +227,7 @@ gnutls_privkey_import_tpm_raw (gnutls_privkey_t pkey,
 			       const gnutls_datum_t * fdata,
 			       gnutls_tpmkey_fmt_t format,
 			       const char *srk_password,
-			       const char *tpm_password, unsigned int flags);
+			       const char *key_password, unsigned int flags);
 
 int
 gnutls_privkey_import_tpm_url (gnutls_privkey_t pkey,
diff --git a/lib/includes/gnutls/gnutls.h.in b/lib/includes/gnutls/gnutls.h.in
index ce77a8a300..5ca00ae320 100644
--- a/lib/includes/gnutls/gnutls.h.in
+++ b/lib/includes/gnutls/gnutls.h.in
@@ -754,7 +754,8 @@ typedef enum
   int gnutls_handshake (gnutls_session_t session);
 
 #define GNUTLS_DEFAULT_HANDSHAKE_TIMEOUT ((unsigned int)-1)
-  void gnutls_handshake_set_timeout (gnutls_session_t session, unsigned int sec);
+  void gnutls_handshake_set_timeout (gnutls_session_t session,
+				     unsigned int ms);
   int gnutls_rehandshake (gnutls_session_t session);
 
   gnutls_alert_description_t gnutls_alert_get (gnutls_session_t session);
@@ -804,11 +805,13 @@ gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t session);
                                                 type);
   const char *gnutls_pk_get_name (gnutls_pk_algorithm_t algorithm);
   const char *gnutls_sign_get_name (gnutls_sign_algorithm_t algorithm);
-  gnutls_digest_algorithm_t gnutls_sign_get_hash_algorithm (gnutls_sign_algorithm_t);
-  gnutls_pk_algorithm_t gnutls_sign_get_pk_algorithm (gnutls_sign_algorithm_t);
-  
-  gnutls_sign_algorithm_t gnutls_pk_to_sign (gnutls_pk_algorithm_t pk,
-                                             gnutls_digest_algorithm_t d);
+  gnutls_digest_algorithm_t
+  gnutls_sign_get_hash_algorithm (gnutls_sign_algorithm_t sign);
+  gnutls_pk_algorithm_t
+  gnutls_sign_get_pk_algorithm (gnutls_sign_algorithm_t sign);
+  gnutls_sign_algorithm_t
+  gnutls_pk_to_sign (gnutls_pk_algorithm_t pk,
+		     gnutls_digest_algorithm_t hash);
 
 #define gnutls_sign_algorithm_get_name gnutls_sign_get_name
 
diff --git a/lib/includes/gnutls/pkcs11.h b/lib/includes/gnutls/pkcs11.h
index f9abc117b7..84af6f2ba1 100644
--- a/lib/includes/gnutls/pkcs11.h
+++ b/lib/includes/gnutls/pkcs11.h
@@ -83,9 +83,9 @@ gnutls_pin_callback_t gnutls_pkcs11_get_pin_function (void **userdata);
 
 int gnutls_pkcs11_add_provider (const char *name, const char *params);
 int gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * obj);
-void gnutls_pkcs11_obj_set_pin_function (gnutls_pkcs11_obj_t,
-                                         gnutls_pin_callback_t fn, 
-                                         void *userdata);
+void gnutls_pkcs11_obj_set_pin_function (gnutls_pkcs11_obj_t obj,
+					 gnutls_pin_callback_t fn,
+					 void *userdata);
 
 #define GNUTLS_PKCS11_OBJ_FLAG_LOGIN (1<<0)     /* force login in the token for the operation */
 #define GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED (1<<1)      /* object marked as trusted */
@@ -109,10 +109,10 @@ typedef enum
     GNUTLS_PKCS11_URL_LIB_VERSION /* URL specifies the object on module and version level */
   } gnutls_pkcs11_url_type_t;
 
-int gnutls_pkcs11_obj_import_url (gnutls_pkcs11_obj_t cert,
+int gnutls_pkcs11_obj_import_url (gnutls_pkcs11_obj_t obj,
 				  const char *url,
-                                  unsigned int flags
-                                  /* GNUTLS_PKCS11_OBJ_FLAG_* */ );
+				  unsigned int flags
+				  /* GNUTLS_PKCS11_OBJ_FLAG_* */ );
 int gnutls_pkcs11_obj_export_url (gnutls_pkcs11_obj_t obj,
                                   gnutls_pkcs11_url_type_t detailed,
                                   char **url);
@@ -279,32 +279,33 @@ gnutls_pkcs11_obj_type_t gnutls_pkcs11_obj_get_type (gnutls_pkcs11_obj_t obj);
 const char *gnutls_pkcs11_type_get_name (gnutls_pkcs11_obj_type_t type);
 
 int gnutls_x509_crt_list_import_pkcs11 (gnutls_x509_crt_t * certs,
-					unsigned int cert_max, 
+					unsigned int cert_max,
 					gnutls_pkcs11_obj_t * const objs,
 					unsigned int flags  /* must be zero */);
 
 /* private key functions...*/
 int gnutls_pkcs11_privkey_init (gnutls_pkcs11_privkey_t * key);
-void gnutls_pkcs11_privkey_set_pin_function (gnutls_pkcs11_privkey_t,
-                                             gnutls_pin_callback_t fn, void *userdata);
+void gnutls_pkcs11_privkey_set_pin_function (gnutls_pkcs11_privkey_t key,
+					     gnutls_pin_callback_t fn,
+					     void *userdata);
 void gnutls_pkcs11_privkey_deinit (gnutls_pkcs11_privkey_t key);
 int gnutls_pkcs11_privkey_get_pk_algorithm (gnutls_pkcs11_privkey_t key,
-                                            unsigned int *bits);
+					    unsigned int *bits);
 int gnutls_pkcs11_privkey_get_info (gnutls_pkcs11_privkey_t pkey,
-                                    gnutls_pkcs11_obj_info_t itype,
-                                    void *output, size_t * output_size);
+				    gnutls_pkcs11_obj_info_t itype,
+				    void *output, size_t * output_size);
 
 int gnutls_pkcs11_privkey_import_url (gnutls_pkcs11_privkey_t pkey,
-                                      const char *url, unsigned int flags);
+				      const char *url, unsigned int flags);
 
 int gnutls_pkcs11_privkey_export_url (gnutls_pkcs11_privkey_t key,
-                                      gnutls_pkcs11_url_type_t detailed,
-                                      char **url);
+				      gnutls_pkcs11_url_type_t detailed,
+				      char **url);
 
-int
-gnutls_pkcs11_privkey_generate (const char* url, 
-  gnutls_pk_algorithm_t pk, unsigned int bits, 
-  const char* label, unsigned int flags);
+int gnutls_pkcs11_privkey_generate (const char* url,
+				    gnutls_pk_algorithm_t pk,
+				    unsigned int bits,
+				    const char* label, unsigned int flags);
 
 #ifdef __cplusplus
 }
diff --git a/lib/includes/gnutls/tpm.h b/lib/includes/gnutls/tpm.h
index cea1c75bf1..7d2ffb62c6 100644
--- a/lib/includes/gnutls/tpm.h
+++ b/lib/includes/gnutls/tpm.h
@@ -40,8 +40,8 @@ typedef struct tpm_key_list_st *gnutls_tpm_key_list_t;
 
 /**
  * gnutls_tpmkey_fmt_t:
- * @GNUTLS_TPM_FMT_DER: The portable data format.
- * @GNUTLS_TPM_FMT_CTK_PEM: A custom data format used by some TPM tools.
+ * @GNUTLS_TPMKEY_FMT_DER: The portable data format.
+ * @GNUTLS_TPMKEY_FMT_CTK_PEM: A custom data format used by some TPM tools.
  *
  * Enumeration of different certificate encoding formats.
  */
diff --git a/lib/pkcs11.c b/lib/pkcs11.c
index 1e7b034779..35be7dfa2c 100644
--- a/lib/pkcs11.c
+++ b/lib/pkcs11.c
@@ -761,10 +761,11 @@ gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * obj)
  * set using gnutls_pkcs11_set_pin_function().
  *
  * Since: 3.1.0
- *
  **/
-void gnutls_pkcs11_obj_set_pin_function (gnutls_pkcs11_obj_t obj,
-                                         gnutls_pin_callback_t fn, void *userdata)
+void
+gnutls_pkcs11_obj_set_pin_function (gnutls_pkcs11_obj_t obj,
+				    gnutls_pin_callback_t fn,
+				    void *userdata)
 {
   obj->pin.cb = fn;
   obj->pin.data = userdata;
diff --git a/lib/pkcs11_privkey.c b/lib/pkcs11_privkey.c
index 3a6ce09652..4e90657722 100644
--- a/lib/pkcs11_privkey.c
+++ b/lib/pkcs11_privkey.c
@@ -686,8 +686,10 @@ cleanup:
  * Since: 3.1.0
  *
  **/
-void gnutls_pkcs11_privkey_set_pin_function (gnutls_pkcs11_privkey_t key,
-                                             gnutls_pin_callback_t fn, void *userdata)
+void
+gnutls_pkcs11_privkey_set_pin_function (gnutls_pkcs11_privkey_t key,
+					gnutls_pin_callback_t fn,
+					void *userdata)
 {
   key->pin.cb = fn;
   key->pin.data = userdata;
diff --git a/lib/tpm.c b/lib/tpm.c
index 47f0466a18..848cf9657f 100644
--- a/lib/tpm.c
+++ b/lib/tpm.c
@@ -1052,19 +1052,18 @@ int ret;
  * @fdata: The TPM key to be imported
  * @format: The format of the private key
  * @srk_password: The password for the SRK key (optional)
- * @key_password: A password for the key (optional)
  * @flags: One of the %GNUTLS_PUBKEY flags
  *
- * This function will import the public key from the provided
- * TPM key structure. 
+ * This function will import the public key from the provided TPM key
+ * structure.
  *
- * With respect to passwords the same as in gnutls_pubkey_import_tpm_url() apply.
+ * With respect to passwords the same as in
+ * gnutls_pubkey_import_tpm_url() apply.
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
  *   negative error value.
  *
  * Since: 3.1.0
- *
  **/
 int
 gnutls_pubkey_import_tpm_raw (gnutls_pubkey_t pkey,
@@ -1469,9 +1468,6 @@ err_cc:
  *
  * This function will deinitialize the list of stored keys in the TPM.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
- *   negative error value.
- *
  * Since: 3.1.0
  **/
 void
@@ -1510,7 +1506,6 @@ gnutls_tpm_key_list_get_url (gnutls_tpm_key_list_t list, unsigned int idx, char*
 /**
  * gnutls_tpm_get_registered:
  * @list: a list to store the keys
- * @srk_password: a password to protect the exported key (optional)
  *
  * This function will get a list of stored keys in the TPM. The uuid
  * of those keys