summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2015-03-20 14:04:26 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2015-03-20 14:04:26 +0100
commitd5f333c3159004625c3ebcc4edaf1dbd2bc6655c (patch)
treedf3995c3eb12c4f275adfa70041d5960e835865f /lib
parent47a0d7fbeb7ea1b9b49b102c5223496a42f95122 (diff)
downloadgnutls-d5f333c3159004625c3ebcc4edaf1dbd2bc6655c.tar.gz
doc: avoid mentioning pointers when not needed
Diffstat (limited to 'lib')
-rw-r--r--lib/gnutls_auth.c4
-rw-r--r--lib/gnutls_state.c4
-rw-r--r--lib/pkcs11.c2
-rw-r--r--lib/pkcs11_privkey.c2
-rw-r--r--lib/x509/crq.c8
-rw-r--r--lib/x509/pkcs7.c2
6 files changed, 11 insertions, 11 deletions
diff --git a/lib/gnutls_auth.c b/lib/gnutls_auth.c
index b7c9208ec8..6a2e706cdf 100644
--- a/lib/gnutls_auth.c
+++ b/lib/gnutls_auth.c
@@ -63,7 +63,7 @@ void gnutls_credentials_clear(gnutls_session_t session)
* gnutls_credentials_set:
* @session: is a #gnutls_session_t type.
* @type: is the type of the credentials
- * @cred: is a pointer to a structure.
+ * @cred: the credentials to set
*
* Sets the needed credentials for the specified type. Eg username,
* password - or public and private keys etc. The @cred parameter is
@@ -144,7 +144,7 @@ gnutls_credentials_set(gnutls_session_t session,
* gnutls_credentials_get:
* @session: is a #gnutls_session_t type.
* @type: is the type of the credentials to return
- * @cred: will contain the pointer to the credentials structure.
+ * @cred: will contain the credentials.
*
* Returns the previously provided credentials structures.
*
diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c
index 47cc864a30..01169dd322 100644
--- a/lib/gnutls_state.c
+++ b/lib/gnutls_state.c
@@ -670,7 +670,7 @@ _gnutls_dh_set_group(gnutls_session_t session, bigint_t gen,
#ifdef ENABLE_OPENPGP
/**
* gnutls_openpgp_send_cert:
- * @session: is a pointer to a #gnutls_session_t type.
+ * @session: a #gnutls_session_t type.
* @status: is one of GNUTLS_OPENPGP_CERT, or GNUTLS_OPENPGP_CERT_FINGERPRINT
*
* This function will order gnutls to send the key fingerprint
@@ -688,7 +688,7 @@ gnutls_openpgp_send_cert(gnutls_session_t session,
/**
* gnutls_certificate_send_x509_rdn_sequence:
- * @session: is a pointer to a #gnutls_session_t type.
+ * @session: a #gnutls_session_t type.
* @status: is 0 or 1
*
* If status is non zero, this function will order gnutls not to send
diff --git a/lib/pkcs11.c b/lib/pkcs11.c
index c4efae061b..3c2c271173 100644
--- a/lib/pkcs11.c
+++ b/lib/pkcs11.c
@@ -1009,7 +1009,7 @@ gnutls_pkcs11_obj_set_pin_function(gnutls_pkcs11_obj_t obj,
/**
* gnutls_pkcs11_obj_deinit:
- * @obj: A pointer to the type to be initialized
+ * @obj: The type to be deinitialized
*
* This function will deinitialize a certificate structure.
*
diff --git a/lib/pkcs11_privkey.c b/lib/pkcs11_privkey.c
index dacc62476f..8b98d8dbea 100644
--- a/lib/pkcs11_privkey.c
+++ b/lib/pkcs11_privkey.c
@@ -125,7 +125,7 @@ gnutls_pkcs11_privkey_cpy(gnutls_pkcs11_privkey_t dst,
/**
* gnutls_pkcs11_privkey_deinit:
- * @key: A pointer to the type to be initialized
+ * @key: the key to be deinitialized
*
* This function will deinitialize a private key structure.
**/
diff --git a/lib/x509/crq.c b/lib/x509/crq.c
index bb7d7abb6f..d09be0d39f 100644
--- a/lib/x509/crq.c
+++ b/lib/x509/crq.c
@@ -71,7 +71,7 @@ int gnutls_x509_crq_init(gnutls_x509_crq_t * crq)
/**
* gnutls_x509_crq_deinit:
- * @crq: A pointer to the type to be initialized
+ * @crq: the type to be deinitialized
*
* This function will deinitialize a PKCS#10 certificate request
* structure.
@@ -1352,7 +1352,7 @@ gnutls_x509_crq_get_attribute_data(gnutls_x509_crq_t crq, int indx,
* gnutls_x509_crq_get_extension_info:
* @crq: should contain a #gnutls_x509_crq_t type
* @indx: Specifies which extension number to get. Use (0) to get the first one.
- * @oid: a pointer to a structure to hold the OID
+ * @oid: a pointer to store the OID
* @sizeof_oid: initially holds the maximum size of @oid, on return
* holds actual size of @oid.
* @critical: output variable with critical flag, may be NULL.
@@ -2213,7 +2213,7 @@ gnutls_x509_crq_set_key_usage(gnutls_x509_crq_t crq, unsigned int usage)
* gnutls_x509_crq_get_key_purpose_oid:
* @crq: should contain a #gnutls_x509_crq_t type
* @indx: This specifies which OID to return, use (0) to get the first one
- * @oid: a pointer to a buffer to hold the OID (may be %NULL)
+ * @oid: a pointer to store the OID (may be %NULL)
* @sizeof_oid: initially holds the size of @oid
* @critical: output variable with critical flag, may be %NULL.
*
@@ -2317,7 +2317,7 @@ gnutls_x509_crq_get_key_purpose_oid(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_set_key_purpose_oid:
* @crq: a certificate of type #gnutls_x509_crq_t
- * @oid: a pointer to a (0)-terminated string that holds the OID
+ * @oid: a pointer to a null-terminated string that holds the OID
* @critical: Whether this extension will be critical or not
*
* This function will set the key purpose OIDs of the Certificate.
diff --git a/lib/x509/pkcs7.c b/lib/x509/pkcs7.c
index b15db8cdf6..d26d6fb1fc 100644
--- a/lib/x509/pkcs7.c
+++ b/lib/x509/pkcs7.c
@@ -171,7 +171,7 @@ int gnutls_pkcs7_init(gnutls_pkcs7_t * pkcs7)
/**
* gnutls_pkcs7_deinit:
- * @pkcs7: A pointer to the type to be initialized
+ * @pkcs7: the type to be deinitialized
*
* This function will deinitialize a PKCS7 type.
**/