doc: avoid mentioning pointers when not needed

diff --git a/lib/gnutls_auth.c b/lib/gnutls_auth.c
index b7c9208ec875994e099bd27f448980c56dd59e7a..6a2e706cdfbf81f4ec51f9655b260e18b78c661f 100644 (file)
--- 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 47cc864a30f0ff8ef6dbb9b40d616ff73f9b15a1..01169dd322626106a3b49d10a60c2396fa56f78e 100644 (file)
--- 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 c4efae061b818466a8510d467d27b4f6452d7744..3c2c27117384a98a8610e6f9b4ad2acce9656362 100644 (file)
--- 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 dacc62476fbbbe91f0b2be93d1ea86bc2c5d82ad..8b98d8dbea2710d52634844a087738ce64d824c0 100644 (file)
--- 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 bb7d7abb6fe931af53c927b45f7be5808324d25a..d09be0d39f8c06e4d1b68e8e424ffdacad699626 100644 (file)
--- 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 b15db8cdf6253f18474faa56c5381694ef1617c4..d26d6fb1fcdad32c654db7dc4212644e325fb47b 100644 (file)
--- 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.
  **/