]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
Doc fixes for GTK-DOC.
authorSimon Josefsson <simon@josefsson.org>
Wed, 13 May 2009 14:10:47 +0000 (16:10 +0200)
committerSimon Josefsson <simon@josefsson.org>
Wed, 13 May 2009 14:10:47 +0000 (16:10 +0200)
lib/includes/gnutls/crypto.h
lib/includes/gnutls/openpgp.h
lib/includes/gnutls/x509.h
lib/openpgp/gnutls_openpgp.c
lib/x509/dn.c
lib/x509/output.c
lib/x509/pkcs7.c
lib/x509/verify.c
lib/x509/x509.c

index 52a6b98aa0b1f058a6cb81a71ca5c95e4bf4968c..7e49cecd35160255e0aca17cdf3ce17d855ade1c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2008 Free Software Foundation
+ * Copyright (C) 2008, 2009 Free Software Foundation
  *
  * Author: Nikos Mavrogiannopoulos
  *
@@ -254,19 +254,15 @@ typedef struct gnutls_crypto_pk
   gnutls_crypto_single_digest_register2(algo, prio,                    \
                                        GNUTLS_CRYPTO_API_VERSION, st)
 
-int gnutls_crypto_single_cipher_register2 (gnutls_cipher_algorithm_t
-                                          algorithm, int priority,
-                                          int version,
-                                          gnutls_crypto_single_cipher_st *
-                                          s);
+int gnutls_crypto_single_cipher_register2 (gnutls_cipher_algorithm_t algorithm,
+                                          int priority, int version,
+                                          gnutls_crypto_single_cipher_st *s);
 int gnutls_crypto_single_mac_register2 (gnutls_mac_algorithm_t algorithm,
                                        int priority, int version,
                                        gnutls_crypto_single_mac_st * s);
-int gnutls_crypto_single_digest_register2 (gnutls_digest_algorithm_t
-                                          algorithm, int priority,
-                                          int version,
-                                          gnutls_crypto_single_digest_st *
-                                          s);
+int gnutls_crypto_single_digest_register2 (gnutls_digest_algorithm_t algorithm,
+                                          int priority, int version,
+                                          gnutls_crypto_single_digest_st *s);
 
 # define gnutls_crypto_cipher_register(prio, st)                       \
   gnutls_crypto_cipher_register2 (prio, GNUTLS_CRYPTO_API_VERSION, st)
index 800a00e315437486c5b38b7a6ee88ce4a6f0583b..56373e278a33d96dc659f019ae69fc6033c9b816 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
  *
  * Author: Nikos Mavrogiannopoulos
  *
@@ -80,9 +80,9 @@ extern "C"
   int gnutls_openpgp_crt_get_name (gnutls_openpgp_crt_t key,
                                   int idx, char *buf, size_t * sizeof_buf);
 
-    gnutls_pk_algorithm_t
-    gnutls_openpgp_crt_get_pk_algorithm (gnutls_openpgp_crt_t key,
-                                        unsigned int *bits);
+  gnutls_pk_algorithm_t
+  gnutls_openpgp_crt_get_pk_algorithm (gnutls_openpgp_crt_t key,
+                                      unsigned int *bits);
 
   int gnutls_openpgp_crt_get_version (gnutls_openpgp_crt_t key);
 
@@ -102,15 +102,15 @@ extern "C"
                                         const gnutls_openpgp_keyid_t keyid);
   int gnutls_openpgp_crt_get_subkey_revoked_status (gnutls_openpgp_crt_t key,
                                                    unsigned int idx);
-    gnutls_pk_algorithm_t
-    gnutls_openpgp_crt_get_subkey_pk_algorithm (gnutls_openpgp_crt_t key,
-                                               unsigned int idx,
-                                               unsigned int *bits);
-  time_t gnutls_openpgp_crt_get_subkey_creation_time (gnutls_openpgp_crt_t
-                                                     key, unsigned int idx);
-  time_t gnutls_openpgp_crt_get_subkey_expiration_time (gnutls_openpgp_crt_t
-                                                       key,
-                                                       unsigned int idx);
+  gnutls_pk_algorithm_t
+  gnutls_openpgp_crt_get_subkey_pk_algorithm (gnutls_openpgp_crt_t key,
+                                             unsigned int idx,
+                                             unsigned int *bits);
+  time_t gnutls_openpgp_crt_get_subkey_creation_time (gnutls_openpgp_crt_t key,
+                                                     unsigned int idx);
+  time_t
+  gnutls_openpgp_crt_get_subkey_expiration_time (gnutls_openpgp_crt_t key,
+                                                unsigned int idx);
   int gnutls_openpgp_crt_get_subkey_id (gnutls_openpgp_crt_t key,
                                        unsigned int idx,
                                        gnutls_openpgp_keyid_t keyid);
