]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
documentation fixes.
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Wed, 23 Mar 2011 19:03:47 +0000 (20:03 +0100)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Wed, 23 Mar 2011 19:04:15 +0000 (20:04 +0100)
lib/includes/gnutls/abstract.h
lib/includes/gnutls/gnutls.h.in
lib/includes/gnutls/pkcs11.h
lib/includes/gnutls/x509.h
lib/pkcs11.c
lib/x509/crl.c

index bd687659e18a905ca886c10761cab65e15fce82a..73266df75f94d847e040104ac2d2320c7e2c74d7 100644 (file)
@@ -19,7 +19,7 @@ int gnutls_pubkey_init (gnutls_pubkey_t * key);
 void gnutls_pubkey_deinit (gnutls_pubkey_t key);
 int gnutls_pubkey_get_pk_algorithm (gnutls_pubkey_t key, unsigned int *bits);
 
-int gnutls_pubkey_import_x509 (gnutls_pubkey_t pkey, gnutls_x509_crt_t crt,
+int gnutls_pubkey_import_x509 (gnutls_pubkey_t key, gnutls_x509_crt_t crt,
                                unsigned int flags);
 int gnutls_pubkey_import_pkcs11 (gnutls_pubkey_t pkey,
                                  gnutls_pkcs11_obj_t crt, unsigned int flags);
@@ -35,9 +35,9 @@ int gnutls_pubkey_get_preferred_hash_algorithm (gnutls_pubkey_t key,
                                                 gnutls_digest_algorithm_t *
                                                 hash, unsigned int *mand);
 
-int gnutls_pubkey_get_pk_rsa_raw (gnutls_pubkey_t crt,
+int gnutls_pubkey_get_pk_rsa_raw (gnutls_pubkey_t key,
                                   gnutls_datum_t * m, gnutls_datum_t * e);
-int gnutls_pubkey_get_pk_dsa_raw (gnutls_pubkey_t crt,
+int gnutls_pubkey_get_pk_dsa_raw (gnutls_pubkey_t key,
                                   gnutls_datum_t * p, gnutls_datum_t * q,
                                   gnutls_datum_t * g, gnutls_datum_t * y);
 
@@ -65,7 +65,7 @@ int gnutls_pubkey_import_dsa_raw (gnutls_pubkey_t key,
                                   const gnutls_datum_t * q,
                                   const gnutls_datum_t * g,
                                   const gnutls_datum_t * y);
-int gnutls_pubkey_import_rsa_raw (gnutls_pubkey_t pubkey,
+int gnutls_pubkey_import_rsa_raw (gnutls_pubkey_t key,
                                   const gnutls_datum_t * m,
                                   const gnutls_datum_t * e);
 
@@ -124,7 +124,7 @@ int gnutls_privkey_sign_hash (gnutls_privkey_t signer,
                              const gnutls_datum_t * hash_data,
                              gnutls_datum_t * signature);
 
-int gnutls_privkey_decrypt_data (gnutls_privkey_t signer,
+int gnutls_privkey_decrypt_data (gnutls_privkey_t key,
                                  unsigned int flags,
                                  const gnutls_datum_t * ciphertext,
                                  gnutls_datum_t * plaintext);
index aa490707ea97722163412854567dcb724d55a7d2..674ca6053220eccfd2b45f5e2ad8c2a8d51a8eea 100644 (file)
@@ -1087,8 +1087,8 @@ extern "C"
   typedef int (*mutex_unlock_func) (void **mutex);
   typedef int (*mutex_deinit_func) (void **mutex);
 
-  void gnutls_global_set_mutex (mutex_init_func init, mutex_deinit_func,
-                                mutex_lock_func, mutex_unlock_func);
+  void gnutls_global_set_mutex (mutex_init_func init, mutex_deinit_func deinit,
+                                mutex_lock_func lock, mutex_unlock_func unlock);
 
   typedef void *(*gnutls_alloc_function) (size_t);
   typedef void *(*gnutls_calloc_function) (size_t, size_t);
index 0b9b2f27c8f8c6906cc067c585744d607663c20f..4f2cefd6a43a464cc3f496f4e8afa165a91313d1 100644 (file)
@@ -59,10 +59,11 @@ int gnutls_pkcs11_init (unsigned int flags, const char *configfile);
 void gnutls_pkcs11_deinit (void);
 void gnutls_pkcs11_set_token_function (gnutls_pkcs11_token_callback_t fn,
                                        void *userdata);
-void gnutls_pkcs11_set_pin_function (gnutls_pkcs11_pin_callback_t callback,
-                                     void *data);
+
+void gnutls_pkcs11_set_pin_function (gnutls_pkcs11_pin_callback_t fn,
+                                     void *userdata);
 int gnutls_pkcs11_add_provider (const char *name, const char *params);
-int gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * certificate);
+int gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * obj);
 
 #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 */
@@ -86,10 +87,10 @@ typedef enum
 int gnutls_pkcs11_obj_import_url (gnutls_pkcs11_obj_t, const char *url,
                                   unsigned int flags
                                   /* GNUTLS_PKCS11_OBJ_FLAG_* */ );
-int gnutls_pkcs11_obj_export_url (gnutls_pkcs11_obj_t,
+int gnutls_pkcs11_obj_export_url (gnutls_pkcs11_obj_t obj,
                                   gnutls_pkcs11_url_type_t detailed,
                                   char **url);
-void gnutls_pkcs11_obj_deinit (gnutls_pkcs11_obj_t);
+void gnutls_pkcs11_obj_deinit (gnutls_pkcs11_obj_t obj);
 
 int gnutls_pkcs11_obj_export (gnutls_pkcs11_obj_t obj,
                               void *output_data, size_t * output_data_size);
@@ -98,8 +99,8 @@ int gnutls_pkcs11_obj_export (gnutls_pkcs11_obj_t obj,
 int gnutls_pkcs11_copy_x509_crt (const char *token_url, gnutls_x509_crt_t crt,
                                  const char *label, unsigned int flags
                                  /* GNUTLS_PKCS11_OBJ_FLAG_* */ );
-int gnutls_pkcs11_copy_x509_privkey (const char *token_url, gnutls_x509_privkey_t crt, const char *label, unsigned int key_usage        /*GNUTLS_KEY_* */
-                                     , unsigned int flags
+int gnutls_pkcs11_copy_x509_privkey (const char *token_url, gnutls_x509_privkey_t key, 
+  const char *label, unsigned int key_usage /*GNUTLS_KEY_* */, unsigned int flags
                                      /* GNUTLS_PKCS11_OBJ_FLAG_* */ );
 int gnutls_pkcs11_delete_url (const char *object_url, unsigned int flags
                               /* GNUTLS_PKCS11_OBJ_FLAG_* */ );
@@ -217,7 +218,7 @@ int gnutls_pkcs11_token_set_pin (const char *token_url, const char *oldpin, cons
 int gnutls_pkcs11_token_get_url (unsigned int seq,
                                  gnutls_pkcs11_url_type_t detailed,
                                  char **url);
-int gnutls_pkcs11_token_get_info (const char *url, gnutls_pkcs11_token_info_t,
+int gnutls_pkcs11_token_get_info (const char *url, gnutls_pkcs11_token_info_t ttype,
                                   void *output, size_t * output_size);
 
 #define GNUTLS_PKCS11_TOKEN_HW 1
@@ -240,8 +241,8 @@ gnutls_pkcs11_obj_type_t gnutls_pkcs11_obj_get_type (gnutls_pkcs11_obj_t
                                                      certificate);
 const char *gnutls_pkcs11_type_get_name (gnutls_pkcs11_obj_type_t);
 
-int gnutls_x509_crt_list_import_pkcs11 (gnutls_x509_crt_t * certs, unsigned int cert_max, gnutls_pkcs11_obj_t * const pkcs11_certs, unsigned int flags  /* must be zero */
-  );
+int gnutls_x509_crt_list_import_pkcs11 (gnutls_x509_crt_t * certs, unsigned int cert_max, 
+  gnutls_pkcs11_obj_t * const objs, unsigned int flags  /* must be zero */);
 
 
 /* private key functions...*/
@@ -249,11 +250,11 @@ int gnutls_pkcs11_privkey_init (gnutls_pkcs11_privkey_t * key);
 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);
-int gnutls_pkcs11_privkey_get_info (gnutls_pkcs11_privkey_t crt,
+int gnutls_pkcs11_privkey_get_info (gnutls_pkcs11_privkey_t pkey,
                                     gnutls_pkcs11_obj_info_t itype,
                                     void *output, size_t * output_size);
 
-int gnutls_pkcs11_privkey_import_url (gnutls_pkcs11_privkey_t key,
+int gnutls_pkcs11_privkey_import_url (gnutls_pkcs11_privkey_t pkey,
                                       const char *url, unsigned int flags);
 
 int gnutls_pkcs11_privkey_export_url (gnutls_pkcs11_privkey_t key,
index 810764bb1dbc1d73cc1d2d1255aee64591ba1f42..d19d243aaebcd7729d7c5344f5fe3241ee967e32 100644 (file)
@@ -660,8 +660,8 @@ extern "C"
                                            const gnutls_datum_t * p,
                                            const gnutls_datum_t * q,
                                            const gnutls_datum_t * u,
-                                           const gnutls_datum_t * exp1,
-                                           const gnutls_datum_t * exp2);
+                                           const gnutls_datum_t * e1,
+                                           const gnutls_datum_t * e2);
   int gnutls_x509_privkey_fix (gnutls_x509_privkey_t key);
 
   int gnutls_x509_privkey_export_dsa_raw (gnutls_x509_privkey_t key,
index bec2d167260011dbe4946e3a9d0e86b985715837..3b7bdee20a2bbe831c2cb7e7b5efc0e96ca56057 100644 (file)
@@ -496,7 +496,7 @@ gnutls_pkcs11_set_pin_function (gnutls_pkcs11_pin_callback_t fn,
 
 /**
  * gnutls_pkcs11_set_token_function:
- * @fn: The PIN callback
+ * @fn: The token callback
  * @userdata: data to be supplied to callback
  *
  * This function will set a callback function to be used when a token
@@ -918,7 +918,7 @@ cleanup:
 
 /**
  * gnutls_pkcs11_obj_init:
- * @crt: The structure to be initialized
+ * @obj: The structure to be initialized
  *
  * This function will initialize a pkcs11 certificate structure.
  *
@@ -926,10 +926,10 @@ cleanup:
  *   negative error value.
  **/
 int
-gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * crt)
+gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * obj)
 {
-  *crt = gnutls_calloc (1, sizeof (struct gnutls_pkcs11_obj_st));
-  if (*crt == NULL)
+  *obj = gnutls_calloc (1, sizeof (struct gnutls_pkcs11_obj_st));
+  if (*obj == NULL)
     {
       gnutls_assert ();
       return GNUTLS_E_MEMORY_ERROR;
@@ -953,7 +953,7 @@ gnutls_pkcs11_obj_deinit (gnutls_pkcs11_obj_t obj)
 
 /**
  * gnutls_pkcs11_obj_export:
- * @key: Holds the object
+ * @obj: Holds the object
  * @output_data: will contain a certificate PEM or DER encoded
  * @output_data_size: holds the size of output_data (and will be
  *   replaced by the actual size of parameters)
@@ -1983,7 +1983,7 @@ gnutls_pkcs11_token_get_info (const char *url,
 
 /**
  * gnutls_pkcs11_obj_export_url:
- * @crt: Holds the PKCS 11 certificate
+ * @obj: Holds the PKCS 11 certificate
  * @detailed: non zero if a detailed URL is required
  * @url: will contain an allocated url
  *
@@ -1993,12 +1993,12 @@ gnutls_pkcs11_token_get_info (const char *url,
  *   negative error value.
  **/
 int
-gnutls_pkcs11_obj_export_url (gnutls_pkcs11_obj_t cert,
+gnutls_pkcs11_obj_export_url (gnutls_pkcs11_obj_t obj,
                               gnutls_pkcs11_url_type_t detailed, char **url)
 {
   int ret;
 
-  ret = pkcs11_info_to_url (&cert->info, detailed, url);
+  ret = pkcs11_info_to_url (&obj->info, detailed, url);
   if (ret < 0)
     {
       gnutls_assert ();
index 501dce4b7c067b076bf30f6bbf46bfb88fac5fce..7e9f23c074f968bccbf48824f0ba5291181eb64d 100644 (file)
@@ -541,7 +541,7 @@ gnutls_x509_crl_get_crt_serial (gnutls_x509_crl_t crl, int indx,
  * This function will return a pointer to the DER encoded DN structure
  * and the length.
  *
- * Returns a negative value on error, and zero on success.
+ * Returns: a negative value on error, and zero on success.
  *
  * Since: 2.12.0
  **/