Doc fix.

diff --git a/lib/x509/crl_write.c b/lib/x509/crl_write.c
index 5ab7c1cfb4cdefb7a58c22baf74844459548ce52..6fa0e06733edf3f1496493ab8c1fca42bda04d73 100644 (file)
--- a/lib/x509/crl_write.c
+++ b/lib/x509/crl_write.c
@@ -259,7 +259,7 @@ gnutls_x509_crl_set_crt_serial (gnutls_x509_crl_t crl,
 /**
   * gnutls_x509_crl_set_crt - This function will set a revoked certificate's serial number
   * @crl: should contain a gnutls_x509_crl_t structure
-  * @crt: should contain a gnutls_x509_crt_t structure with the revoked certificate
+  * @crt: a certificate of type #gnutls_x509_crt_t with the revoked certificate
   * @revocation_time: The time this certificate was revoked
   *
   * This function will set a revoked certificate's serial number to the CRL. 

diff --git a/lib/x509/x509_write.c b/lib/x509/x509_write.c
index e0c58be914386c55a53e03bbdb11b1d6b3be2c82..2b30d43b6cc947029e939060816f09513084417e 100644 (file)
--- a/lib/x509/x509_write.c
+++ b/lib/x509/x509_write.c
@@ -42,7 +42,7 @@ static void disable_optional_stuff (gnutls_x509_crt_t cert);
 
 /**
  * gnutls_x509_crt_set_dn_by_oid - Set the Certificate request subject's distinguished name
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @oid: holds an Object Identifier in a null terminated string
  * @raw_flag: must be 0, or 1 if the data are DER encoded
  * @name: a pointer to the name
@@ -77,7 +77,7 @@ gnutls_x509_crt_set_dn_by_oid (gnutls_x509_crt_t crt, const char *oid,
 
 /**
  * gnutls_x509_crt_set_issuer_dn_by_oid - Set the Certificate request issuer's distinguished name
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @oid: holds an Object Identifier in a null terminated string
  * @raw_flag: must be 0, or 1 if the data are DER encoded
  * @name: a pointer to the name
@@ -165,7 +165,7 @@ gnutls_x509_crt_set_proxy_dn (gnutls_x509_crt_t crt, gnutls_x509_crt_t eecrt,
 
 /**
  * gnutls_x509_crt_set_version - Set the Certificate request version
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @version: holds the version number. For X.509v1 certificates must be 1.
  *
  * This function will set the version of the certificate.  This must
@@ -207,7 +207,7 @@ gnutls_x509_crt_set_version (gnutls_x509_crt_t crt, unsigned int version)
 
 /**
   * gnutls_x509_crt_set_key - This function will associate the Certificate with a key
-  * @crt: should contain a gnutls_x509_crt_t structure
+  * @crt: a certificate of type #gnutls_x509_crt_t
   * @key: holds a private key
   *
   * This function will set the public parameters from the given
@@ -246,7 +246,7 @@ gnutls_x509_crt_set_key (gnutls_x509_crt_t crt, gnutls_x509_privkey_t key)
 
 /**
  * gnutls_x509_crt_set_crq - Associate the Certificate with a request
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @crq: holds a certificate request
  *
  * This function will set the name and public parameters from the
@@ -292,7 +292,7 @@ gnutls_x509_crt_set_crq (gnutls_x509_crt_t crt, gnutls_x509_crq_t crq)
 
 /**
  * gnutls_x509_crt_set_extension_by_oid - Set an arbitrary extension
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @oid: holds an Object Identified in null terminated string
  * @buf: a pointer to a DER encoded data
  * @sizeof_buf: holds the size of @buf
@@ -338,7 +338,7 @@ gnutls_x509_crt_set_extension_by_oid (gnutls_x509_crt_t crt,
 
 /**
  * gnutls_x509_crt_set_basic_constraints - Set the basicConstraints extension
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @ca: true(1) or false(0). Depending on the Certificate authority status.
  * @pathLenConstraint: non-negative values indicate maximum length of path,
  *   and negative values indicate that the pathLenConstraints field should
@@ -389,7 +389,7 @@ gnutls_x509_crt_set_basic_constraints (gnutls_x509_crt_t crt,
 
 /**
  * gnutls_x509_crt_set_ca_status - Set the basicConstraints extension
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @ca: true(1) or false(0). Depending on the Certificate authority status.
  *
  * This function will set the basicConstraints certificate extension.
@@ -407,7 +407,7 @@ gnutls_x509_crt_set_ca_status (gnutls_x509_crt_t crt, unsigned int ca)
 
 /**
  * gnutls_x509_crt_set_key_usage - Set the keyUsage extension
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @usage: an ORed sequence of the GNUTLS_KEY_* elements.
  *
  * This function will set the keyUsage certificate extension.
@@ -453,7 +453,7 @@ gnutls_x509_crt_set_key_usage (gnutls_x509_crt_t crt, unsigned int usage)
 
 /**
  * gnutls_x509_crt_set_subject_alternative_name - Set the subject Alternative Name
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @type: is one of the gnutls_x509_subject_alt_name_t enumerations
  * @data_string: The data to be set, a zero terminated string
  *
@@ -491,7 +491,7 @@ gnutls_x509_crt_set_subject_alternative_name (gnutls_x509_crt_t crt,
 
 /**
  * gnutls_x509_crt_set_subject_alt_name - Set the subject Alternative Name
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @type: is one of the gnutls_x509_subject_alt_name_t enumerations
  * @data: The data to be set
  * @data_size: The size of data to be set
@@ -583,7 +583,7 @@ finish:
 
 /**
  * gnutls_x509_crt_set_proxy - Set the proxyCertInfo extension
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @pathLenConstraint: non-negative values indicate maximum length of path,
  *   and negative values indicate that the pathLenConstraints field should
  *   not be present.
@@ -641,7 +641,7 @@ gnutls_x509_crt_set_proxy (gnutls_x509_crt_t crt,
 
 /**
  * gnutls_x509_crt_sign2 - Sign a certificate with a key
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @issuer: is the certificate of the certificate issuer
  * @issuer_key: holds the issuer's private key
  * @dig: The message digest to use, %GNUTLS_DIG_SHA1 is a safe choice
@@ -686,7 +686,7 @@ gnutls_x509_crt_sign2 (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
 
 /**
  * gnutls_x509_crt_sign - Sign a certificate with a key
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @issuer: is the certificate of the certificate issuer
  * @issuer_key: holds the issuer's private key
  *
@@ -705,7 +705,7 @@ gnutls_x509_crt_sign (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
 
 /**
  * gnutls_x509_crt_set_activation_time - Set the Certificate's activation time
- * @cert: should contain a gnutls_x509_crt_t structure
+ * @cert: a certificate of type #gnutls_x509_crt_t
  * @act_time: The actual time
  *
  * This function will set the time this Certificate was or will be
@@ -730,7 +730,7 @@ gnutls_x509_crt_set_activation_time (gnutls_x509_crt_t cert, time_t act_time)
 
 /**
  * gnutls_x509_crt_set_expiration_time - Set the Certificate's expiration time
- * @cert: should contain a gnutls_x509_crt_t structure
+ * @cert: a certificate of type #gnutls_x509_crt_t
  * @exp_time: The actual time
  *
  * This function will set the time this Certificate will expire.
@@ -752,7 +752,7 @@ gnutls_x509_crt_set_expiration_time (gnutls_x509_crt_t cert, time_t exp_time)
 
 /**
  * gnutls_x509_crt_set_serial - Set the certificate's serial number
- * @cert: should contain a gnutls_x509_crt_t structure
+ * @cert: a certificate of type #gnutls_x509_crt_t
  * @serial: The serial number
  * @serial_size: Holds the size of the serial field.
  *
@@ -811,7 +811,7 @@ disable_optional_stuff (gnutls_x509_crt_t cert)
 
 /**
  * gnutls_x509_crt_set_crl_dist_points - Set the CRL dist points
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @type: is one of the gnutls_x509_subject_alt_name_t enumerations
  * @data_string: The data to be set
  * @reason_flags: revocation reasons
@@ -832,7 +832,7 @@ gnutls_x509_crt_set_crl_dist_points (gnutls_x509_crt_t crt,
 
 /**
  * gnutls_x509_crt_set_crl_dist_points2 - Set the CRL dist points
- * @crt: should contain a gnutls_x509_crt_t structure
+ * @crt: a certificate of type #gnutls_x509_crt_t
  * @type: is one of the gnutls_x509_subject_alt_name_t enumerations
  * @data: The data to be set
  * @data_size: The data size
@@ -905,7 +905,7 @@ gnutls_x509_crt_set_crl_dist_points2 (gnutls_x509_crt_t crt,
 
 /**
  * gnutls_x509_crt_cpy_crl_dist_points - Copy the CRL dist points
- * @dst: should contain a gnutls_x509_crt_t structure
+ * @dst: a certificate of type #gnutls_x509_crt_t
  * @src: the certificate where the dist points will be copied from
  *
  * This function will copy the CRL distribution points certificate
@@ -957,7 +957,7 @@ gnutls_x509_crt_cpy_crl_dist_points (gnutls_x509_crt_t dst,
 
 /**
  * gnutls_x509_crt_set_subject_key_id - Set the certificate's subject key id
- * @cert: should contain a gnutls_x509_crt_t structure
+ * @cert: a certificate of type #gnutls_x509_crt_t
  * @id: The key ID
  * @id_size: Holds the size of the serial field.
  *
@@ -1020,7 +1020,7 @@ gnutls_x509_crt_set_subject_key_id (gnutls_x509_crt_t cert,
 
 /**
  * gnutls_x509_crt_set_authority_key_id - Set the certificate authority's key id
- * @cert: should contain a gnutls_x509_crt_t structure
+ * @cert: a certificate of type #gnutls_x509_crt_t
  * @id: The key ID
  * @id_size: Holds the size of the serial field.
  *
@@ -1083,7 +1083,7 @@ gnutls_x509_crt_set_authority_key_id (gnutls_x509_crt_t cert,
 
 /**
  * gnutls_x509_crt_set_key_purpose_oid - Sets the Certificate's key purpose OIDs
- * @cert: should contain a gnutls_x509_crt_t structure
+ * @cert: a certificate of type #gnutls_x509_crt_t
  * @oid: a pointer to a null terminated string that holds the OID
  * @critical: Whether this extension will be critical or not
  *