@@ -139,17 +139,17 @@ extern "C"
 
   int gnutls_openpgp_crt_get_preferred_key_id (gnutls_openpgp_crt_t key,
                                               gnutls_openpgp_keyid_t keyid);
-  int gnutls_openpgp_crt_set_preferred_key_id (gnutls_openpgp_crt_t key,
-                                              const gnutls_openpgp_keyid_t
-                                              keyid);
+  int
+  gnutls_openpgp_crt_set_preferred_key_id (gnutls_openpgp_crt_t key,
+                                          const gnutls_openpgp_keyid_t keyid);
 
 /* privkey stuff.
  */
   int gnutls_openpgp_privkey_init (gnutls_openpgp_privkey_t * key);
   void gnutls_openpgp_privkey_deinit (gnutls_openpgp_privkey_t key);
-    gnutls_pk_algorithm_t
-    gnutls_openpgp_privkey_get_pk_algorithm (gnutls_openpgp_privkey_t key,
-                                            unsigned int *bits);
+  gnutls_pk_algorithm_t
+  gnutls_openpgp_privkey_get_pk_algorithm (gnutls_openpgp_privkey_t key,
+                                          unsigned int *bits);
   int gnutls_openpgp_privkey_import (gnutls_openpgp_privkey_t key,
                                     const gnutls_datum_t * data,
                                     gnutls_openpgp_crt_fmt_t format,
@@ -160,56 +160,56 @@ extern "C"
   int gnutls_openpgp_privkey_get_fingerprint (gnutls_openpgp_privkey_t key,
                                              void *fpr, size_t * fprlen);
   int
-    gnutls_openpgp_privkey_get_subkey_fingerprint (gnutls_openpgp_privkey_t
-                                                  key, unsigned int idx,
-                                                  void *fpr,
-                                                  size_t * fprlen);
+  gnutls_openpgp_privkey_get_subkey_fingerprint (gnutls_openpgp_privkey_t key,
+                                                unsigned int idx,
+                                                void *fpr,
+                                                size_t * fprlen);
   int gnutls_openpgp_privkey_get_key_id (gnutls_openpgp_privkey_t key,
                                         gnutls_openpgp_keyid_t keyid);
   int gnutls_openpgp_privkey_get_subkey_count (gnutls_openpgp_privkey_t key);
   int gnutls_openpgp_privkey_get_subkey_idx (gnutls_openpgp_privkey_t key,
-                                            const gnutls_openpgp_keyid_t
-                                            keyid);
+                                            const gnutls_openpgp_keyid_t keyid);
 
   int
-    gnutls_openpgp_privkey_get_subkey_revoked_status (gnutls_openpgp_privkey_t
-                                                     key, unsigned int idx);
+  gnutls_openpgp_privkey_get_subkey_revoked_status (gnutls_openpgp_privkey_t key,
+                                                   unsigned int idx);
 
-  int gnutls_openpgp_privkey_get_revoked_status (gnutls_openpgp_privkey_t
-                                                key);
+  int gnutls_openpgp_privkey_get_revoked_status (gnutls_openpgp_privkey_t key);
 
-    gnutls_pk_algorithm_t
-    gnutls_openpgp_privkey_get_subkey_pk_algorithm (gnutls_openpgp_privkey_t
-                                                   key, unsigned int idx,
-                                                   unsigned int *bits);
+  gnutls_pk_algorithm_t
+  gnutls_openpgp_privkey_get_subkey_pk_algorithm (gnutls_openpgp_privkey_t key,
+                                                 unsigned int idx,
+                                                 unsigned int *bits);
 
-    time_t
-    gnutls_openpgp_privkey_get_subkey_expiration_time
-    (gnutls_openpgp_privkey_t key, unsigned int idx);
+  time_t
+  gnutls_openpgp_privkey_get_subkey_expiration_time (gnutls_openpgp_privkey_t key,
+                                                    unsigned int idx);
 
   int gnutls_openpgp_privkey_get_subkey_id (gnutls_openpgp_privkey_t key,
                                            unsigned int idx,
                                            gnutls_openpgp_keyid_t keyid);
 
-    time_t
-    gnutls_openpgp_privkey_get_subkey_creation_time (gnutls_openpgp_privkey_t
-                                                    key, unsigned int idx);
-
-  int gnutls_openpgp_privkey_export_subkey_dsa_raw (gnutls_openpgp_privkey_t
-                                                   pkey, unsigned int idx,
-                                                   gnutls_datum_t * p,
-                                                   gnutls_datum_t * q,
-                                                   gnutls_datum_t * g,
-                                                   gnutls_datum_t * y,
-                                                   gnutls_datum_t * x);
-  int gnutls_openpgp_privkey_export_subkey_rsa_raw (gnutls_openpgp_privkey_t
-                                                   pkey, unsigned int idx,
-                                                   gnutls_datum_t * m,
-                                                   gnutls_datum_t * e,
-                                                   gnutls_datum_t * d,
-                                                   gnutls_datum_t * p,
-                                                   gnutls_datum_t * q,
-                                                   gnutls_datum_t * u);
+  time_t
+  gnutls_openpgp_privkey_get_subkey_creation_time (gnutls_openpgp_privkey_t key,
+                                                  unsigned int idx);
+
+  int
+  gnutls_openpgp_privkey_export_subkey_dsa_raw (gnutls_openpgp_privkey_t pkey,
+                                               unsigned int idx,
+                                               gnutls_datum_t * p,
+                                               gnutls_datum_t * q,
+                                               gnutls_datum_t * g,
+                                               gnutls_datum_t * y,
+                                               gnutls_datum_t * x);
+  int
+  gnutls_openpgp_privkey_export_subkey_rsa_raw (gnutls_openpgp_privkey_t pkey,
+                                               unsigned int idx,
+                                               gnutls_datum_t * m,
+                                               gnutls_datum_t * e,
+                                               gnutls_datum_t * d,
+                                               gnutls_datum_t * p,
+                                               gnutls_datum_t * q,
+                                               gnutls_datum_t * u);
 
   int gnutls_openpgp_privkey_export_dsa_raw (gnutls_openpgp_privkey_t pkey,
                                             gnutls_datum_t * p,
@@ -232,15 +232,12 @@ extern "C"
                                     void *output_data,
                                     size_t * output_data_size);
 
-  int gnutls_openpgp_privkey_set_preferred_key_id (gnutls_openpgp_privkey_t
-                                                  key,
-                                                  const
-                                                  gnutls_openpgp_keyid_t
-                                                  keyid);
-  int gnutls_openpgp_privkey_get_preferred_key_id (gnutls_openpgp_privkey_t
-                                                  key,
-                                                  gnutls_openpgp_keyid_t
-                                                  keyid);
+  int
+  gnutls_openpgp_privkey_set_preferred_key_id (gnutls_openpgp_privkey_t key,
+                                              const gnutls_openpgp_keyid_t keyid);
+  int
+  gnutls_openpgp_privkey_get_preferred_key_id (gnutls_openpgp_privkey_t key,
+                                              gnutls_openpgp_keyid_t keyid);
 
   int gnutls_openpgp_crt_get_auth_subkey (gnutls_openpgp_crt_t crt,
                                          gnutls_openpgp_keyid_t keyid,
@@ -296,51 +293,52 @@ extern "C"
                                               unsigned int keyfpr_length,
                                               gnutls_datum_t * key);
 
-  void gnutls_openpgp_set_recv_key_function (gnutls_session_t session,
-                                            gnutls_openpgp_recv_key_func
-                                            func);
+  void
+  gnutls_openpgp_set_recv_key_function (gnutls_session_t session,
+                                       gnutls_openpgp_recv_key_func func);
 
 
 
 /* certificate authentication stuff.
  */
-  int gnutls_certificate_set_openpgp_key (gnutls_certificate_credentials_t
-                                         res, gnutls_openpgp_crt_t key,
+  int gnutls_certificate_set_openpgp_key (gnutls_certificate_credentials_t res,
+                                         gnutls_openpgp_crt_t key,
                                          gnutls_openpgp_privkey_t pkey);
 
   int
-    gnutls_certificate_set_openpgp_key_file (gnutls_certificate_credentials_t
-                                            res, const char *CERTFILE,
-                                            const char *KEYFILE,
-                                            gnutls_openpgp_crt_fmt_t);
-  int gnutls_certificate_set_openpgp_key_mem (gnutls_certificate_credentials_t
-                                             res,
-                                             const gnutls_datum_t * CERT,
-                                             const gnutls_datum_t * KEY,
-                                             gnutls_openpgp_crt_fmt_t);
+  gnutls_certificate_set_openpgp_key_file (gnutls_certificate_credentials_t res,
+                                          const char *certfile,
+                                          const char *keyfile,
+                                          gnutls_openpgp_crt_fmt_t);
+  int
+  gnutls_certificate_set_openpgp_key_mem (gnutls_certificate_credentials_t res,
+                                         const gnutls_datum_t * cert,
+                                         const gnutls_datum_t * key,
+                                         gnutls_openpgp_crt_fmt_t);
 
   int
-    gnutls_certificate_set_openpgp_key_file2 (gnutls_certificate_credentials_t
-                                             res, const char *CERTFILE,
-                                             const char *KEYFILE,
-                                             const char *keyid,
-                                             gnutls_openpgp_crt_fmt_t format);
+  gnutls_certificate_set_openpgp_key_file2 (gnutls_certificate_credentials_t res,
+                                           const char *certfile,
+                                           const char *keyfile,
+                                           const char *keyid,
+                                           gnutls_openpgp_crt_fmt_t format);
   int
-    gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t
-                                            res, const gnutls_datum_t * CERT,
-                                            const gnutls_datum_t * KEY,
-                                            const char *keyid,
-                                            gnutls_openpgp_crt_fmt_t format);
+  gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t res,
+                                          const gnutls_datum_t * cert,
+                                          const gnutls_datum_t * key,
+                                          const char *keyid,
+                                          gnutls_openpgp_crt_fmt_t format);
 
   int
-    gnutls_certificate_set_openpgp_keyring_mem
-    (gnutls_certificate_credentials_t c, const unsigned char *data,
-     size_t dlen, gnutls_openpgp_crt_fmt_t);
+  gnutls_certificate_set_openpgp_keyring_mem (gnutls_certificate_credentials_t c,
+                                             const unsigned char *data,
+                                             size_t dlen,
+                                             gnutls_openpgp_crt_fmt_t format);
 
   int
-    gnutls_certificate_set_openpgp_keyring_file
-    (gnutls_certificate_credentials_t c, const char *file,
-     gnutls_openpgp_crt_fmt_t);
+  gnutls_certificate_set_openpgp_keyring_file (gnutls_certificate_credentials_t c,
+                                              const char *file,
+                                              gnutls_openpgp_crt_fmt_t format);
 
 # ifdef __cplusplus
 }
index f554e476650e2b13061f2b36cc4203e646a92b94..60e97c6c1dd0c4b50cd5b69cce7b5a06964745ba 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2003, 2004, 2005, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009 Free Software Foundation
  *
  * Author: Nikos Mavrogiannopoulos
  *
@@ -269,8 +269,7 @@ extern "C"
                                                    const char *data_string);
 
   int gnutls_x509_crt_set_subject_alt_name (gnutls_x509_crt_t crt,
-                                           gnutls_x509_subject_alt_name_t
-                                           type,
+                                           gnutls_x509_subject_alt_name_t type,
                                            const void *data,
                                            unsigned int data_size,
                                            unsigned int flags);
@@ -339,7 +338,7 @@ extern "C"
   int gnutls_x509_crt_get_issuer (gnutls_x509_crt_t cert,
                                  gnutls_x509_dn_t * dn);
   int gnutls_x509_dn_get_rdn_ava (gnutls_x509_dn_t dn, int irdn,
-                                 int iava, gnutls_x509_ava_st * avast);
+                                 int iava, gnutls_x509_ava_st * ava);
 
   int gnutls_x509_dn_init (gnutls_x509_dn_t * dn);
 
@@ -402,7 +401,8 @@ extern "C"
   int gnutls_x509_crl_sign2 (gnutls_x509_crl_t crl,
                             gnutls_x509_crt_t issuer,
                             gnutls_x509_privkey_t issuer_key,
-                            gnutls_digest_algorithm_t, unsigned int flags);
+                            gnutls_digest_algorithm_t dig,
+                            unsigned int flags);
   int gnutls_x509_crl_set_this_update (gnutls_x509_crl_t crl,
                                       time_t act_time);
   int gnutls_x509_crl_set_next_update (gnutls_x509_crl_t crl,
@@ -466,7 +466,7 @@ extern "C"
   int gnutls_pkcs7_get_crl_count (gnutls_pkcs7_t pkcs7);
 
   int gnutls_pkcs7_set_crl_raw (gnutls_pkcs7_t pkcs7,
-                               const gnutls_datum_t * crt);
+                               const gnutls_datum_t * crl);
   int gnutls_pkcs7_set_crl (gnutls_pkcs7_t pkcs7, gnutls_x509_crl_t crl);
   int gnutls_pkcs7_delete_crl (gnutls_pkcs7_t pkcs7, int indx);
 
@@ -580,7 +580,8 @@ extern "C"
   int gnutls_x509_privkey_import_pkcs8 (gnutls_x509_privkey_t key,
                                        const gnutls_datum_t * data,
                                        gnutls_x509_crt_fmt_t format,
-                                       const char *pass, unsigned int flags);
+                                       const char *password,
+                                       unsigned int flags);
   int gnutls_x509_privkey_import_rsa_raw (gnutls_x509_privkey_t key,
                                          const gnutls_datum_t * m,
                                          const gnutls_datum_t * e,
@@ -694,7 +695,8 @@ extern "C"
                               gnutls_x509_privkey_t key);
   int gnutls_x509_crq_sign2 (gnutls_x509_crq_t crq,
                             gnutls_x509_privkey_t key,
-                            gnutls_digest_algorithm_t, unsigned int flags);
+                            gnutls_digest_algorithm_t dig,
+                            unsigned int flags);
   int gnutls_x509_crq_sign (gnutls_x509_crq_t crq, gnutls_x509_privkey_t key);
 
   int gnutls_x509_crq_set_challenge_password (gnutls_x509_crq_t crq,
index 23659c77224bcacf6596735542ce3f9237c467d1..ddb4baae4235b7611faed8766b355ddfa8c50eed 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
  *
  * Author: Timo Schulz, Nikos Mavrogiannopoulos
  *
@@ -456,8 +456,8 @@ gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t
  * Since: 2.4.0
  **/
 int
-gnutls_certificate_set_openpgp_key_file2 (gnutls_certificate_credentials_t
-                                         res, const char *certfile,
+gnutls_certificate_set_openpgp_key_file2 (gnutls_certificate_credentials_t res,
+                                         const char *certfile,
                                          const char *keyfile,
                                          const char *subkey_id,
                                          gnutls_openpgp_crt_fmt_t format)
@@ -552,6 +552,7 @@ gnutls_openpgp_count_key_names (const gnutls_datum_t * cert)
  * gnutls_certificate_set_openpgp_keyring_file - Sets a keyring file for OpenPGP
  * @c: A certificate credentials structure
  * @file: filename of the keyring.
+ * @format: format of keyring.
  *
  * The function is used to set keyrings that will be used internally
  * by various OpenPGP functions. For example to find a key when it
@@ -562,8 +563,8 @@ gnutls_openpgp_count_key_names (const gnutls_datum_t * cert)
  *   negative error value.
  **/
 int
-gnutls_certificate_set_openpgp_keyring_file (gnutls_certificate_credentials_t
-                                            c, const char *file,
+gnutls_certificate_set_openpgp_keyring_file (gnutls_certificate_credentials_t c,
+                                            const char *file,
                                             gnutls_openpgp_crt_fmt_t format)
 {
   gnutls_datum_t ring;
index 914fadb89f0dc47a7cb132d3266b15f3bc3ffbe3..a5fe9afec1b1045b8464c227ac0c25961d96231e 100644 (file)
@@ -1145,8 +1145,8 @@ gnutls_x509_rdn_get_by_oid (const gnutls_datum_t * idn, const char *oid,
  * gnutls_x509_rdn_get_oid - parse an RDN sequence and returns an OID.
  * @idn: should contain a DER encoded RDN sequence
  * @indx: Indicates which OID to return. Use 0 for the first one.
- * @oid: a pointer to a structure to hold the peer's name OID
- * @sizeof_oid: holds the size of @oid
+ * @buf: a pointer to a structure to hold the peer's name OID
+ * @sizeof_buf: holds the size of @buf
  *
  * This function will return the specified Object identifier, of the
  * RDN sequence.
index 28f7603efd04f0ef8d1b853d57a120ca50036e4d..e81c1fb10f4a6b2c6c76b54c45ddb8a7a33acab7 100644 (file)
@@ -1930,7 +1930,7 @@ print_crq_other (gnutls_string * str, gnutls_x509_crq_t crq)
 
 /**
  * gnutls_x509_crq_print - Pretty print PKCS 10 certificate request
- * @cert: The structure to be printed
+ * @crq: The structure to be printed
  * @format: Indicate the format to use
  * @out: Newly allocated datum with zero terminated string.
  *
index b89ce54dc03951a949e3d242b9722502bae608e2..7003a75f1fd5e30899e413acf1489da756b58951 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2003, 2004, 2005, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2008, 2009 Free Software Foundation
  *
  * Author: Nikos Mavrogiannopoulos
  *
@@ -369,7 +369,7 @@ cleanup:
 
 /**
  * gnutls_pkcs7_get_crt_count - return the number of certificates in a PKCS7 certificate set
- * @pkcs7_struct: should contain a gnutls_pkcs7_t structure
+ * @pkcs7: should contain a #gnutls_pkcs7_t structure
  *
  * This function will return the number of certifcates in the PKCS7
  * or RFC2630 certificate set.
@@ -524,7 +524,7 @@ cleanup:
 
 /**
  * gnutls_pkcs7_set_crt_raw - add a certificate in a PKCS7 certificate set
- * @pkcs7_struct: should contain a gnutls_pkcs7_t structure
+ * @pkcs7: should contain a #gnutls_pkcs7_t structure
  * @crt: the DER encoded certificate to be added
  *
  * This function will add a certificate to the PKCS7 or RFC2630
@@ -725,8 +725,8 @@ cleanup:
  */
 
 /**
- * gnutls_pkcs7_get_crl_raw - This function returns a crl in a PKCS7 crl set
- * @pkcs7_struct: should contain a gnutls_pkcs7_t structure
+ * gnutls_pkcs7_get_crl_raw - returns a crl in a PKCS7 crl set
+ * @pkcs7: should contain a #gnutls_pkcs7_t structure
  * @indx: contains the index of the crl to extract
  * @crl: the contents of the crl will be copied there (may be null)
  * @crl_size: should hold the size of the crl
@@ -803,7 +803,7 @@ cleanup:
 
 /**
  * gnutls_pkcs7_get_crl_count - returns the number of CRLs in a PKCS7 crl set
- * @pkcs7_struct: should contain a gnutls_pkcs7_t structure
+ * @pkcs7: should contain a gnutls_pkcs7_t structure
  *
  * This function will return the number of certifcates in the PKCS7
  * or RFC2630 crl set.
@@ -847,7 +847,7 @@ gnutls_pkcs7_get_crl_count (gnutls_pkcs7_t pkcs7)
 
 /**
  * gnutls_pkcs7_set_crl_raw - add a crl in a PKCS7 crl set
- * @pkcs7_struct: should contain #a gnutls_pkcs7_t structure
+ * @pkcs7: should contain a #gnutls_pkcs7_t structure
  * @crl: the DER encoded crl to be added
  *
  * This function will add a crl to the PKCS7 or RFC2630 crl set.
@@ -930,7 +930,7 @@ cleanup:
 
 /**
  * gnutls_pkcs7_set_crl - add a parsed crl in a PKCS7 crl set
- * @pkcs7_struct: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: should contain a #gnutls_pkcs7_t structure
  * @crl: the DER encoded crl to be added
  *
  * This function will add a parsed CRL to the PKCS7 or RFC2630 crl
index 2f90ff63ec65e2a42897b70ca3677942729d1393..21b42c346296d42bb7b397029413c77d664b5cfa 100644 (file)
@@ -1012,17 +1012,17 @@ gnutls_x509_crt_verify (gnutls_x509_crt_t cert,
 #ifdef ENABLE_PKI
 
 /**
 * gnutls_x509_crl_check_issuer - This function checks if the CRL given has the given issuer
 * @crl: is the CRL to be checked
 * @issuer: is the certificate of a possible issuer
 *
-  * This function will check if the given CRL was issued by the
-  * given issuer certificate. It will return true (1) if the given CRL was issued
 * by the given issuer, and false (0) if not.
 *
-  * A negative value is returned in case of an error.
-  *
 **/
* gnutls_x509_crl_check_issuer - checks if CRL has given issuer
+ * @crl: is the CRL to be checked
+ * @issuer: is the certificate of a possible issuer
+ *
+ * This function will check if the given CRL was issued by the given
+ * issuer certificate.  It will return true (1) if the given CRL was
* issued by the given issuer, and false (0) if not.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ *   negative error value.
+ **/
 int
 gnutls_x509_crl_check_issuer (gnutls_x509_crl_t cert,
                              gnutls_x509_crt_t issuer)
@@ -1031,21 +1031,20 @@ gnutls_x509_crl_check_issuer (gnutls_x509_crl_t cert,
 }
 
 /**
-  * gnutls_x509_crl_verify - This function verifies the given crl against a given trusted one
-  * @crl: is the crl to be verified
-  * @CA_list: is a certificate list that is considered to be trusted one
-  * @CA_list_length: holds the number of CA certificates in CA_list
-  * @flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
-  * @verify: will hold the crl verification output.
-  *
-  * This function will try to verify the given crl and return its status.
-  * See gnutls_x509_crt_list_verify() for a detailed description of
-  * return values.
-  *
-  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
-  *   negative error value.and a negative value in case of an error.
-  *
-  **/
+ * gnutls_x509_crl_verify - This function verifies the given crl against a given trusted one
+ * @crl: is the crl to be verified
+ * @CA_list: is a certificate list that is considered to be trusted one
+ * @CA_list_length: holds the number of CA certificates in CA_list
+ * @flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
+ * @verify: will hold the crl verification output.
+ *
+ * This function will try to verify the given crl and return its status.
+ * See gnutls_x509_crt_list_verify() for a detailed description of
+ * return values.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ *   negative error value.
+ **/
 int
 gnutls_x509_crl_verify (gnutls_x509_crl_t crl,
                        const gnutls_x509_crt_t * CA_list,
index e837242df06f768f1e91baaf889e3540a77215e6..d463a7bc6769492e0b2bd80e9eebffd078946f71 100644 (file)
@@ -760,21 +760,20 @@ gnutls_x509_crt_get_subject_key_id (gnutls_x509_crt_t cert, void *ret,
 }
 
 /**
-  * gnutls_x509_crt_get_authority_key_id - This function returns the certificate authority's identifier
-  * @cert: should contain a #gnutls_x509_crt_t structure
-  * @result: The place where the identifier will be copied
-  * @result_size: Holds the size of the result field.
-  * @critical: will be non zero if the extension is marked as critical (may be null)
-  *
-  * This function will return the X.509v3 certificate authority's key identifier.
-  * This is obtained by the X.509 Authority Key identifier extension
-  * field (2.5.29.35). Note that this function only returns the keyIdentifier
-  * field of the extension.
-  *
-  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
-  *   negative error value.and a negative value in case of an error.
-  *
-  **/
+ * gnutls_x509_crt_get_authority_key_id - This function returns the certificate authority's identifier
+ * @cert: should contain a #gnutls_x509_crt_t structure
+ * @ret: The place where the identifier will be copied
+ * @ret_size: Holds the size of the result field.
+ * @critical: will be non zero if the extension is marked as critical (may be null)
+ *
+ * This function will return the X.509v3 certificate authority's key
+ * identifier.  This is obtained by the X.509 Authority Key
+ * identifier extension field (2.5.29.35). Note that this function
+ * only returns the keyIdentifier field of the extension.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ *   negative error value.and a negative value in case of an error.
+ **/
 int
 gnutls_x509_crt_get_authority_key_id (gnutls_x509_crt_t cert, void *ret,
                                      size_t * ret_size,
@@ -1334,10 +1333,9 @@ gnutls_x509_crt_get_basic_constraints (gnutls_x509_crt_t cert,
  * Use gnutls_x509_crt_get_basic_constraints() if you want to read the
  * pathLenConstraint field too.
  *
- * A negative value may be returned in case of parsing error.
+ * Returns: A negative value may be returned in case of parsing error.
  * If the certificate does not contain the basicConstraints extension
- * GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
- *
+ * %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
  **/
 int
 gnutls_x509_crt_get_ca_status (gnutls_x509_crt_t cert, unsigned int *critical)