summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2015-03-20 13:22:43 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2015-03-20 13:45:51 +0100
commitade31777a9a5c493eb872c00fdb46eff6a5214c8 (patch)
treef2125694f8c6d102299494fe1995d7d0d1f71e91
parentf2bef2d116e5142dea07d11727044abaaf9bb3ce (diff)
downloadgnutls-ade31777a9a5c493eb872c00fdb46eff6a5214c8.tar.gz
doc: avoid using structure for opaque types
-rw-r--r--lib/algorithms/ciphersuites.c2
-rw-r--r--lib/crypto-api.c44
-rw-r--r--lib/ext/alpn.c4
-rw-r--r--lib/ext/etm.c2
-rw-r--r--lib/ext/ext_master_secret.c2
-rw-r--r--lib/ext/heartbeat.c12
-rw-r--r--lib/ext/max_record.c4
-rw-r--r--lib/ext/safe_renegotiation.c2
-rw-r--r--lib/ext/server_name.c4
-rw-r--r--lib/ext/session_ticket.c4
-rw-r--r--lib/ext/signature.c6
-rw-r--r--lib/ext/srtp.c12
-rw-r--r--lib/ext/status_request.c6
-rw-r--r--lib/gnutls_alert.c6
-rw-r--r--lib/gnutls_anon_cred.c14
-rw-r--r--lib/gnutls_auth.c14
-rw-r--r--lib/gnutls_buffers.c4
-rw-r--r--lib/gnutls_cert.c22
-rw-r--r--lib/gnutls_db.c18
-rw-r--r--lib/gnutls_dh.c22
-rw-r--r--lib/gnutls_dtls.c14
-rw-r--r--lib/gnutls_handshake.c12
-rw-r--r--lib/gnutls_pcert.c4
-rw-r--r--lib/gnutls_priority.c28
-rw-r--r--lib/gnutls_privkey.c38
-rw-r--r--lib/gnutls_privkey_raw.c2
-rw-r--r--lib/gnutls_psk.c28
-rw-r--r--lib/gnutls_pubkey.c36
-rw-r--r--lib/gnutls_range.c6
-rw-r--r--lib/gnutls_record.c40
-rw-r--r--lib/gnutls_session.c12
-rw-r--r--lib/gnutls_session_pack.c2
-rw-r--r--lib/gnutls_srp.c24
-rw-r--r--lib/gnutls_state.c64
-rw-r--r--lib/gnutls_ui.c20
-rw-r--r--lib/gnutls_x509.c68
-rw-r--r--lib/openpgp/extras.c6
-rw-r--r--lib/openpgp/gnutls_openpgp.c12
-rw-r--r--lib/openpgp/pgp.c12
-rw-r--r--lib/openpgp/privkey.c6
-rw-r--r--lib/pkcs11.c24
-rw-r--r--lib/pkcs11_privkey.c12
-rw-r--r--lib/pkcs11x.c2
-rw-r--r--lib/system-keys-win.c2
-rw-r--r--lib/system_override.c12
-rw-r--r--lib/tpm.c6
-rw-r--r--lib/verify-tofu.c2
-rw-r--r--lib/x509/crl.c64
-rw-r--r--lib/x509/crl_write.c16
-rw-r--r--lib/x509/crq.c74
-rw-r--r--lib/x509/dn.c4
-rw-r--r--lib/x509/extensions.c4
-rw-r--r--lib/x509/hostname-verify.c4
-rw-r--r--lib/x509/name_constraints.c32
-rw-r--r--lib/x509/ocsp.c62
-rw-r--r--lib/x509/ocsp_output.c4
-rw-r--r--lib/x509/output.c10
-rw-r--r--lib/x509/pkcs12.c28
-rw-r--r--lib/x509/pkcs12_bag.c4
-rw-r--r--lib/x509/pkcs7.c32
-rw-r--r--lib/x509/privkey.c44
-rw-r--r--lib/x509/privkey_openssl.c2
-rw-r--r--lib/x509/privkey_pkcs8.c2
-rw-r--r--lib/x509/verify-high.c24
-rw-r--r--lib/x509/verify-high2.c10
-rw-r--r--lib/x509/x509.c106
-rw-r--r--lib/x509/x509_ext.c155
-rw-r--r--lib/x509/x509_write.c6
68 files changed, 692 insertions, 693 deletions
diff --git a/lib/algorithms/ciphersuites.c b/lib/algorithms/ciphersuites.c
index 5cf729a784..bfd93e5f80 100644
--- a/lib/algorithms/ciphersuites.c
+++ b/lib/algorithms/ciphersuites.c
@@ -1529,7 +1529,7 @@ _gnutls_supported_ciphersuites(gnutls_session_t session,
/**
* gnutls_priority_get_cipher_suite:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @idx: is an index number.
* @sidx: internal index of cipher suite to get information about.
*
diff --git a/lib/crypto-api.c b/lib/crypto-api.c
index 2292eff690..554ca29ac2 100644
--- a/lib/crypto-api.c
+++ b/lib/crypto-api.c
@@ -37,7 +37,7 @@ typedef struct api_cipher_hd_st {
/**
* gnutls_cipher_init:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @cipher: the encryption algorithm to use
* @key: The key to be used for encryption
* @iv: The IV to use (if not applicable set NULL)
@@ -84,7 +84,7 @@ gnutls_cipher_init(gnutls_cipher_hd_t * handle,
/**
* gnutls_cipher_tag:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @tag: will hold the tag
* @tag_size: The length of the tag to return
*
@@ -111,7 +111,7 @@ gnutls_cipher_tag(gnutls_cipher_hd_t handle, void *tag, size_t tag_size)
/**
* gnutls_cipher_add_auth:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ptext: the data to be authenticated
* @ptext_size: The length of the data
*
@@ -140,7 +140,7 @@ gnutls_cipher_add_auth(gnutls_cipher_hd_t handle, const void *ptext,
/**
* gnutls_cipher_set_iv:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @iv: the IV to set
* @ivlen: The length of the IV
*
@@ -162,7 +162,7 @@ gnutls_cipher_set_iv(gnutls_cipher_hd_t handle, void *iv, size_t ivlen)
/**
* gnutls_cipher_encrypt:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ptext: the data to encrypt
* @ptext_len: The length of data to encrypt
*
@@ -184,7 +184,7 @@ gnutls_cipher_encrypt(gnutls_cipher_hd_t handle, void *ptext,
/**
* gnutls_cipher_decrypt:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ctext: the data to decrypt
* @ctext_len: The length of data to decrypt
*
@@ -214,7 +214,7 @@ gnutls_cipher_decrypt(gnutls_cipher_hd_t handle, void *ctext,
/**
* gnutls_cipher_encrypt2:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ptext: the data to encrypt
* @ptextlen: The length of data to encrypt
* @ctext: the encrypted data
@@ -240,7 +240,7 @@ gnutls_cipher_encrypt2(gnutls_cipher_hd_t handle, const void *ptext,
/**
* gnutls_cipher_decrypt2:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ctext: the data to decrypt
* @ctext_len: The length of data to decrypt
* @ptext: the decrypted data
@@ -274,7 +274,7 @@ gnutls_cipher_decrypt2(gnutls_cipher_hd_t handle, const void *ctext,
/**
* gnutls_cipher_deinit:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
*
* This function will deinitialize all resources occupied by the given
* encryption context.
@@ -296,7 +296,7 @@ void gnutls_cipher_deinit(gnutls_cipher_hd_t handle)
/**
* gnutls_hmac_init:
- * @dig: is a #gnutls_hmac_hd_t structure.
+ * @dig: is a #gnutls_hmac_hd_t type.
* @algorithm: the HMAC algorithm to use
* @key: The key to be used for encryption
* @keylen: The length of the key
@@ -340,7 +340,7 @@ gnutls_hmac_init(gnutls_hmac_hd_t * dig,
/**
* gnutls_hmac_set_nonce:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @nonce: the data to set as nonce
* @nonce_len: The length of data
*
@@ -357,7 +357,7 @@ gnutls_hmac_set_nonce(gnutls_hmac_hd_t handle, const void *nonce,
/**
* gnutls_hmac:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ptext: the data to hash
* @ptext_len: The length of data to hash
*
@@ -375,7 +375,7 @@ int gnutls_hmac(gnutls_hmac_hd_t handle, const void *ptext, size_t ptext_len)
/**
* gnutls_hmac_output:
- * @handle: is a #gnutls_hmac_hd_t structure.
+ * @handle: is a #gnutls_hmac_hd_t type.
* @digest: is the output value of the MAC
*
* This function will output the current MAC value
@@ -390,7 +390,7 @@ void gnutls_hmac_output(gnutls_hmac_hd_t handle, void *digest)
/**
* gnutls_hmac_deinit:
- * @handle: is a #gnutls_hmac_hd_t structure.
+ * @handle: is a #gnutls_hmac_hd_t type.
* @digest: is the output value of the MAC
*
* This function will deinitialize all resources occupied by
@@ -449,7 +449,7 @@ gnutls_hmac_fast(gnutls_mac_algorithm_t algorithm,
/**
* gnutls_hash_init:
- * @dig: is a #gnutls_hash_hd_t structure.
+ * @dig: is a #gnutls_hash_hd_t type.
* @algorithm: the hash algorithm to use
*
* This function will initialize an context that can be used to
@@ -487,7 +487,7 @@ gnutls_hash_init(gnutls_hash_hd_t * dig,
/**
* gnutls_hash:
- * @handle: is a #gnutls_cipher_hd_t structure.
+ * @handle: is a #gnutls_cipher_hd_t type.
* @ptext: the data to hash
* @ptext_len: The length of data to hash
*
@@ -505,7 +505,7 @@ int gnutls_hash(gnutls_hash_hd_t handle, const void *ptext, size_t ptext_len)
/**
* gnutls_hash_output:
- * @handle: is a #gnutls_hash_hd_t structure.
+ * @handle: is a #gnutls_hash_hd_t type.
* @digest: is the output value of the hash
*
* This function will output the current hash value
@@ -520,7 +520,7 @@ void gnutls_hash_output(gnutls_hash_hd_t handle, void *digest)
/**
* gnutls_hash_deinit:
- * @handle: is a #gnutls_hash_hd_t structure.
+ * @handle: is a #gnutls_hash_hd_t type.
* @digest: is the output value of the hash
*
* This function will deinitialize all resources occupied by
@@ -621,7 +621,7 @@ typedef struct api_aead_cipher_hd_st {
/**
* gnutls_aead_cipher_init:
- * @handle: is a #gnutls_aead_cipher_hd_t structure.
+ * @handle: is a #gnutls_aead_cipher_hd_t type.
* @cipher: the authenticated-encryption algorithm to use
* @key: The key to be used for encryption
*
@@ -660,7 +660,7 @@ int gnutls_aead_cipher_init(gnutls_aead_cipher_hd_t * handle,
/**
* gnutls_aead_cipher_decrypt:
- * @handle: is a #gnutls_aead_cipher_hd_t structure.
+ * @handle: is a #gnutls_aead_cipher_hd_t type.
* @nonce: the nonce to set
* @nonce_len: The length of the nonce
* @auth: the data to be authenticated
@@ -717,7 +717,7 @@ gnutls_aead_cipher_decrypt(gnutls_aead_cipher_hd_t handle,
/**
* gnutls_aead_cipher_encrypt:
- * @handle: is a #gnutls_aead_cipher_hd_t structure.
+ * @handle: is a #gnutls_aead_cipher_hd_t type.
* @nonce: the nonce to set
* @nonce_len: The length of the nonce
* @auth: the data to be authenticated
@@ -773,7 +773,7 @@ gnutls_aead_cipher_encrypt(gnutls_aead_cipher_hd_t handle,
/**
* gnutls_aead_cipher_deinit:
- * @handle: is a #gnutls_aead_cipher_hd_t structure.
+ * @handle: is a #gnutls_aead_cipher_hd_t type.
*
* This function will deinitialize all resources occupied by the given
* authenticated-encryption context.
diff --git a/lib/ext/alpn.c b/lib/ext/alpn.c
index 1b33dcbd60..9fc946582e 100644
--- a/lib/ext/alpn.c
+++ b/lib/ext/alpn.c
@@ -196,7 +196,7 @@ _gnutls_alpn_send_params(gnutls_session_t session,
/**
* gnutls_alpn_get_selected_protocol:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @protocol: will hold the protocol name
*
* This function allows you to get the negotiated protocol name. The
@@ -239,7 +239,7 @@ gnutls_alpn_get_selected_protocol(gnutls_session_t session,
/**
* gnutls_alpn_set_protocols:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @protocols: is the protocol names to add.
* @protocols_size: the number of protocols to add.
* @flags: zero or %GNUTLS_ALPN_*
diff --git a/lib/ext/etm.c b/lib/ext/etm.c
index 9e67766a11..f3a90ee1a9 100644
--- a/lib/ext/etm.c
+++ b/lib/ext/etm.c
@@ -124,7 +124,7 @@ _gnutls_ext_etm_send_params(gnutls_session_t session,
/**
* gnutls_session_etm_status:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get the status of the encrypt-then-mac extension negotiation.
* This is in accordance to rfc7366
diff --git a/lib/ext/ext_master_secret.c b/lib/ext/ext_master_secret.c
index ed2f9b25c5..0d90347845 100644
--- a/lib/ext/ext_master_secret.c
+++ b/lib/ext/ext_master_secret.c
@@ -114,7 +114,7 @@ _gnutls_ext_master_secret_send_params(gnutls_session_t session,
/**
* gnutls_session_ext_master_secret_status:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get the status of the extended master secret extension negotiation.
* This is in accordance to draft-ietf-tls-session-hash-01
diff --git a/lib/ext/heartbeat.c b/lib/ext/heartbeat.c
index d73183c5bd..f847a53f96 100644
--- a/lib/ext/heartbeat.c
+++ b/lib/ext/heartbeat.c
@@ -37,7 +37,7 @@
#ifdef ENABLE_HEARTBEAT
/**
* gnutls_heartbeat_enable:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @type: one of the GNUTLS_HB_* flags
*
* If this function is called with the %GNUTLS_HB_PEER_ALLOWED_TO_SEND
@@ -63,7 +63,7 @@ void gnutls_heartbeat_enable(gnutls_session_t session, unsigned int type)
/**
* gnutls_heartbeat_allowed:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @type: one of %GNUTLS_HB_LOCAL_ALLOWED_TO_SEND and %GNUTLS_HB_PEER_ALLOWED_TO_SEND
*
* This function will check whether heartbeats are allowed
@@ -139,7 +139,7 @@ heartbeat_send_data(gnutls_session_t session, const void *data,
/**
* gnutls_heartbeat_ping:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data_size: is the length of the ping payload.
* @max_tries: if flags is %GNUTLS_HEARTBEAT_WAIT then this sets the number of retransmissions. Use zero for indefinite (until timeout).
* @flags: if %GNUTLS_HEARTBEAT_WAIT then wait for pong or timeout instead of returning immediately.
@@ -272,7 +272,7 @@ gnutls_heartbeat_ping(gnutls_session_t session, size_t data_size,
/**
* gnutls_heartbeat_pong:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @flags: should be zero
*
* This function replies to a ping by sending a pong to the peer.
@@ -385,7 +385,7 @@ int _gnutls_heartbeat_handle(gnutls_session_t session, mbuffer_st * bufel)
/**
* gnutls_heartbeat_get_timeout:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return the milliseconds remaining
* for a retransmission of the previously sent ping
@@ -413,7 +413,7 @@ unsigned int gnutls_heartbeat_get_timeout(gnutls_session_t session)
/**
* gnutls_heartbeat_set_timeouts:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @retrans_timeout: The time at which a retransmission will occur in milliseconds
* @total_timeout: The time at which the connection will be aborted, in milliseconds.
*
diff --git a/lib/ext/max_record.c b/lib/ext/max_record.c
index 166e289e4a..cd636ea2ef 100644
--- a/lib/ext/max_record.c
+++ b/lib/ext/max_record.c
@@ -248,7 +248,7 @@ static int _gnutls_mre_record2num(uint16_t record_size)
/**
* gnutls_record_get_max_size:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get the record size. The maximum record size is negotiated by the
* client after the first handshake message.
@@ -266,7 +266,7 @@ size_t gnutls_record_get_max_size(gnutls_session_t session)
/**
* gnutls_record_set_max_size:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @size: is the new size
*
* This function sets the maximum record packet size in this
diff --git a/lib/ext/safe_renegotiation.c b/lib/ext/safe_renegotiation.c
index 91f78d496b..30049360ff 100644
--- a/lib/ext/safe_renegotiation.c
+++ b/lib/ext/safe_renegotiation.c
@@ -412,7 +412,7 @@ static void _gnutls_sr_deinit_data(extension_priv_data_t priv)
/**
* gnutls_safe_renegotiation_status:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Can be used to check whether safe renegotiation is being used
* in the current session.
diff --git a/lib/ext/server_name.c b/lib/ext/server_name.c
index 902c3e3761..43550688c9 100644
--- a/lib/ext/server_name.c
+++ b/lib/ext/server_name.c
@@ -253,7 +253,7 @@ _gnutls_server_name_send_params(gnutls_session_t session,
/**
* gnutls_server_name_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data: will hold the data
* @data_length: will hold the data length. Must hold the maximum size of data.
* @type: will hold the server name indicator type
@@ -350,7 +350,7 @@ gnutls_server_name_get(gnutls_session_t session, void *data,
/**
* gnutls_server_name_set:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @type: specifies the indicator type
* @name: is a string that contains the server name.
* @name_length: holds the length of name
diff --git a/lib/ext/session_ticket.c b/lib/ext/session_ticket.c
index 8a65ce6f4a..585544b4eb 100644
--- a/lib/ext/session_ticket.c
+++ b/lib/ext/session_ticket.c
@@ -450,7 +450,7 @@ int gnutls_session_ticket_key_generate(gnutls_datum_t * key)
/**
* gnutls_session_ticket_enable_client:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Request that the client should attempt session resumption using
* SessionTicket.
@@ -487,7 +487,7 @@ int gnutls_session_ticket_enable_client(gnutls_session_t session)
/**
* gnutls_session_ticket_enable_server:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @key: key to encrypt session parameters.
*
* Request that the server should attempt session resumption using
diff --git a/lib/ext/signature.c b/lib/ext/signature.c
index bbdc22bc96..7150b8d7d3 100644
--- a/lib/ext/signature.c
+++ b/lib/ext/signature.c
@@ -401,7 +401,7 @@ signature_algorithms_unpack(gnutls_buffer_st * ps,
/**
* gnutls_sign_algorithm_get_requested:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @indx: is an index of the signature algorithm to return
* @algo: the returned certificate type will be stored there
*
@@ -457,7 +457,7 @@ gnutls_sign_algorithm_get_requested(gnutls_session_t session,
/**
* gnutls_sign_algorithm_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns the signature algorithm that is (or will be) used in this
* session by the server to sign data.
@@ -473,7 +473,7 @@ int gnutls_sign_algorithm_get(gnutls_session_t session)
/**
* gnutls_sign_algorithm_get_client:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns the signature algorithm that is (or will be) used in this
* session by the client to sign data.
diff --git a/lib/ext/srtp.c b/lib/ext/srtp.c
index 1283f6d459..23bdc54ca0 100644
--- a/lib/ext/srtp.c
+++ b/lib/ext/srtp.c
@@ -292,7 +292,7 @@ _gnutls_srtp_send_params(gnutls_session_t session,
/**
* gnutls_srtp_get_selected_profile:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @profile: will hold the profile
*
* This function allows you to get the negotiated SRTP profile.
@@ -331,7 +331,7 @@ gnutls_srtp_get_selected_profile(gnutls_session_t session,
/**
* gnutls_srtp_get_mki:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @mki: will hold the MKI
*
* This function exports the negotiated Master Key Identifier,
@@ -372,7 +372,7 @@ int gnutls_srtp_get_mki(gnutls_session_t session, gnutls_datum_t * mki)
/**
* gnutls_srtp_set_mki:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @mki: holds the MKI
*
* This function sets the Master Key Identifier, to be
@@ -416,7 +416,7 @@ gnutls_srtp_set_mki(gnutls_session_t session, const gnutls_datum_t * mki)
/**
* gnutls_srtp_set_profile:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @profile: is the profile id to add.
*
* This function is to be used by both clients and servers, to declare
@@ -459,7 +459,7 @@ gnutls_srtp_set_profile(gnutls_session_t session,
/**
* gnutls_srtp_set_profile_direct:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @profiles: is a string that contains the supported SRTP profiles,
* separated by colons.
* @err_pos: In case of an error this will have the position in the string the error occured, may be NULL.
@@ -526,7 +526,7 @@ gnutls_srtp_set_profile_direct(gnutls_session_t session,
/**
* gnutls_srtp_get_keys:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @key_material: Space to hold the generated key material
* @key_material_size: The maximum size of the key material
* @client_key: The master client write key, pointing inside the key material
diff --git a/lib/ext/status_request.c b/lib/ext/status_request.c
index 571c4f94a3..4209f42ea0 100644
--- a/lib/ext/status_request.c
+++ b/lib/ext/status_request.c
@@ -296,7 +296,7 @@ _gnutls_status_request_recv_params(gnutls_session_t session,
/**
* gnutls_ocsp_status_request_enable_client:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @responder_id: array with #gnutls_datum_t with DER data of responder id
* @responder_id_size: number of members in @responder_id array
* @extensions: a #gnutls_datum_t with DER encoded OCSP extensions
@@ -344,7 +344,7 @@ gnutls_ocsp_status_request_enable_client(gnutls_session_t session,
/**
* gnutls_ocsp_status_request_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @response: a #gnutls_datum_t with DER encoded OCSP response
*
* This function returns the OCSP status response received
@@ -389,7 +389,7 @@ gnutls_ocsp_status_request_get(gnutls_session_t session,
/**
* gnutls_certificate_set_ocsp_status_request_function:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
* @ocsp_func: function pointer to OCSP status request callback.
* @ptr: opaque pointer passed to callback function
*
diff --git a/lib/gnutls_alert.c b/lib/gnutls_alert.c
index 66270dc18a..49c768812c 100644
--- a/lib/gnutls_alert.c
+++ b/lib/gnutls_alert.c
@@ -130,7 +130,7 @@ const char *gnutls_alert_get_strname(gnutls_alert_description_t alert)
/**
* gnutls_alert_send:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @level: is the level of the alert
* @desc: is the alert description
*
@@ -306,7 +306,7 @@ int gnutls_error_to_alert(int err, int *level)
/**
* gnutls_alert_send_appropriate:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @err: is an integer
*
* Sends an alert to the peer depending on the error code returned by
@@ -337,7 +337,7 @@ int gnutls_alert_send_appropriate(gnutls_session_t session, int err)
/**
* gnutls_alert_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return the last alert number received. This
* function should be called when %GNUTLS_E_WARNING_ALERT_RECEIVED or
diff --git a/lib/gnutls_anon_cred.c b/lib/gnutls_anon_cred.c
index ad45b68515..5818fbdaad 100644
--- a/lib/gnutls_anon_cred.c
+++ b/lib/gnutls_anon_cred.c
@@ -33,7 +33,7 @@
/**
* gnutls_anon_free_server_credentials:
- * @sc: is a #gnutls_anon_server_credentials_t structure.
+ * @sc: is a #gnutls_anon_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to free (deallocate) it.
@@ -47,7 +47,7 @@ gnutls_anon_free_server_credentials(gnutls_anon_server_credentials_t sc)
/**
* gnutls_anon_allocate_server_credentials:
- * @sc: is a pointer to a #gnutls_anon_server_credentials_t structure.
+ * @sc: is a pointer to a #gnutls_anon_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to allocate it.
@@ -67,7 +67,7 @@ gnutls_anon_allocate_server_credentials(gnutls_anon_server_credentials_t *
/**
* gnutls_anon_free_client_credentials:
- * @sc: is a #gnutls_anon_client_credentials_t structure.
+ * @sc: is a #gnutls_anon_client_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to free (deallocate) it.
@@ -83,7 +83,7 @@ static const gnutls_anon_client_credentials_t anon_dummy =
/**
* gnutls_anon_allocate_client_credentials:
- * @sc: is a pointer to a #gnutls_anon_client_credentials_t structure.
+ * @sc: is a pointer to a #gnutls_anon_client_credentials_t type.
*
* This structure is complex enough to manipulate directly thus
* this helper function is provided in order to allocate it.
@@ -104,8 +104,8 @@ gnutls_anon_allocate_client_credentials(gnutls_anon_client_credentials_t *
/**
* gnutls_anon_set_server_dh_params:
- * @res: is a gnutls_anon_server_credentials_t structure
- * @dh_params: is a structure that holds Diffie-Hellman parameters.
+ * @res: is a gnutls_anon_server_credentials_t type
+ * @dh_params: The Diffie-Hellman parameters.
*
* This function will set the Diffie-Hellman parameters for an
* anonymous server to use. These parameters will be used in
@@ -120,7 +120,7 @@ gnutls_anon_set_server_dh_params(gnutls_anon_server_credentials_t res,
/**
* gnutls_anon_set_server_params_function:
- * @res: is a gnutls_certificate_credentials_t structure
+ * @res: is a gnutls_certificate_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
diff --git a/lib/gnutls_auth.c b/lib/gnutls_auth.c
index 7486a1e04c..b7c9208ec8 100644
--- a/lib/gnutls_auth.c
+++ b/lib/gnutls_auth.c
@@ -37,7 +37,7 @@
/**
* gnutls_credentials_clear:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Clears all the credentials previously set in this session.
**/
@@ -61,7 +61,7 @@ void gnutls_credentials_clear(gnutls_session_t session)
*/
/**
* gnutls_credentials_set:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @type: is the type of the credentials
* @cred: is a pointer to a structure.
*
@@ -142,7 +142,7 @@ gnutls_credentials_set(gnutls_session_t session,
/**
* gnutls_credentials_get:
- * @session: is a #gnutls_session_t structure.
+ * @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.
*
@@ -180,7 +180,7 @@ const void *_cred;
/**
* gnutls_auth_get_type:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns type of credentials for the current authentication schema.
* The returned information is to be used to distinguish the function used
@@ -209,7 +209,7 @@ gnutls_credentials_type_t gnutls_auth_get_type(gnutls_session_t session)
/**
* gnutls_auth_server_get_type:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns the type of credentials that were used for server authentication.
* The returned information is to be used to distinguish the function used
@@ -229,7 +229,7 @@ gnutls_auth_server_get_type(gnutls_session_t session)
/**
* gnutls_auth_client_get_type:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns the type of credentials that were used for client authentication.
* The returned information is to be used to distinguish the function used
@@ -283,7 +283,7 @@ const void *_gnutls_get_cred(gnutls_session_t session,
/*-
* _gnutls_free_auth_info - Frees the auth info structure
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function frees the auth info structure and sets it to
* null. It must be called since some structures contain malloced
diff --git a/lib/gnutls_buffers.c b/lib/gnutls_buffers.c
index c6047e1474..ba2353936f 100644
--- a/lib/gnutls_buffers.c
+++ b/lib/gnutls_buffers.c
@@ -83,7 +83,7 @@ _gnutls_record_buffer_put(gnutls_session_t session,
/**
* gnutls_record_check_pending:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function checks if there are unread data
* in the gnutls buffers. If the return value is
@@ -99,7 +99,7 @@ size_t gnutls_record_check_pending(gnutls_session_t session)
/**
* gnutls_record_check_corked:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function checks if there pending corked
* data in the gnutls buffers --see gnutls_record_cork().
diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c
index f7948eeb32..ff007b4044 100644
--- a/lib/gnutls_cert.c
+++ b/lib/gnutls_cert.c
@@ -47,7 +47,7 @@
/**
* gnutls_certificate_free_keys:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
*
* This function will delete all the keys and the certificates associated
* with the given credentials. This function must not be called when a
@@ -81,7 +81,7 @@ void gnutls_certificate_free_keys(gnutls_certificate_credentials_t sc)
/**
* gnutls_certificate_free_cas:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
*
* This function will delete all the CAs associated with the given
* credentials. Servers that do not use
@@ -96,7 +96,7 @@ void gnutls_certificate_free_cas(gnutls_certificate_credentials_t sc)
/**
* gnutls_certificate_get_issuer:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
* @cert: is the certificate to find issuer for
* @issuer: Will hold the issuer if any. Should be treated as constant.
* @flags: Use zero or %GNUTLS_TL_GET_COPY
@@ -123,7 +123,7 @@ gnutls_certificate_get_issuer(gnutls_certificate_credentials_t sc,
/**
* gnutls_certificate_get_crt_raw:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
* @idx1: the index of the certificate if multiple are present
* @idx2: the index in the certificate list. Zero gives the server's certificate.
* @cert: Will hold the DER encoded certificate.
@@ -162,7 +162,7 @@ gnutls_certificate_get_crt_raw(gnutls_certificate_credentials_t sc,
/**
* gnutls_certificate_free_ca_names:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
*
* This function will delete all the CA name in the given
* credentials. Clients may call this to save some memory since in
@@ -182,7 +182,7 @@ void gnutls_certificate_free_ca_names(gnutls_certificate_credentials_t sc)
/**
* gnutls_certificate_free_credentials:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to free (deallocate) it.
@@ -208,7 +208,7 @@ gnutls_certificate_free_credentials(gnutls_certificate_credentials_t sc)
/**
* gnutls_certificate_allocate_credentials:
- * @res: is a pointer to a #gnutls_certificate_credentials_t structure.
+ * @res: is a pointer to a #gnutls_certificate_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to allocate it.
@@ -293,7 +293,7 @@ _gnutls_selected_cert_supported_kx(gnutls_session_t session,
/**
* gnutls_certificate_server_set_request:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @req: is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE
*
* This function specifies if we (in case of a server) are going to
@@ -311,7 +311,7 @@ gnutls_certificate_server_set_request(gnutls_session_t session,
/**
* gnutls_certificate_set_retrieve_function:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
* @func: is the callback function
*
* This function sets a callback to be called in order to retrieve the
@@ -354,7 +354,7 @@ void gnutls_certificate_set_retrieve_function
/**
* gnutls_certificate_set_retrieve_function2:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
* @func: is the callback function
*
* This function sets a callback to be called in order to retrieve the
@@ -402,7 +402,7 @@ void gnutls_certificate_set_retrieve_function2
/**
* gnutls_certificate_set_verify_function:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
* @func: is the callback function
*
* This function sets a callback to be called when peer's certificate
diff --git a/lib/gnutls_db.c b/lib/gnutls_db.c
index d88faaf1af..0196c371f5 100644
--- a/lib/gnutls_db.c
+++ b/lib/gnutls_db.c
@@ -32,7 +32,7 @@
/**
* gnutls_db_set_retrieve_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @retr_func: is the function.
*
* Sets the function that will be used to retrieve data from the
@@ -55,7 +55,7 @@ gnutls_db_set_retrieve_function(gnutls_session_t session,
/**
* gnutls_db_set_remove_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @rem_func: is the function.
*
* Sets the function that will be used to remove data from the
@@ -73,7 +73,7 @@ gnutls_db_set_remove_function(gnutls_session_t session,
/**
* gnutls_db_set_store_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @store_func: is the function
*
* Sets the function that will be used to store data in the resumed
@@ -91,7 +91,7 @@ gnutls_db_set_store_function(gnutls_session_t session,
/**
* gnutls_db_set_ptr:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @ptr: is the pointer
*
* Sets the pointer that will be provided to db store, retrieve and
@@ -104,7 +104,7 @@ void gnutls_db_set_ptr(gnutls_session_t session, void *ptr)
/**
* gnutls_db_get_ptr:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get db function pointer.
*
@@ -118,7 +118,7 @@ void *gnutls_db_get_ptr(gnutls_session_t session)
/**
* gnutls_db_set_cache_expiration:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @seconds: is the number of seconds.
*
* Set the expiration time for resumed sessions. The default is 3600
@@ -141,7 +141,7 @@ unsigned gnutls_db_get_default_cache_expiration(void)
/**
* gnutls_db_check_entry:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @session_entry: is the session data (not key)
*
* This function has no effect.
@@ -158,7 +158,7 @@ gnutls_db_check_entry(gnutls_session_t session,
/**
* gnutls_db_check_entry_time:
- * @entry: is a pointer to a #gnutls_datum_t structure.
+ * @entry: is a pointer to a #gnutls_datum_t type.
* @t: is the time of the session handshake
*
* This function returns the time that this entry was active.
@@ -312,7 +312,7 @@ _gnutls_server_restore_session(gnutls_session_t session,
/**
* gnutls_db_remove_session:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will remove the current session data from the
* session database. This will prevent future handshakes reusing
diff --git a/lib/gnutls_dh.c b/lib/gnutls_dh.c
index 6316ca298d..2f7ed4ce98 100644
--- a/lib/gnutls_dh.c
+++ b/lib/gnutls_dh.c
@@ -35,7 +35,7 @@
/*-
* _gnutls_get_dh_params - Returns the DH parameters pointer
- * @dh_params: is an DH parameters structure, or NULL.
+ * @dh_params: is an DH parameters type, or NULL.
* @func: is a callback function to receive the parameters or NULL.
* @session: a gnutls session.
*
@@ -83,7 +83,7 @@ const bigint_t *_gnutls_dh_params_to_mpi(gnutls_dh_params_t dh_primes)
/**
* gnutls_dh_params_import_raw:
- * @dh_params: Is a structure that will hold the prime numbers
+ * @dh_params: The parameters
* @prime: holds the new prime
* @generator: holds the new generator
*
@@ -104,7 +104,7 @@ gnutls_dh_params_import_raw(gnutls_dh_params_t dh_params,
/**
* gnutls_dh_params_import_raw2:
- * @dh_params: Is a structure that will hold the prime numbers
+ * @dh_params: The parameters
* @prime: holds the new prime
* @generator: holds the new generator
* @key_bits: the private key bits (set to zero when unknown)
@@ -149,9 +149,9 @@ gnutls_dh_params_import_raw2(gnutls_dh_params_t dh_params,
/**
* gnutls_dh_params_init:
- * @dh_params: Is a structure that will hold the prime numbers
+ * @dh_params: The parameters
*
- * This function will initialize the DH parameters structure.
+ * This function will initialize the DH parameters type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned,
* otherwise a negative error code is returned.
@@ -171,9 +171,9 @@ int gnutls_dh_params_init(gnutls_dh_params_t * dh_params)
/**
* gnutls_dh_params_deinit:
- * @dh_params: Is a structure that holds the prime numbers
+ * @dh_params: The parameters
*
- * This function will deinitialize the DH parameters structure.
+ * This function will deinitialize the DH parameters type.
**/
void gnutls_dh_params_deinit(gnutls_dh_params_t dh_params)
{
@@ -189,8 +189,8 @@ void gnutls_dh_params_deinit(gnutls_dh_params_t dh_params)
/**
* gnutls_dh_params_cpy:
- * @dst: Is the destination structure, which should be initialized.
- * @src: Is the source structure
+ * @dst: Is the destination parameters, which should be initialized.
+ * @src: Is the source parameters
*
* This function will copy the DH parameters structure from source
* to destination.
@@ -216,7 +216,7 @@ int gnutls_dh_params_cpy(gnutls_dh_params_t dst, gnutls_dh_params_t src)
/**
* gnutls_dh_params_generate2:
- * @dparams: Is the structure that the DH parameters will be stored
+ * @dparams: The parameters
* @bits: is the prime's number of bits
*
* This function will generate a new pair of prime and generator for use in
@@ -256,7 +256,7 @@ gnutls_dh_params_generate2(gnutls_dh_params_t dparams, unsigned int bits)
/**
* gnutls_dh_params_import_pkcs3:
- * @params: A structure where the parameters will be copied to
+ * @params: The parameters
* @pkcs3_params: should contain a PKCS3 DHParams structure PEM or DER encoded
* @format: the format of params. PEM or DER.
*
diff --git a/lib/gnutls_dtls.c b/lib/gnutls_dtls.c
index 7b359eb768..c69336df9c 100644
--- a/lib/gnutls_dtls.c
+++ b/lib/gnutls_dtls.c
@@ -537,7 +537,7 @@ int _dtls_record_check(struct record_parameters_st *rp, uint64 * _seq)
/**
* gnutls_dtls_set_timeouts:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @retrans_timeout: The time at which a retransmission will occur in milliseconds
* @total_timeout: The time at which the connection will be aborted, in milliseconds.
*
@@ -567,7 +567,7 @@ void gnutls_dtls_set_timeouts(gnutls_session_t session,
/**
* gnutls_dtls_set_mtu:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @mtu: The maximum transfer unit of the transport
*
* This function will set the maximum transfer unit of the transport
@@ -721,7 +721,7 @@ size_t gnutls_record_overhead_size(gnutls_session_t session)
/**
* gnutls_dtls_get_data_mtu:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return the actual maximum transfer unit for
* application data. I.e. DTLS headers are subtracted from the
@@ -747,7 +747,7 @@ unsigned int gnutls_dtls_get_data_mtu(gnutls_session_t session)
/**
* gnutls_dtls_set_data_mtu:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @mtu: The maximum unencrypted transfer unit of the session
*
* This function will set the maximum size of the *unencrypted* records
@@ -785,7 +785,7 @@ int gnutls_dtls_set_data_mtu(gnutls_session_t session, unsigned int mtu)
/**
* gnutls_dtls_get_mtu:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return the MTU size as set with
* gnutls_dtls_set_mtu(). This is not the actual MTU
@@ -803,7 +803,7 @@ unsigned int gnutls_dtls_get_mtu(gnutls_session_t session)
/**
* gnutls_dtls_get_timeout:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return the milliseconds remaining
* for a retransmission of the previously sent handshake
@@ -1080,7 +1080,7 @@ void gnutls_dtls_prestate_set(gnutls_session_t session,
/**
* gnutls_record_get_discarded:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns the number of discarded packets in a
* DTLS connection.
diff --git a/lib/gnutls_handshake.c b/lib/gnutls_handshake.c
index daa66eb009..667d08804f 100644
--- a/lib/gnutls_handshake.c
+++ b/lib/gnutls_handshake.c
@@ -2359,7 +2359,7 @@ recv_hello_verify_request(gnutls_session_t session,
/**
* gnutls_rehandshake:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will renegotiate security parameters with the
* client. This should only be called in case of a server.
@@ -2494,7 +2494,7 @@ static int _gnutls_recv_supplemental(gnutls_session_t session)
/**
* gnutls_handshake:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function does the handshake of the TLS/SSL protocol, and
* initializes the TLS connection.
@@ -2609,7 +2609,7 @@ int gnutls_handshake(gnutls_session_t session)
/**
* gnutls_handshake_set_timeout:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @ms: is a timeout value in milliseconds
*
* This function sets the timeout for the TLS handshake process
@@ -3304,7 +3304,7 @@ _gnutls_recv_hello_request(gnutls_session_t session, void *data,
/**
* gnutls_handshake_set_max_packet_length:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @max: is the maximum number.
*
* This function will set the maximum size of all handshake messages.
@@ -3325,7 +3325,7 @@ gnutls_handshake_set_max_packet_length(gnutls_session_t session,
/**
* gnutls_handshake_get_last_in:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function is only useful to check where the last performed
* handshake failed. If the previous handshake succeed or was not
@@ -3345,7 +3345,7 @@ gnutls_handshake_get_last_in(gnutls_session_t session)
/**
* gnutls_handshake_get_last_out:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function is only useful to check where the last performed
* handshake failed. If the previous handshake succeed or was not
diff --git a/lib/gnutls_pcert.c b/lib/gnutls_pcert.c
index 53e9a21d3a..06088c8654 100644
--- a/lib/gnutls_pcert.c
+++ b/lib/gnutls_pcert.c
@@ -411,7 +411,7 @@ int gnutls_pcert_import_openpgp_raw(gnutls_pcert_st * pcert,
* @pcert: The pcert structure.
* @crt: An initialized #gnutls_x509_crt_t.
*
- * Converts the given #gnutls_pcert_t structure into a #gnutls_x509_crt_t.
+ * Converts the given #gnutls_pcert_t type into a #gnutls_x509_crt_t.
* This function only works if the type of @pcert is %GNUTLS_CRT_X509.
* When successful, the value written to @crt must be freed with
* gnutls_x509_crt_deinit() when no longer needed.
@@ -453,7 +453,7 @@ int gnutls_pcert_export_x509(gnutls_pcert_st * pcert,
* @pcert: The pcert structure.
* @crt: An initialized #gnutls_openpgp_crt_t.
*
- * Converts the given #gnutls_pcert_t structure into a #gnutls_openpgp_crt_t.
+ * Converts the given #gnutls_pcert_t type into a #gnutls_openpgp_crt_t.
* This function only works if the type of @pcert is %GNUTLS_CRT_OPENPGP.
* When successful, the value written to @crt must be freed with
* gnutls_openpgp_crt_deinit() when no longer needed.
diff --git a/lib/gnutls_priority.c b/lib/gnutls_priority.c
index f6bedce47b..2fd596d7db 100644
--- a/lib/gnutls_priority.c
+++ b/lib/gnutls_priority.c
@@ -492,8 +492,8 @@ static void prio_add(priority_st * priority_list, unsigned int algo)
/**
* gnutls_priority_set:
- * @session: is a #gnutls_session_t structure.
- * @priority: is a #gnutls_priority_t structure.
+ * @session: is a #gnutls_session_t type.
+ * @priority: is a #gnutls_priority_t type.
*
* Sets the priorities to use on the ciphers, key exchange methods,
* macs and compression methods.
@@ -952,7 +952,7 @@ finish:
/**
* gnutls_priority_init:
- * @priority_cache: is a #gnutls_prioritity_t structure.
+ * @priority_cache: is a #gnutls_prioritity_t type.
* @priorities: is a string describing priorities (may be %NULL)
* @err_pos: In case of an error this will have the position in the string the error occurred
*
@@ -1288,7 +1288,7 @@ gnutls_priority_init(gnutls_priority_t * priority_cache,
/**
* gnutls_priority_deinit:
- * @priority_cache: is a #gnutls_prioritity_t structure.
+ * @priority_cache: is a #gnutls_prioritity_t type.
*
* Deinitializes the priority cache.
**/
@@ -1300,7 +1300,7 @@ void gnutls_priority_deinit(gnutls_priority_t priority_cache)
/**
* gnutls_priority_set_direct:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @priorities: is a string describing priorities
* @err_pos: In case of an error this will have the position in the string the error occured
*
@@ -1369,7 +1369,7 @@ break_list(char *list,
/**
* gnutls_set_default_priority:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Sets the default priority on the ciphers, key exchange methods,
* macs and compression methods. For more fine-tuning you could
@@ -1384,7 +1384,7 @@ int gnutls_set_default_priority(gnutls_session_t session)
/**
* gnutls_priority_ecc_curve_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available elliptic curves in the priority
@@ -1406,7 +1406,7 @@ gnutls_priority_ecc_curve_list(gnutls_priority_t pcache,
/**
* gnutls_priority_kx_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available key exchange methods in the priority
@@ -1428,7 +1428,7 @@ gnutls_priority_kx_list(gnutls_priority_t pcache,
/**
* gnutls_priority_cipher_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available ciphers in the priority
@@ -1450,7 +1450,7 @@ gnutls_priority_cipher_list(gnutls_priority_t pcache,
/**
* gnutls_priority_mac_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available MAC algorithms in the priority
@@ -1472,7 +1472,7 @@ gnutls_priority_mac_list(gnutls_priority_t pcache,
/**
* gnutls_priority_compression_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available compression method in the priority
@@ -1494,7 +1494,7 @@ gnutls_priority_compression_list(gnutls_priority_t pcache,
/**
* gnutls_priority_protocol_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available TLS version numbers in the priority
@@ -1516,7 +1516,7 @@ gnutls_priority_protocol_list(gnutls_priority_t pcache,
/**
* gnutls_priority_sign_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available signature algorithms in the priority
@@ -1538,7 +1538,7 @@ gnutls_priority_sign_list(gnutls_priority_t pcache,
/**
* gnutls_priority_certificate_type_list:
- * @pcache: is a #gnutls_prioritity_t structure.
+ * @pcache: is a #gnutls_prioritity_t type.
* @list: will point to an integer list
*
* Get a list of available certificate types in the priority
diff --git a/lib/gnutls_privkey.c b/lib/gnutls_privkey.c
index 0c86fd5c66..0cd9ff481e 100644
--- a/lib/gnutls_privkey.c
+++ b/lib/gnutls_privkey.c
@@ -40,7 +40,7 @@
/**
* gnutls_privkey_get_type:
- * @key: should contain a #gnutls_privkey_t structure
+ * @key: should contain a #gnutls_privkey_t type
*
* This function will return the type of the private key. This is
* actually the type of the subsystem used to set this private key.
@@ -57,7 +57,7 @@ gnutls_privkey_type_t gnutls_privkey_get_type(gnutls_privkey_t key)
/**
* gnutls_privkey_get_pk_algorithm:
- * @key: should contain a #gnutls_privkey_t structure
+ * @key: should contain a #gnutls_privkey_t type
* @bits: If set will return the number of bits of the parameters (may be NULL)
*
* This function will return the public key algorithm of a private
@@ -247,9 +247,9 @@ _gnutls_privkey_get_public_mpis(gnutls_privkey_t key,
/**
* gnutls_privkey_init:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
- * This function will initialize an private key structure.
+ * This function will initialize a private key.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -271,7 +271,7 @@ int gnutls_privkey_init(gnutls_privkey_t * key)
/**
* gnutls_privkey_deinit:
- * @key: The structure to be deinitialized
+ * @key: The key to be deinitialized
*
* This function will deinitialize a private key structure.
*
@@ -328,7 +328,7 @@ static int check_if_clean(gnutls_privkey_t key)
* @flags: Flags for the import
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* The #gnutls_pkcs11_privkey_t object must not be deallocated
* during the lifetime of this structure.
@@ -374,7 +374,7 @@ gnutls_privkey_import_pkcs11(gnutls_privkey_t pkey,
* @url: A PKCS 11 url
*
* This function will import a PKCS 11 private key to a #gnutls_private_key_t
- * structure.
+ * type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -424,7 +424,7 @@ int gnutls_privkey_import_pkcs11_url(gnutls_privkey_t key, const char *url)
* @key: Location for the key to be exported.
*
* Converts the given abstract private key to a #gnutls_pkcs11_privkey_t
- * structure. The key must be of type %GNUTLS_PRIVKEY_PKCS11. The key
+ * type. The key must be of type %GNUTLS_PRIVKEY_PKCS11. The key
* returned in @key must be deinitialized with
* gnutls_pkcs11_privkey_deinit().
*
@@ -470,7 +470,7 @@ gnutls_privkey_export_pkcs11(gnutls_privkey_t pkey,
* @flags: Flags for the import
*
* This function will associate the given callbacks with the
- * #gnutls_privkey_t structure. At least one of the two callbacks
+ * #gnutls_privkey_t type. At least one of the two callbacks
* must be non-null.
*
* See also gnutls_privkey_import_ext3().
@@ -503,7 +503,7 @@ gnutls_privkey_import_ext(gnutls_privkey_t pkey,
* @flags: Flags for the import
*
* This function will associate the given callbacks with the
- * #gnutls_privkey_t structure. At least one of the two callbacks
+ * #gnutls_privkey_t type. At least one of the two callbacks
* must be non-null. If a deinitialization function is provided
* then flags is assumed to contain %GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE.
*
@@ -565,7 +565,7 @@ gnutls_privkey_import_ext2(gnutls_privkey_t pkey,
* @flags: Flags for the import
*
* This function will associate the given callbacks with the
- * #gnutls_privkey_t structure. At least one of the two callbacks
+ * #gnutls_privkey_t type. At least one of the two callbacks
* must be non-null. If a deinitialization function is provided
* then flags is assumed to contain %GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE.
*
@@ -630,7 +630,7 @@ gnutls_privkey_import_ext3(gnutls_privkey_t pkey,
* @flags: Flags for the import
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* The #gnutls_x509_privkey_t object must not be deallocated
* during the lifetime of this structure.
@@ -681,7 +681,7 @@ gnutls_privkey_import_x509(gnutls_privkey_t pkey,
* @key: Location for the key to be exported.
*
* Converts the given abstract private key to a #gnutls_x509_privkey_t
- * structure. The key must be of type %GNUTLS_PRIVKEY_X509. The key returned
+ * type. The key must be of type %GNUTLS_PRIVKEY_X509. The key returned
* in @key must be deinitialized with gnutls_x509_privkey_deinit().
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
@@ -769,7 +769,7 @@ gnutls_privkey_generate(gnutls_privkey_t pkey,
* @flags: Flags for the import
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* The #gnutls_openpgp_privkey_t object must not be deallocated
* during the lifetime of this structure. The subkey set as
@@ -840,7 +840,7 @@ gnutls_privkey_import_openpgp(gnutls_privkey_t pkey,
* @password: A password (optional)
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -896,7 +896,7 @@ int gnutls_privkey_import_openpgp_raw(gnutls_privkey_t pkey,
* @key: Location for the key to be exported.
*
* Converts the given abstract private key to a #gnutls_openpgp_privkey_t
- * structure. The key must be of type %GNUTLS_PRIVKEY_OPENPGP. The key
+ * type. The key must be of type %GNUTLS_PRIVKEY_OPENPGP. The key
* returned in @key must be deinitialized with
* gnutls_openpgp_privkey_deinit().
*
@@ -1173,7 +1173,7 @@ gnutls_privkey_decrypt_data(gnutls_privkey_t key,
* @flags: an ORed sequence of gnutls_pkcs_encrypt_flags_t
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* The supported formats are basic unencrypted key, PKCS8, PKCS12,
* and the openssl format.
@@ -1334,7 +1334,7 @@ int gnutls_privkey_status(gnutls_privkey_t key)
/**
* gnutls_privkey_verify_params:
- * @key: should contain a #gnutls_privkey_t structure
+ * @key: should contain a #gnutls_privkey_t type
*
* This function will verify the private key parameters.
*
@@ -1368,7 +1368,7 @@ int gnutls_privkey_verify_params(gnutls_privkey_t key)
/*-
* _gnutls_privkey_get_preferred_sign_algo:
- * @key: should contain a #gnutls_privkey_t structure
+ * @key: should contain a #gnutls_privkey_t type
*
* This function returns the preferred signature algorithm for this
* private key.
diff --git a/lib/gnutls_privkey_raw.c b/lib/gnutls_privkey_raw.c
index 002447d4e5..10ea3e012c 100644
--- a/lib/gnutls_privkey_raw.c
+++ b/lib/gnutls_privkey_raw.c
@@ -280,7 +280,7 @@ error:
/**
* gnutls_privkey_import_ecc_raw:
- * @key: The structure to store the parsed key
+ * @key: The key
* @curve: holds the curve
* @x: holds the x
* @y: holds the y
diff --git a/lib/gnutls_psk.c b/lib/gnutls_psk.c
index debafcf1e3..aaa39de9ca 100644
--- a/lib/gnutls_psk.c
+++ b/lib/gnutls_psk.c
@@ -37,7 +37,7 @@
/**
* gnutls_psk_free_client_credentials:
- * @sc: is a #gnutls_psk_client_credentials_t structure.
+ * @sc: is a #gnutls_psk_client_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to free (deallocate) it.
@@ -51,7 +51,7 @@ void gnutls_psk_free_client_credentials(gnutls_psk_client_credentials_t sc)
/**
* gnutls_psk_allocate_client_credentials:
- * @sc: is a pointer to a #gnutls_psk_server_credentials_t structure.
+ * @sc: is a pointer to a #gnutls_psk_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to allocate it.
@@ -73,14 +73,14 @@ gnutls_psk_allocate_client_credentials(gnutls_psk_client_credentials_t *
/**
* gnutls_psk_set_client_credentials:
- * @res: is a #gnutls_psk_client_credentials_t structure.
+ * @res: is a #gnutls_psk_client_credentials_t type.
* @username: is the user's zero-terminated userid
* @key: is the user's key
* @flags: indicate the format of the key, either
* %GNUTLS_PSK_KEY_RAW or %GNUTLS_PSK_KEY_HEX.
*
* This function sets the username and password, in a
- * gnutls_psk_client_credentials_t structure. Those will be used in
+ * gnutls_psk_client_credentials_t type. Those will be used in
* PSK authentication. @username should be an ASCII string or UTF-8
* strings prepared using the "SASLprep" profile of "stringprep". The
* key can be either in raw byte format or in Hex format (without the
@@ -150,7 +150,7 @@ gnutls_psk_set_client_credentials(gnutls_psk_client_credentials_t res,
/**
* gnutls_psk_free_server_credentials:
- * @sc: is a #gnutls_psk_server_credentials_t structure.
+ * @sc: is a #gnutls_psk_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to free (deallocate) it.
@@ -164,7 +164,7 @@ void gnutls_psk_free_server_credentials(gnutls_psk_server_credentials_t sc)
/**
* gnutls_psk_allocate_server_credentials:
- * @sc: is a pointer to a #gnutls_psk_server_credentials_t structure.
+ * @sc: is a pointer to a #gnutls_psk_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to allocate it.
@@ -187,11 +187,11 @@ gnutls_psk_allocate_server_credentials(gnutls_psk_server_credentials_t *
/**
* gnutls_psk_set_server_credentials_file:
- * @res: is a #gnutls_psk_server_credentials_t structure.
+ * @res: is a #gnutls_psk_server_credentials_t type.
* @password_file: is the PSK password file (passwd.psk)
*
* This function sets the password file, in a
- * #gnutls_psk_server_credentials_t structure. This password file
+ * #gnutls_psk_server_credentials_t type. This password file
* holds usernames and keys and will be used for PSK authentication.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
@@ -224,11 +224,11 @@ gnutls_psk_set_server_credentials_file(gnutls_psk_server_credentials_t
/**
* gnutls_psk_set_server_credentials_hint:
- * @res: is a #gnutls_psk_server_credentials_t structure.
+ * @res: is a #gnutls_psk_server_credentials_t type.
* @hint: is the PSK identity hint string
*
* This function sets the identity hint, in a
- * #gnutls_psk_server_credentials_t structure. This hint is sent to
+ * #gnutls_psk_server_credentials_t type. This hint is sent to
* the client to help it chose a good PSK credential (i.e., username
* and password).
*
@@ -252,7 +252,7 @@ gnutls_psk_set_server_credentials_hint(gnutls_psk_server_credentials_t res,
/**
* gnutls_psk_set_server_credentials_function:
- * @cred: is a #gnutls_psk_server_credentials_t structure.
+ * @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the user's PSK credentials.
@@ -281,7 +281,7 @@ gnutls_psk_set_server_credentials_function(gnutls_psk_server_credentials_t
/**
* gnutls_psk_set_client_credentials_function:
- * @cred: is a #gnutls_psk_server_credentials_t structure.
+ * @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the username and
@@ -364,7 +364,7 @@ const char *gnutls_psk_client_get_hint(gnutls_session_t session)
/**
* gnutls_psk_set_server_dh_params:
- * @res: is a gnutls_psk_server_credentials_t structure
+ * @res: is a gnutls_psk_server_credentials_t type
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
* This function will set the Diffie-Hellman parameters for an
@@ -380,7 +380,7 @@ gnutls_psk_set_server_dh_params(gnutls_psk_server_credentials_t res,
/**
* gnutls_psk_set_server_params_function:
- * @res: is a #gnutls_certificate_credentials_t structure
+ * @res: is a #gnutls_certificate_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
diff --git a/lib/gnutls_pubkey.c b/lib/gnutls_pubkey.c
index 0bc3613673..54e08db488 100644
--- a/lib/gnutls_pubkey.c
+++ b/lib/gnutls_pubkey.c
@@ -59,7 +59,7 @@ int pubkey_to_bits(gnutls_pk_algorithm_t pk, gnutls_pk_params_st * params)
/**
* gnutls_pubkey_get_pk_algorithm:
- * @key: should contain a #gnutls_pubkey_t structure
+ * @key: should contain a #gnutls_pubkey_t type
* @bits: If set will return the number of bits of the parameters (may be NULL)
*
* This function will return the public key algorithm of a public
@@ -81,7 +81,7 @@ int gnutls_pubkey_get_pk_algorithm(gnutls_pubkey_t key, unsigned int *bits)
/**
* gnutls_pubkey_get_key_usage:
- * @key: should contain a #gnutls_pubkey_t structure
+ * @key: should contain a #gnutls_pubkey_t type
* @usage: If set will return the number of bits of the parameters (may be NULL)
*
* This function will return the key usage of the public key.
@@ -101,9 +101,9 @@ int gnutls_pubkey_get_key_usage(gnutls_pubkey_t key, unsigned int *usage)
/**
* gnutls_pubkey_init:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
- * This function will initialize an public key structure.
+ * This function will initialize a public key.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -125,7 +125,7 @@ int gnutls_pubkey_init(gnutls_pubkey_t * key)
/**
* gnutls_pubkey_deinit:
- * @key: The structure to be deinitialized
+ * @key: The key to be deinitialized
*
* This function will deinitialize a public key structure.
*
@@ -146,7 +146,7 @@ void gnutls_pubkey_deinit(gnutls_pubkey_t key)
* @flags: should be zero
*
* This function will import the given public key to the abstract
- * #gnutls_pubkey_t structure.
+ * #gnutls_pubkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -185,7 +185,7 @@ gnutls_pubkey_import_x509(gnutls_pubkey_t key, gnutls_x509_crt_t crt,
* @flags: should be zero
*
* This function will import the given public key to the abstract
- * #gnutls_pubkey_t structure.
+ * #gnutls_pubkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -225,7 +225,7 @@ gnutls_pubkey_import_x509_crq(gnutls_pubkey_t key, gnutls_x509_crq_t crq,
* @flags: should be zero
*
* Imports the public key from a private. This function will import
- * the given public key to the abstract #gnutls_pubkey_t structure.
+ * the given public key to the abstract #gnutls_pubkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -316,7 +316,7 @@ gnutls_pubkey_get_preferred_hash_algorithm(gnutls_pubkey_t key,
* @flags: should be zero
*
* Imports a public key from a pkcs11 key. This function will import
- * the given public key to the abstract #gnutls_pubkey_t structure.
+ * the given public key to the abstract #gnutls_pubkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -407,7 +407,7 @@ gnutls_pubkey_import_pkcs11(gnutls_pubkey_t key,
*
* Imports a public key from an openpgp key. This function will import
* the given public key to the abstract #gnutls_pubkey_t
- * structure. The subkey set as preferred will be imported or the
+ * type. The subkey set as preferred will be imported or the
* master key otherwise.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
@@ -575,7 +575,7 @@ gnutls_pubkey_get_openpgp_key_id(gnutls_pubkey_t key, unsigned int flags,
* @flags: Should be zero
*
* This function will import the given public key to the abstract
- * #gnutls_pubkey_t structure.
+ * #gnutls_pubkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -1026,13 +1026,13 @@ int gnutls_pubkey_export_ecc_x962(gnutls_pubkey_t key,
/**
* gnutls_pubkey_import:
- * @key: The structure to store the parsed public key.
+ * @key: The public key.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
*
* This function will import the provided public key in
* a SubjectPublicKeyInfo X.509 structure to a native
- * %gnutls_pubkey_t structure. The output will be stored
+ * %gnutls_pubkey_t type. The output will be stored
* in @key. If the public key is PEM encoded it should have a header
* of "PUBLIC KEY".
*
@@ -1113,7 +1113,7 @@ gnutls_pubkey_import(gnutls_pubkey_t key,
/**
* gnutls_x509_crt_set_pubkey:
- * @crt: should contain a #gnutls_x509_crt_t structure
+ * @crt: should contain a #gnutls_x509_crt_t type
* @key: holds a public key
*
* This function will set the public parameters from the given public
@@ -1151,7 +1151,7 @@ int gnutls_x509_crt_set_pubkey(gnutls_x509_crt_t crt, gnutls_pubkey_t key)
/**
* gnutls_x509_crq_set_pubkey:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @key: holds a public key
*
* This function will set the public parameters from the given public
@@ -1308,7 +1308,7 @@ gnutls_pubkey_import_url(gnutls_pubkey_t key, const char *url,
/**
* gnutls_pubkey_import_rsa_raw:
- * @key: Is a structure will hold the parameters
+ * @key: The key
* @m: holds the modulus
* @e: holds the public exponent
*
@@ -2002,7 +2002,7 @@ void gnutls_pubkey_set_pin_function(gnutls_pubkey_t key,
* @flags: should be zero
*
* This function will import the given public key to the abstract
- * #gnutls_pubkey_t structure.
+ * #gnutls_pubkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -2043,7 +2043,7 @@ int gnutls_pubkey_import_x509_raw(gnutls_pubkey_t pkey,
/**
* gnutls_pubkey_verify_params:
- * @key: should contain a #gnutls_pubkey_t structure
+ * @key: should contain a #gnutls_pubkey_t type
*
* This function will verify the private key parameters.
*
diff --git a/lib/gnutls_range.c b/lib/gnutls_range.c
index e130431edb..488312d9c4 100644
--- a/lib/gnutls_range.c
+++ b/lib/gnutls_range.c
@@ -88,7 +88,7 @@ _gnutls_range_max_lh_pad(gnutls_session_t session, ssize_t data_length,
/**
* gnutls_record_can_use_length_hiding:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* If the session supports length-hiding padding, you can
* invoke gnutls_range_send_message() to send a message whose
@@ -128,7 +128,7 @@ int gnutls_record_can_use_length_hiding(gnutls_session_t session)
/**
* gnutls_range_split:
- * @session: is a #gnutls_session_t structure
+ * @session: is a #gnutls_session_t type
* @orig: is the original range provided by the user
* @next: is the returned range that can be conveyed in a TLS record
* @remainder: is the returned remaining range
@@ -204,7 +204,7 @@ _gnutls_range_fragment(size_t data_size, gnutls_range_st cur,
/**
* gnutls_record_send_range:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data: contains the data to send.
* @data_size: is the length of the data.
* @range: is the range of lengths in which the real data length must be hidden.
diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c
index 4ae9777b7d..c99486cef7 100644
--- a/lib/gnutls_record.c
+++ b/lib/gnutls_record.c
@@ -67,7 +67,7 @@ struct tls_record_st {
/**
* gnutls_record_disable_padding:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Used to disabled padding in TLS 1.0 and above. Normally you do not
* need to use this function, but there are buggy clients that
@@ -85,7 +85,7 @@ void gnutls_record_disable_padding(gnutls_session_t session)
/**
* gnutls_record_set_max_empty_records:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @i: is the desired value of maximum empty records that can be accepted in a row.
*
* Used to set the maximum number of empty fragments that can be accepted
@@ -105,7 +105,7 @@ gnutls_record_set_max_empty_records(gnutls_session_t session,
/**
* gnutls_transport_set_ptr:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @ptr: is the value.
*
* Used to set the first argument of the transport function (for push
@@ -123,7 +123,7 @@ gnutls_transport_set_ptr(gnutls_session_t session,
/**
* gnutls_transport_set_ptr2:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @recv_ptr: is the value for the pull function
* @send_ptr: is the value for the push function
*
@@ -143,7 +143,7 @@ gnutls_transport_set_ptr2(gnutls_session_t session,
/**
* gnutls_transport_set_int2:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @recv_int: is the value for the pull function
* @send_int: is the value for the push function
*
@@ -168,7 +168,7 @@ gnutls_transport_set_int2(gnutls_session_t session,
/* this will be a macro */
/**
* gnutls_transport_set_int:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @i: is the value.
*
* Used to set the first argument of the transport function (for push
@@ -188,7 +188,7 @@ void gnutls_transport_set_int(gnutls_session_t session, int i)
/**
* gnutls_transport_get_ptr:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Used to get the first argument of the transport function (like
* PUSH and PULL). This must have been set using
@@ -203,7 +203,7 @@ gnutls_transport_ptr_t gnutls_transport_get_ptr(gnutls_session_t session)
/**
* gnutls_transport_get_ptr2:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @recv_ptr: will hold the value for the pull function
* @send_ptr: will hold the value for the push function
*
@@ -223,7 +223,7 @@ gnutls_transport_get_ptr2(gnutls_session_t session,
/**
* gnutls_transport_get_int2:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @recv_int: will hold the value for the pull function
* @send_int: will hold the value for the push function
*
@@ -244,7 +244,7 @@ gnutls_transport_get_int2(gnutls_session_t session,
/**
* gnutls_transport_get_int:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Used to get the first argument of the transport function (like
* PUSH and PULL). This must have been set using
@@ -261,7 +261,7 @@ int gnutls_transport_get_int(gnutls_session_t session)
/**
* gnutls_bye:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @how: is an integer
*
* Terminates the current TLS/SSL connection. The connection should
@@ -1449,7 +1449,7 @@ _gnutls_recv_int(gnutls_session_t session, content_type_t type,
/**
* gnutls_packet_get:
- * @packet: is a #gnutls_packet_t structure.
+ * @packet: is a #gnutls_packet_t type.
* @data: will contain the data present in the @packet structure (may be %NULL)
* @sequence: the 8-bytes of the packet sequence number (may be %NULL)
*
@@ -1495,7 +1495,7 @@ void gnutls_packet_deinit(gnutls_packet_t packet)
/**
* gnutls_record_discard_queued:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function discards all queued to be sent packets in a DTLS session.
* These are the packets queued after an interrupted gnutls_record_send().
@@ -1514,7 +1514,7 @@ gnutls_record_discard_queued(gnutls_session_t session)
/**
* gnutls_record_recv_packet:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @packet: the structure that will hold the packet data
*
* This is a lower-level function than gnutls_record_recv() and allows
@@ -1542,7 +1542,7 @@ gnutls_record_recv_packet(gnutls_session_t session,
/**
* gnutls_record_send:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data: contains the data to send
* @data_size: is the length of the data
*
@@ -1607,7 +1607,7 @@ gnutls_record_send(gnutls_session_t session, const void *data,
/**
* gnutls_record_cork:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* If called, gnutls_record_send() will no longer send any records.
* Any sent records will be cached until gnutls_record_uncork() is called.
@@ -1623,7 +1623,7 @@ void gnutls_record_cork(gnutls_session_t session)
/**
* gnutls_record_uncork:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @flags: Could be zero or %GNUTLS_RECORD_WAIT
*
* This resets the effect of gnutls_record_cork(), and flushes any pending
@@ -1691,7 +1691,7 @@ int gnutls_record_uncork(gnutls_session_t session, unsigned int flags)
/**
* gnutls_record_recv:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data: the buffer that the data will be read into
* @data_size: the number of requested bytes
*
@@ -1726,7 +1726,7 @@ gnutls_record_recv(gnutls_session_t session, void *data, size_t data_size)
/**
* gnutls_record_recv_seq:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data: the buffer that the data will be read into
* @data_size: the number of requested bytes
* @seq: is the packet's 64-bit sequence number. Should have space for 8 bytes.
@@ -1755,7 +1755,7 @@ gnutls_record_recv_seq(gnutls_session_t session, void *data,
/**
* gnutls_record_set_timeout:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @ms: is a timeout value in milliseconds
*
* This function sets the receive timeout for the record layer
diff --git a/lib/gnutls_session.c b/lib/gnutls_session.c
index 3472bf6a53..bd13d93030 100644
--- a/lib/gnutls_session.c
+++ b/lib/gnutls_session.c
@@ -27,7 +27,7 @@
/**
* gnutls_session_get_data:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @session_data: is a pointer to space to hold the session.
* @session_data_size: is the session_data's size, or it will be set by the function.
*
@@ -78,7 +78,7 @@ gnutls_session_get_data(gnutls_session_t session,
/**
* gnutls_session_get_data2:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @data: is a pointer to a datum that will hold the session.
*
* Returns all session parameters needed to be stored to support resumption.
@@ -117,7 +117,7 @@ gnutls_session_get_data2(gnutls_session_t session, gnutls_datum_t * data)
/**
* gnutls_session_get_id:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @session_id: is a pointer to space to hold the session id.
* @session_id_size: initially should contain the maximum @session_id size and will be updated.
*
@@ -159,7 +159,7 @@ gnutls_session_get_id(gnutls_session_t session,
/**
* gnutls_session_get_id2:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @session_id: will point to the session ID.
*
* Returns the current session ID. The returned data should be
@@ -182,7 +182,7 @@ gnutls_session_get_id2(gnutls_session_t session,
/**
* gnutls_session_set_data:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @session_data: is a pointer to space to hold the session.
* @session_data_size: is the session's size
*
@@ -225,7 +225,7 @@ gnutls_session_set_data(gnutls_session_t session,
/**
* gnutls_session_force_valid:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Clears the invalid flag in a session. That means
* that sessions were corrupt or invalid data were received
diff --git a/lib/gnutls_session_pack.c b/lib/gnutls_session_pack.c
index 18b998cc69..c2ba57d13f 100644
--- a/lib/gnutls_session_pack.c
+++ b/lib/gnutls_session_pack.c
@@ -890,7 +890,7 @@ unpack_security_parameters(gnutls_session_t session, gnutls_buffer_st * ps)
/**
* gnutls_session_set_premaster:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @entity: GNUTLS_SERVER or GNUTLS_CLIENT
* @version: the TLS protocol version
* @kx: the key exchange method
diff --git a/lib/gnutls_srp.c b/lib/gnutls_srp.c
index 4d2e15ffce..b5d9170bf2 100644
--- a/lib/gnutls_srp.c
+++ b/lib/gnutls_srp.c
@@ -406,7 +406,7 @@ _gnutls_calc_srp_S2(bigint_t B, bigint_t g, bigint_t x, bigint_t a,
/**
* gnutls_srp_free_client_credentials:
- * @sc: is a #gnutls_srp_client_credentials_t structure.
+ * @sc: is a #gnutls_srp_client_credentials_t type.
*
* This structure is complex enough to manipulate directly thus
* this helper function is provided in order to free (deallocate) it.
@@ -420,7 +420,7 @@ void gnutls_srp_free_client_credentials(gnutls_srp_client_credentials_t sc)
/**
* gnutls_srp_allocate_client_credentials:
- * @sc: is a pointer to a #gnutls_srp_server_credentials_t structure.
+ * @sc: is a pointer to a #gnutls_srp_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus
* this helper function is provided in order to allocate it.
@@ -442,12 +442,12 @@ gnutls_srp_allocate_client_credentials(gnutls_srp_client_credentials_t *
/**
* gnutls_srp_set_client_credentials:
- * @res: is a #gnutls_srp_client_credentials_t structure.
+ * @res: is a #gnutls_srp_client_credentials_t type.
* @username: is the user's userid
* @password: is the user's password
*
* This function sets the username and password, in a
- * #gnutls_srp_client_credentials_t structure. Those will be used in
+ * #gnutls_srp_client_credentials_t type. Those will be used in
* SRP authentication. @username and @password should be ASCII
* strings or UTF-8 strings prepared using the "SASLprep" profile of
* "stringprep".
@@ -481,7 +481,7 @@ gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t res,
/**
* gnutls_srp_free_server_credentials:
- * @sc: is a #gnutls_srp_server_credentials_t structure.
+ * @sc: is a #gnutls_srp_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus
* this helper function is provided in order to free (deallocate) it.
@@ -509,7 +509,7 @@ void gnutls_srp_free_server_credentials(gnutls_srp_server_credentials_t sc)
/**
* gnutls_srp_allocate_server_credentials:
- * @sc: is a pointer to a #gnutls_srp_server_credentials_t structure.
+ * @sc: is a pointer to a #gnutls_srp_server_credentials_t type.
*
* This structure is complex enough to manipulate directly thus this
* helper function is provided in order to allocate it.
@@ -555,12 +555,12 @@ cleanup:
/**
* gnutls_srp_set_server_credentials_file:
- * @res: is a #gnutls_srp_server_credentials_t structure.
+ * @res: is a #gnutls_srp_server_credentials_t type.
* @password_file: is the SRP password file (tpasswd)
* @password_conf_file: is the SRP password conf file (tpasswd.conf)
*
* This function sets the password files, in a
- * #gnutls_srp_server_credentials_t structure. Those password files
+ * #gnutls_srp_server_credentials_t type. Those password files
* hold usernames and verifiers and will be used for SRP
* authentication.
*
@@ -609,7 +609,7 @@ gnutls_srp_set_server_credentials_file(gnutls_srp_server_credentials_t res,
/**
* gnutls_srp_set_server_credentials_function:
- * @cred: is a #gnutls_srp_server_credentials_t structure.
+ * @cred: is a #gnutls_srp_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the user's
@@ -652,7 +652,7 @@ gnutls_srp_set_server_credentials_function(gnutls_srp_server_credentials_t
/**
* gnutls_srp_set_client_credentials_function:
- * @cred: is a #gnutls_srp_server_credentials_t structure.
+ * @cred: is a #gnutls_srp_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the
@@ -768,7 +768,7 @@ gnutls_srp_verifier(const char *username, const char *password,
/**
* gnutls_srp_set_prime_bits:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @bits: is the number of bits
*
* This function sets the minimum accepted number of bits, for use in
@@ -790,7 +790,7 @@ void gnutls_srp_set_prime_bits(gnutls_session_t session, unsigned int bits)
/**
* gnutls_srp_set_server_fake_salt_seed:
- * @cred: is a #gnutls_srp_server_credentials_t structure
+ * @cred: is a #gnutls_srp_server_credentials_t type
* @seed: is the seed data, only needs to be valid until the function
* returns; size of the seed must be greater than zero
* @salt_length: is the length of the generated fake salts
diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c
index 6768bcb8c1..47cc864a30 100644
--- a/lib/gnutls_state.c
+++ b/lib/gnutls_state.c
@@ -76,7 +76,7 @@ _gnutls_session_ecc_curve_set(gnutls_session_t session,
/**
* gnutls_cipher_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get currently used cipher.
*
@@ -98,7 +98,7 @@ gnutls_cipher_algorithm_t gnutls_cipher_get(gnutls_session_t session)
/**
* gnutls_certificate_type_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* The certificate type is by default X.509, unless it is negotiated
* as a TLS extension.
@@ -114,7 +114,7 @@ gnutls_certificate_type_get(gnutls_session_t session)
/**
* gnutls_kx_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get currently used key exchange algorithm.
*
@@ -128,7 +128,7 @@ gnutls_kx_algorithm_t gnutls_kx_get(gnutls_session_t session)
/**
* gnutls_mac_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get currently used MAC algorithm.
*
@@ -150,7 +150,7 @@ gnutls_mac_algorithm_t gnutls_mac_get(gnutls_session_t session)
/**
* gnutls_compression_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get currently used compression algorithm.
*
@@ -280,7 +280,7 @@ void _gnutls_handshake_internal_state_clear(gnutls_session_t session)
/**
* gnutls_init:
- * @session: is a pointer to a #gnutls_session_t structure.
+ * @session: is a pointer to a #gnutls_session_t type.
* @flags: indicate if this session is to be used for server or client.
*
* This function initializes the current session to null. Every
@@ -433,7 +433,7 @@ int _gnutls_session_is_resumable(gnutls_session_t session)
/**
* gnutls_deinit:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function clears all buffers associated with the @session.
* This function will also remove session data from the session
@@ -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 structure.
+ * @session: is a pointer to 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 structure.
+ * @session: is a pointer to a #gnutls_session_t type.
* @status: is 0 or 1
*
* If status is non zero, this function will order gnutls not to send
@@ -716,7 +716,7 @@ int _gnutls_openpgp_send_fingerprint(gnutls_session_t session)
/*-
* _gnutls_record_set_default_version - Used to set the default version for the first record packet
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @major: is a tls major version
* @minor: is a tls minor version
*
@@ -735,7 +735,7 @@ _gnutls_record_set_default_version(gnutls_session_t session,
/*-
* _gnutls_hello_set_default_version - Used to set the default version for the first record packet
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @major: is a tls major version
* @minor: is a tls minor version
*
@@ -754,7 +754,7 @@ _gnutls_hello_set_default_version(gnutls_session_t session,
/**
* gnutls_handshake_set_private_extensions:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @allow: is an integer (0 or 1)
*
* This function will enable or disable the use of private cipher
@@ -1014,7 +1014,7 @@ _gnutls_prf_raw(gnutls_mac_algorithm_t mac,
/**
* gnutls_prf_raw:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @label_size: length of the @label variable.
* @label: label used in PRF computation, typically a short string.
* @seed_size: length of the @seed variable.
@@ -1062,7 +1062,7 @@ gnutls_prf_raw(gnutls_session_t session,
/**
* gnutls_prf:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @label_size: length of the @label variable.
* @label: label used in PRF computation, typically a short string.
* @server_random_first: non-zero if server random field should be first in seed
@@ -1131,7 +1131,7 @@ gnutls_prf(gnutls_session_t session,
/**
* gnutls_session_is_resumed:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Check whether session is resumed or not.
*
@@ -1162,7 +1162,7 @@ int gnutls_session_is_resumed(gnutls_session_t session)
/**
* gnutls_session_resumption_requested:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Check whether the client has asked for session resumption.
* This function is valid only on server side.
@@ -1180,7 +1180,7 @@ int gnutls_session_resumption_requested(gnutls_session_t session)
/*-
* _gnutls_session_is_psk - Used to check whether this session uses PSK kx
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return non zero if this session uses a PSK key
* exchange algorithm.
@@ -1200,7 +1200,7 @@ int _gnutls_session_is_psk(gnutls_session_t session)
/*-
* _gnutls_session_is_ecc - Used to check whether this session uses ECC kx
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function will return non zero if this session uses an elliptic
* curves key exchange exchange algorithm.
@@ -1220,7 +1220,7 @@ int _gnutls_session_is_ecc(gnutls_session_t session)
/**
* gnutls_session_get_ptr:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get user pointer for session. Useful in callbacks. This is the
* pointer set with gnutls_session_set_ptr().
@@ -1235,7 +1235,7 @@ void *gnutls_session_get_ptr(gnutls_session_t session)
/**
* gnutls_session_set_ptr:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @ptr: is the user pointer
*
* This function will set (associate) the user given pointer @ptr to
@@ -1250,7 +1250,7 @@ void gnutls_session_set_ptr(gnutls_session_t session, void *ptr)
/**
* gnutls_record_get_direction:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function provides information about the internals of the
* record protocol and is only useful if a prior gnutls function call
@@ -1275,7 +1275,7 @@ int gnutls_record_get_direction(gnutls_session_t session)
/*-
* _gnutls_rsa_pms_set_version - Sets a version to be used at the RSA PMS
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @major: is the major version to use
* @minor: is the minor version to use
*
@@ -1293,7 +1293,7 @@ _gnutls_rsa_pms_set_version(gnutls_session_t session,
/**
* gnutls_handshake_set_post_client_hello_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @func: is the function to be called
*
* This function will set a callback to be called after the client
@@ -1328,7 +1328,7 @@ gnutls_handshake_set_post_client_hello_function(gnutls_session_t session,
/**
* gnutls_session_enable_compatibility_mode:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* This function can be used to disable certain (security) features in
* TLS in order to maintain maximum compatibility with buggy
@@ -1348,7 +1348,7 @@ void gnutls_session_enable_compatibility_mode(gnutls_session_t session)
/**
* gnutls_session_channel_binding:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @cbtype: an #gnutls_channel_binding_t enumeration type
* @cb: output buffer array with data
*
@@ -1385,7 +1385,7 @@ gnutls_session_channel_binding(gnutls_session_t session,
/**
* gnutls_ecc_curve_get:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Returns the currently used elliptic curve. Only valid
* when using an elliptic curve ciphersuite.
@@ -1402,7 +1402,7 @@ gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t session)
/**
* gnutls_protocol_get_version:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
*
* Get TLS version, a #gnutls_protocol_t value.
*
@@ -1415,7 +1415,7 @@ gnutls_protocol_t gnutls_protocol_get_version(gnutls_session_t session)
/**
* gnutls_session_get_random:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @client: the client part of the random
* @server: the server part of the random
*
@@ -1453,7 +1453,7 @@ unsigned int timespec_sub_ms(struct timespec *a, struct timespec *b)
/**
* gnutls_handshake_set_random:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @random: a random value of 32-bytes
*
* This function will explicitly set the server or client hello
@@ -1489,7 +1489,7 @@ gnutls_handshake_set_random(gnutls_session_t session,
/**
* gnutls_handshake_set_hook_function:
- * @session: is a #gnutls_session_t structure
+ * @session: is a #gnutls_session_t type
* @htype: the %gnutls_handshake_description_t of the message to hook at
* @post: %GNUTLS_HOOK_* depending on when the hook function should be called
* @func: is the function to be called
@@ -1525,7 +1525,7 @@ gnutls_handshake_set_hook_function(gnutls_session_t session,
/**
* gnutls_record_get_state:
- * @session: is a #gnutls_session_t structure
+ * @session: is a #gnutls_session_t type
* @read: if non-zero the read parameters are returned, otherwise the write
* @mac_key: the key used for MAC (if a MAC is used)
* @IV: the initialization vector or nonce used
@@ -1581,7 +1581,7 @@ gnutls_record_get_state(gnutls_session_t session,
/**
* gnutls_record_set_state:
- * @session: is a #gnutls_session_t structure
+ * @session: is a #gnutls_session_t type
* @read: if non-zero the read parameters are returned, otherwise the write
* @seq_number: A 64-bit sequence number
*
diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c
index b2d1a3c258..344ade4e92 100644
--- a/lib/gnutls_ui.c
+++ b/lib/gnutls_ui.c
@@ -77,7 +77,7 @@ int gnutls_random_art(gnutls_random_art_t type,
#if defined(ENABLE_DHE) || defined(ENABLE_ANON)
/**
* gnutls_dh_set_prime_bits:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @bits: is the number of bits
*
* This function sets the number of bits, for use in a Diffie-Hellman
@@ -418,8 +418,8 @@ int gnutls_dh_get_peers_public_bits(gnutls_session_t session)
/**
* gnutls_certificate_set_dh_params:
- * @res: is a gnutls_certificate_credentials_t structure
- * @dh_params: is a structure that holds Diffie-Hellman parameters.
+ * @res: is a gnutls_certificate_credentials_t type
+ * @dh_params: the Diffie-Hellman parameters.
*
* This function will set the Diffie-Hellman parameters for a
* certificate server to use. These parameters will be used in
@@ -599,7 +599,7 @@ gnutls_fingerprint(gnutls_digest_algorithm_t algo,
/**
* gnutls_certificate_set_params_function:
- * @res: is a gnutls_certificate_credentials_t structure
+ * @res: is a gnutls_certificate_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
@@ -615,7 +615,7 @@ gnutls_certificate_set_params_function(gnutls_certificate_credentials_t
/**
* gnutls_certificate_set_verify_flags:
- * @res: is a gnutls_certificate_credentials_t structure
+ * @res: is a gnutls_certificate_credentials_t type
* @flags: are the flags
*
* This function will set the flags to be used for verification
@@ -632,7 +632,7 @@ gnutls_certificate_set_verify_flags(gnutls_certificate_credentials_t
/**
* gnutls_certificate_get_verify_flags:
- * @res: is a gnutls_certificate_credentials_t structure
+ * @res: is a gnutls_certificate_credentials_t type
*
* Returns the verification flags set with
* gnutls_certificate_set_verify_flags().
@@ -649,7 +649,7 @@ gnutls_certificate_get_verify_flags(gnutls_certificate_credentials_t res)
/**
* gnutls_certificate_set_verify_limits:
- * @res: is a gnutls_certificate_credentials structure
+ * @res: is a gnutls_certificate_credentials type
* @max_bits: is the number of bits of an acceptable certificate (default 8200)
* @max_depth: is maximum depth of the verification of a certificate chain (default 5)
*
@@ -670,7 +670,7 @@ gnutls_certificate_set_verify_limits(gnutls_certificate_credentials_t res,
#ifdef ENABLE_PSK
/**
* gnutls_psk_set_params_function:
- * @res: is a gnutls_psk_server_credentials_t structure
+ * @res: is a gnutls_psk_server_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
@@ -688,7 +688,7 @@ gnutls_psk_set_params_function(gnutls_psk_server_credentials_t res,
#ifdef ENABLE_ANON
/**
* gnutls_anon_set_params_function:
- * @res: is a gnutls_anon_server_credentials_t structure
+ * @res: is a gnutls_anon_server_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
@@ -870,7 +870,7 @@ char *gnutls_session_get_desc(gnutls_session_t session)
/**
* gnutls_session_set_id:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @sid: the session identifier
*
* This function sets the session ID to be used in a client hello.
diff --git a/lib/gnutls_x509.c b/lib/gnutls_x509.c
index 2ada8f303e..bf1b125d1c 100644
--- a/lib/gnutls_x509.c
+++ b/lib/gnutls_x509.c
@@ -860,13 +860,13 @@ read_key_file(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_key_mem:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @cert: contains a certificate list (path) for the specified private key
* @key: is the private key, or %NULL
* @type: is PEM or DER
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be called
+ * gnutls_certificate_credentials_t type. This function may be called
* more than once, in case multiple keys/certificates exist for the
* server.
*
@@ -894,7 +894,7 @@ gnutls_certificate_set_x509_key_mem(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_key_mem2:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @cert: contains a certificate list (path) for the specified private key
* @key: is the private key, or %NULL
* @type: is PEM or DER
@@ -902,7 +902,7 @@ gnutls_certificate_set_x509_key_mem(gnutls_certificate_credentials_t res,
* @flags: an ORed sequence of gnutls_pkcs_encrypt_flags_t
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be called
+ * gnutls_certificate_credentials_t type. This function may be called
* more than once, in case multiple keys/certificates exist for the
* server.
*
@@ -988,13 +988,13 @@ certificate_credentials_append_pkey(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_key:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @cert_list: contains a certificate list (path) for the specified private key
* @cert_list_size: holds the size of the certificate list
* @key: is a #gnutls_x509_privkey_t key
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be
+ * gnutls_certificate_credentials_t type. This function may be
* called more than once, in case multiple keys/certificates exist for
* the server. For clients that wants to send more than their own end
* entity certificate (e.g., also an intermediate CA cert) then put
@@ -1003,7 +1003,7 @@ certificate_credentials_append_pkey(gnutls_certificate_credentials_t res,
* Note that the certificates and keys provided, can be safely deinitialized
* after this function is called.
*
- * If that function fails to load the @res structure is at an undefined state, it must
+ * If that function fails to load the @res type is at an undefined state, it must
* not be reused to load other keys or certificates.
*
* Returns: %GNUTLS_E_SUCCESS (0) on success, or a negative error code.
@@ -1095,7 +1095,7 @@ gnutls_certificate_set_x509_key(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_get_x509_key:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @index: The index of the key to obtain.
* @key: Location to store the key.
*
@@ -1130,7 +1130,7 @@ gnutls_certificate_get_x509_key(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_get_x509_crt:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @index: The index of the certificate list to obtain.
* @crt_list: Where to store the certificate list.
* @crt_list_size: Will hold the number of certificates.
@@ -1193,7 +1193,7 @@ gnutls_certificate_get_x509_crt(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_key:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @names: is an array of DNS name of the certificate (NULL if none)
* @names_size: holds the size of the names list
* @pcert_list: contains a certificate list (path) for the specified private key
@@ -1201,7 +1201,7 @@ gnutls_certificate_get_x509_crt(gnutls_certificate_credentials_t res,
* @key: is a #gnutls_privkey_t key
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be
+ * gnutls_certificate_credentials_t type. This function may be
* called more than once, in case multiple keys/certificates exist for
* the server. For clients that wants to send more than its own end
* entity certificate (e.g., also an intermediate CA cert) then put
@@ -1209,7 +1209,7 @@ gnutls_certificate_get_x509_crt(gnutls_certificate_credentials_t res,
*
* Note that the @pcert_list and @key will become part of the credentials
* structure and must not be deallocated. They will be automatically deallocated
- * when the @res structure is deinitialized.
+ * when the @res type is deinitialized.
*
* If that function fails to load the @res structure is at an undefined state, it must
* not be reused to load other keys or certificates.
@@ -1277,11 +1277,11 @@ gnutls_certificate_set_key(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_trust_list:
- * @res: is a #gnutls_certificate_credentials_t structure.
- * @tlist: is a #gnutls_x509_trust_list_t structure
+ * @res: is a #gnutls_certificate_credentials_t type.
+ * @tlist: is a #gnutls_x509_trust_list_t type
* @flags: must be zero
*
- * This function sets a trust list in the gnutls_certificate_credentials_t structure.
+ * This function sets a trust list in the gnutls_certificate_credentials_t type.
*
* Note that the @tlist will become part of the credentials
* structure and must not be deallocated. It will be automatically deallocated
@@ -1303,7 +1303,7 @@ gnutls_certificate_set_trust_list(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_get_trust_list:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @tlist: Location where to store the trust list.
*
* Obtains the list of trusted certificates stored in @res and writes a
@@ -1322,14 +1322,14 @@ gnutls_certificate_get_trust_list(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_key_file:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @certfile: is a file that containing the certificate list (path) for
* the specified private key, in PKCS7 format, or a list of certificates
* @keyfile: is a file that contains the private key
* @type: is PEM or DER
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be
+ * gnutls_certificate_credentials_t type. This function may be
* called more than once, in case multiple keys/certificates exist for
* the server. For clients that need to send more than its own end
* entity certificate, e.g., also an intermediate CA cert, then the
@@ -1366,7 +1366,7 @@ gnutls_certificate_set_x509_key_file(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_key_file2:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @certfile: is a file that containing the certificate list (path) for
* the specified private key, in PKCS7 format, or a list of certificates
* @keyfile: is a file that contains the private key
@@ -1375,7 +1375,7 @@ gnutls_certificate_set_x509_key_file(gnutls_certificate_credentials_t res,
* @flags: an ORed sequence of gnutls_pkcs_encrypt_flags_t
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be
+ * gnutls_certificate_credentials_t type. This function may be
* called more than once, in case multiple keys/certificates exist for
* the server. For clients that need to send more than its own end
* entity certificate, e.g., also an intermediate CA cert, then the
@@ -1487,7 +1487,7 @@ _gnutls_check_key_usage(const gnutls_pcert_st * cert,
/**
* gnutls_certificate_set_x509_trust_mem:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @ca: is a list of trusted CAs or a DER certificate
* @type: is DER or PEM
*
@@ -1521,7 +1521,7 @@ int ret;
/**
* gnutls_certificate_set_x509_trust:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @ca_list: is a list of trusted CAs
* @ca_list_size: holds the size of the CA list
*
@@ -1582,7 +1582,7 @@ gnutls_certificate_set_x509_trust(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_trust_file:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
* @cafile: is a file containing the list of trusted CAs (DER or PEM list)
* @type: is PEM or DER
*
@@ -1619,7 +1619,7 @@ int ret;
/**
* gnutls_certificate_set_x509_trust_dir:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
* @ca_dir: is a directory containing the list of trusted CAs (DER or PEM list)
* @type: is PEM or DER
*
@@ -1650,7 +1650,7 @@ int ret;
/**
* gnutls_certificate_set_x509_system_trust:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
*
* This function adds the system's default trusted CAs in order to
* verify client or server certificates.
@@ -1673,7 +1673,7 @@ gnutls_certificate_set_x509_system_trust(gnutls_certificate_credentials_t
/**
* gnutls_certificate_set_x509_crl_mem:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @CRL: is a list of trusted CRLs. They should have been verified before.
* @type: is DER or PEM
*
@@ -1702,7 +1702,7 @@ int ret;
/**
* gnutls_certificate_set_x509_crl:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @crl_list: is a list of trusted CRLs. They should have been verified before.
* @crl_list_size: holds the size of the crl_list
*
@@ -1757,7 +1757,7 @@ gnutls_certificate_set_x509_crl(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_set_x509_crl_file:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @crlfile: is a file containing the list of verified CRLs (DER or PEM list)
* @type: is PEM or DER
*
@@ -1789,13 +1789,13 @@ int ret;
/**
* gnutls_certificate_set_x509_simple_pkcs12_file:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @pkcs12file: filename of file containing PKCS#12 blob.
* @type: is PEM or DER of the @pkcs12file.
* @password: optional password used to decrypt PKCS#12 file, bags and keys.
*
* This function sets a certificate/private key pair and/or a CRL in
- * the gnutls_certificate_credentials_t structure. This function may
+ * the gnutls_certificate_credentials_t type. This function may
* be called more than once (in case multiple keys/certificates exist
* for the server).
*
@@ -1845,13 +1845,13 @@ int
/**
* gnutls_certificate_set_x509_simple_pkcs12_mem:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @p12blob: the PKCS#12 blob.
* @type: is PEM or DER of the @pkcs12file.
* @password: optional password used to decrypt PKCS#12 file, bags and keys.
*
* This function sets a certificate/private key pair and/or a CRL in
- * the gnutls_certificate_credentials_t structure. This function may
+ * the gnutls_certificate_credentials_t type. This function may
* be called more than once (in case multiple keys/certificates exist
* for the server).
*
@@ -1961,7 +1961,7 @@ int
/**
* gnutls_certificate_free_crls:
- * @sc: is a #gnutls_certificate_credentials_t structure.
+ * @sc: is a #gnutls_certificate_credentials_t type.
*
* This function will delete all the CRLs associated
* with the given credentials.
@@ -1974,7 +1974,7 @@ void gnutls_certificate_free_crls(gnutls_certificate_credentials_t sc)
/**
* gnutls_certificate_credentials_t:
- * @cred: is a #gnutls_certificate_credentials_t structure.
+ * @cred: is a #gnutls_certificate_credentials_t type.
* @fn: A PIN callback
* @userdata: Data to be passed in the callback
*
diff --git a/lib/openpgp/extras.c b/lib/openpgp/extras.c
index 484406ae7f..114cae1372 100644
--- a/lib/openpgp/extras.c
+++ b/lib/openpgp/extras.c
@@ -36,7 +36,7 @@
/**
* gnutls_openpgp_keyring_init:
- * @keyring: The structure to be initialized
+ * @keyring: A pointer to the type to be initialized
*
* This function will initialize an keyring structure.
*
@@ -54,7 +54,7 @@ int gnutls_openpgp_keyring_init(gnutls_openpgp_keyring_t * keyring)
/**
* gnutls_openpgp_keyring_deinit:
- * @keyring: The structure to be initialized
+ * @keyring: A pointer to the type to be initialized
*
* This function will deinitialize a keyring structure.
**/
@@ -251,7 +251,7 @@ int gnutls_openpgp_keyring_get_crt_count(gnutls_openpgp_keyring_t ring)
* gnutls_openpgp_keyring_get_crt:
* @ring: Holds the keyring.
* @idx: the index of the certificate to export
- * @cert: An uninitialized #gnutls_openpgp_crt_t structure
+ * @cert: An uninitialized #gnutls_openpgp_crt_t type
*
* This function will extract an OpenPGP certificate from the given
* keyring. If the index given is out of range
diff --git a/lib/openpgp/gnutls_openpgp.c b/lib/openpgp/gnutls_openpgp.c
index d609a55de1..4c30d7487b 100644
--- a/lib/openpgp/gnutls_openpgp.c
+++ b/lib/openpgp/gnutls_openpgp.c
@@ -63,12 +63,12 @@ int _gnutls_map_cdk_rc(int rc)
/**
* gnutls_certificate_set_openpgp_key:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @crt: contains an openpgp public key
* @pkey: is an openpgp private key
*
* This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be
+ * gnutls_certificate_credentials_t type. This function may be
* called more than once (in case multiple keys/certificates exist
* for the server).
*
@@ -168,7 +168,7 @@ gnutls_certificate_set_openpgp_key(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_get_openpgp_key:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @index: The index of the key to obtain.
* @key: Location to store the key.
*
@@ -204,7 +204,7 @@ gnutls_certificate_get_openpgp_key(gnutls_certificate_credentials_t res,
/**
* gnutls_certificate_get_openpgp_crt:
- * @res: is a #gnutls_certificate_credentials_t structure.
+ * @res: is a #gnutls_certificate_credentials_t type.
* @index: The index of the certificate list to obtain.
* @crt_list: Where to store the certificate list.
* @key: Will hold the number of certificates.
@@ -690,8 +690,8 @@ gnutls_certificate_set_openpgp_keyring_mem(gnutls_certificate_credentials_t
/*-
* _gnutls_openpgp_request_key - Receives a key from a database, key server etc
- * @ret - a pointer to gnutls_datum_t structure.
- * @cred - a gnutls_certificate_credentials_t structure.
+ * @ret - a pointer to gnutls_datum_t type.
+ * @cred - a gnutls_certificate_credentials_t type.
* @key_fingerprint - The keyFingerprint
* @key_fingerprint_size - the size of the fingerprint
*
diff --git a/lib/openpgp/pgp.c b/lib/openpgp/pgp.c
index d5ef2722be..69f68b2130 100644
--- a/lib/openpgp/pgp.c
+++ b/lib/openpgp/pgp.c
@@ -34,7 +34,7 @@
/**
* gnutls_openpgp_crt_init:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
* This function will initialize an OpenPGP key structure.
*
@@ -51,7 +51,7 @@ int gnutls_openpgp_crt_init(gnutls_openpgp_crt_t * key)
/**
* gnutls_openpgp_crt_deinit:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
* This function will deinitialize a key structure.
**/
@@ -583,7 +583,7 @@ int gnutls_openpgp_crt_get_revoked_status(gnutls_openpgp_crt_t key)
/**
* gnutls_openpgp_crt_check_hostname:
- * @key: should contain a #gnutls_openpgp_crt_t structure
+ * @key: should contain a #gnutls_openpgp_crt_t type
* @hostname: A null terminated string that contains a DNS name
*
* This function will check if the given key's owner matches the
@@ -601,7 +601,7 @@ gnutls_openpgp_crt_check_hostname(gnutls_openpgp_crt_t key,
/**
* gnutls_openpgp_crt_check_hostname2:
- * @key: should contain a #gnutls_openpgp_crt_t structure
+ * @key: should contain a #gnutls_openpgp_crt_t type
* @hostname: A null terminated string that contains a DNS name
* @flags: gnutls_certificate_verify_flags
*
@@ -665,7 +665,7 @@ unsigned int _gnutls_get_pgp_key_usage(unsigned int cdk_usage)
/**
* gnutls_openpgp_crt_get_key_usage:
- * @key: should contain a gnutls_openpgp_crt_t structure
+ * @key: should contain a gnutls_openpgp_crt_t type
* @key_usage: where the key usage bits will be stored
*
* This function will return certificate's key usage, by checking the
@@ -1116,7 +1116,7 @@ gnutls_openpgp_crt_get_subkey_idx(gnutls_openpgp_crt_t key,
/**
* gnutls_openpgp_crt_get_subkey_usage:
- * @key: should contain a gnutls_openpgp_crt_t structure
+ * @key: should contain a gnutls_openpgp_crt_t type
* @idx: the subkey index
* @key_usage: where the key usage bits will be stored
*
diff --git a/lib/openpgp/privkey.c b/lib/openpgp/privkey.c
index 6aa6fb5436..a9627f63f1 100644
--- a/lib/openpgp/privkey.c
+++ b/lib/openpgp/privkey.c
@@ -35,7 +35,7 @@
/**
* gnutls_openpgp_privkey_init:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
* This function will initialize an OpenPGP key structure.
*
@@ -52,7 +52,7 @@ int gnutls_openpgp_privkey_init(gnutls_openpgp_privkey_t * key)
/**
* gnutls_openpgp_privkey_deinit:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
* This function will deinitialize a key structure.
**/
@@ -70,7 +70,7 @@ void gnutls_openpgp_privkey_deinit(gnutls_openpgp_privkey_t key)
}
/*-
- * _gnutls_openpgp_privkey_cpy - This function copies a gnutls_openpgp_privkey_t structure
+ * _gnutls_openpgp_privkey_cpy - This function copies a gnutls_openpgp_privkey_t type
* @dest: The structure where to copy
* @src: The structure to be copied
*
diff --git a/lib/pkcs11.c b/lib/pkcs11.c
index b32ba5ba40..c4efae061b 100644
--- a/lib/pkcs11.c
+++ b/lib/pkcs11.c
@@ -384,7 +384,7 @@ int add_obj_attrs(struct p11_kit_uri *info, struct ck_attribute a[4], unsigned *
/**
* gnutls_pkcs11_obj_set_info:
- * @obj: should contain a #gnutls_pkcs11_obj_t structure
+ * @obj: should contain a #gnutls_pkcs11_obj_t type
* @itype: Denotes the type of information to be set
* @data: the data to set
* @data_size: the size of data
@@ -511,7 +511,7 @@ gnutls_pkcs11_obj_set_info(gnutls_pkcs11_obj_t obj,
/**
* gnutls_pkcs11_obj_get_info:
- * @obj: should contain a #gnutls_pkcs11_obj_t structure
+ * @obj: should contain a #gnutls_pkcs11_obj_t type
* @itype: Denotes the type of information requested
* @output: where output will be stored
* @output_size: contains the maximum size of the output and will be overwritten with actual
@@ -958,7 +958,7 @@ pkcs11_info_to_url(struct p11_kit_uri *info,
/**
* gnutls_pkcs11_obj_init:
- * @obj: The structure to be initialized
+ * @obj: A pointer to the type to be initialized
*
* This function will initialize a pkcs11 certificate structure.
*
@@ -1009,7 +1009,7 @@ gnutls_pkcs11_obj_set_pin_function(gnutls_pkcs11_obj_t obj,
/**
* gnutls_pkcs11_obj_deinit:
- * @obj: The structure to be initialized
+ * @obj: A pointer to the type to be initialized
*
* This function will deinitialize a certificate structure.
*
@@ -1426,7 +1426,7 @@ static gnutls_pkcs11_obj_type_t pkcs11_class_to_type(ck_object_class_t class)
}
}
-/* imports an object from a token to a pkcs11_obj_t structure.
+/* imports an object from a token to a pkcs11_obj_t type.
*/
static int
pkcs11_obj_import(ck_object_class_t class, gnutls_pkcs11_obj_t obj,
@@ -1965,7 +1965,7 @@ unsigned int pkcs11_obj_flags_to_int(unsigned int flags)
* @flags: Or sequence of GNUTLS_PKCS11_OBJ_* flags
*
* This function will "import" a PKCS 11 URL identifying an object (e.g. certificate)
- * to the #gnutls_pkcs11_obj_t structure. This does not involve any
+ * to the #gnutls_pkcs11_obj_t type. This does not involve any
* parsing (such as X.509 or OpenPGP) since the #gnutls_pkcs11_obj_t is
* format agnostic. Only data are transferred.
*
@@ -3034,7 +3034,7 @@ gnutls_x509_crt_import_pkcs11(gnutls_x509_crt_t crt,
* @flags: One of GNUTLS_PKCS11_OBJ_* flags
*
* This function will import a PKCS 11 certificate directly from a token
- * without involving the #gnutls_pkcs11_obj_t structure. This function will
+ * without involving the #gnutls_pkcs11_obj_t type. This function will
* fail if the certificate stored is not of X.509 type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
@@ -3087,7 +3087,7 @@ _gnutls_x509_crt_import_pkcs11_url(gnutls_x509_crt_t crt,
* @flags: 0 for now
*
* This function will import a PKCS 11 certificate list to a list of
- * #gnutls_x509_crt_t structure. These must not be initialized.
+ * #gnutls_x509_crt_t type. These must not be initialized.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -3859,12 +3859,12 @@ int gnutls_pkcs11_crt_is_known(const char *url, gnutls_x509_crt_t cert,
/**
* gnutls_pkcs11_obj_get_flags:
- * @obj: The structure that holds the object
+ * @obj: The pkcs11 object
* @oflags: Will hold the output flags
*
- * This function will return the flags of the object being
- * stored in the structure. The @oflags are the %GNUTLS_PKCS11_OBJ_FLAG_MARK
- * flags.
+ * This function will return the flags of the object.
+ * The @oflags will be flags from %gnutls_pkcs11_obj_flags. That is,
+ * the %GNUTLS_PKCS11_OBJ_FLAG_MARK_* flags.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
diff --git a/lib/pkcs11_privkey.c b/lib/pkcs11_privkey.c
index 9bf8737478..dacc62476f 100644
--- a/lib/pkcs11_privkey.c
+++ b/lib/pkcs11_privkey.c
@@ -76,7 +76,7 @@ struct gnutls_pkcs11_privkey_st {
/**
* gnutls_pkcs11_privkey_init:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
* This function will initialize an private key structure.
*
@@ -125,7 +125,7 @@ gnutls_pkcs11_privkey_cpy(gnutls_pkcs11_privkey_t dst,
/**
* gnutls_pkcs11_privkey_deinit:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
* This function will deinitialize a private key structure.
**/
@@ -140,7 +140,7 @@ void gnutls_pkcs11_privkey_deinit(gnutls_pkcs11_privkey_t key)
/**
* gnutls_pkcs11_privkey_get_pk_algorithm:
- * @key: should contain a #gnutls_pkcs11_privkey_t structure
+ * @key: should contain a #gnutls_pkcs11_privkey_t type
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
* This function will return the public key algorithm of a private
@@ -160,7 +160,7 @@ gnutls_pkcs11_privkey_get_pk_algorithm(gnutls_pkcs11_privkey_t key,
/**
* gnutls_pkcs11_privkey_get_info:
- * @pkey: should contain a #gnutls_pkcs11_privkey_t structure
+ * @pkey: should contain a #gnutls_pkcs11_privkey_t type
* @itype: Denotes the type of information requested
* @output: where output will be stored
* @output_size: contains the maximum size of the output and will be overwritten with actual
@@ -377,12 +377,12 @@ int gnutls_pkcs11_privkey_status(gnutls_pkcs11_privkey_t key)
/**
* gnutls_pkcs11_privkey_import_url:
- * @pkey: The structure to store the parsed key
+ * @pkey: The private key
* @url: a PKCS 11 url identifying the key
* @flags: Or sequence of GNUTLS_PKCS11_OBJ_* flags
*
* This function will "import" a PKCS 11 URL identifying a private
- * key to the #gnutls_pkcs11_privkey_t structure. In reality since
+ * key to the #gnutls_pkcs11_privkey_t type. In reality since
* in most cases keys cannot be exported, the private key structure
* is being associated with the available operations on the token.
*
diff --git a/lib/pkcs11x.c b/lib/pkcs11x.c
index 86657cd253..3b1d42c99c 100644
--- a/lib/pkcs11x.c
+++ b/lib/pkcs11x.c
@@ -230,7 +230,7 @@ find_ext_cb(struct pkcs11_session_info *sinfo,
/**
* gnutls_pkcs11_obj_get_ext:
- * @obj: should contain a #gnutls_pkcs11_obj_t structure
+ * @obj: should contain a #gnutls_pkcs11_obj_t type
* @exts: an allocated list of pointers to %gnutls_x509_ext_st
* @exts_size: the number of @exts
* @flags: Or sequence of %GNUTLS_PKCS11_OBJ_* flags
diff --git a/lib/system-keys-win.c b/lib/system-keys-win.c
index 441d506e38..992ec6d878 100644
--- a/lib/system-keys-win.c
+++ b/lib/system-keys-win.c
@@ -320,7 +320,7 @@ static int cng_info(gnutls_privkey_t key, unsigned int flags, void *userdata)
* @url: The URL of the key
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
diff --git a/lib/system_override.c b/lib/system_override.c
index 8530471721..7fad645830 100644
--- a/lib/system_override.c
+++ b/lib/system_override.c
@@ -41,7 +41,7 @@
/**
* gnutls_transport_set_errno:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @err: error value to store in session-specific errno variable.
*
* Store @err in the session-specific errno variable. Useful values
@@ -63,7 +63,7 @@ void gnutls_transport_set_errno(gnutls_session_t session, int err)
/**
* gnutls_transport_set_pull_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @pull_func: a callback function similar to read()
*
* This is the function where you set a function for gnutls to receive
@@ -84,7 +84,7 @@ gnutls_transport_set_pull_function(gnutls_session_t session,
/**
* gnutls_transport_set_pull_timeout_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @func: a callback function
*
* This is the function where you set a function for gnutls to know
@@ -114,7 +114,7 @@ gnutls_transport_set_pull_timeout_function(gnutls_session_t session,
/**
* gnutls_transport_set_push_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @push_func: a callback function similar to write()
*
* This is the function where you set a push function for gnutls to
@@ -139,7 +139,7 @@ gnutls_transport_set_push_function(gnutls_session_t session,
/**
* gnutls_transport_set_vec_push_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @vec_func: a callback function similar to writev()
*
* Using this function you can override the default writev(2)
@@ -162,7 +162,7 @@ gnutls_transport_set_vec_push_function(gnutls_session_t session,
/**
* gnutls_transport_set_errno_function:
- * @session: is a #gnutls_session_t structure.
+ * @session: is a #gnutls_session_t type.
* @errno_func: a callback function similar to write()
*
* This is the function where you set a function to retrieve errno
diff --git a/lib/tpm.c b/lib/tpm.c
index f085c93d09..5cd77e7e20 100644
--- a/lib/tpm.c
+++ b/lib/tpm.c
@@ -552,7 +552,7 @@ import_tpm_key(gnutls_privkey_t pkey,
* @flags: should be zero
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* With respect to passwords the same as in gnutls_privkey_import_tpm_url() apply.
*
@@ -819,7 +819,7 @@ static int decode_tpmkey_url(const char *url, struct tpmkey_url_st *s)
* @flags: One of the GNUTLS_PRIVKEY_* flags
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* Note that unless %GNUTLS_PRIVKEY_DISABLE_CALLBACKS
* is specified, if incorrect (or NULL) passwords are given
@@ -1080,7 +1080,7 @@ gnutls_pubkey_import_tpm_raw(gnutls_pubkey_t pkey,
* @flags: should be zero
*
* This function will import the given private key to the abstract
- * #gnutls_privkey_t structure.
+ * #gnutls_privkey_t type.
*
* Note that unless %GNUTLS_PUBKEY_DISABLE_CALLBACKS
* is specified, if incorrect (or NULL) passwords are given
diff --git a/lib/verify-tofu.c b/lib/verify-tofu.c
index 8ef81eef36..1dd7c45395 100644
--- a/lib/verify-tofu.c
+++ b/lib/verify-tofu.c
@@ -706,7 +706,7 @@ static int find_config_file(char *file, size_t max_size)
/**
* gnutls_tdb_init:
- * @tdb: The structure to be initialized
+ * @tdb: A pointer to the type to be initialized
*
* This function will initialize a public key trust storage structure.
*
diff --git a/lib/x509/crl.c b/lib/x509/crl.c
index 3b70d92819..cb9bda5a86 100644
--- a/lib/x509/crl.c
+++ b/lib/x509/crl.c
@@ -54,7 +54,7 @@ int result;
/**
* gnutls_x509_crl_init:
- * @crl: The structure to be initialized
+ * @crl: A pointer to the type to be initialized
*
* This function will initialize a CRL structure. CRL stands for
* Certificate Revocation List. A revocation list usually contains
@@ -85,7 +85,7 @@ int gnutls_x509_crl_init(gnutls_x509_crl_t * crl)
/**
* gnutls_x509_crl_deinit:
- * @crl: The structure to be deinitialized
+ * @crl: The data to be deinitialized
*
* This function will deinitialize a CRL structure.
**/
@@ -103,7 +103,7 @@ void gnutls_x509_crl_deinit(gnutls_x509_crl_t crl)
/**
* gnutls_x509_crl_import:
- * @crl: The structure to store the parsed CRL.
+ * @crl: The data to store the parsed CRL.
* @data: The DER or PEM encoded CRL.
* @format: One of DER or PEM
*
@@ -183,7 +183,7 @@ gnutls_x509_crl_import(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_issuer_dn:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @buf: a pointer to a structure to hold the peer's name (may be null)
* @sizeof_buf: initially holds the size of @buf
*
@@ -215,7 +215,7 @@ gnutls_x509_crl_get_issuer_dn(const gnutls_x509_crl_t crl, char *buf,
/**
* gnutls_x509_crl_get_issuer_dn_by_oid:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one.
* @raw_flag: If non-zero returns the raw DER data of the DN part.
@@ -265,9 +265,9 @@ gnutls_x509_crl_get_issuer_dn_by_oid(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_dn_oid:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @indx: Specifies which DN OID to send. Use (0) to get the first one.
- * @oid: a pointer to a structure to hold the name (may be null)
+ * @oid: a pointer to store the OID (may be null)
* @sizeof_oid: initially holds the size of 'oid'
*
* This function will extract the requested OID of the name of the CRL
@@ -295,7 +295,7 @@ gnutls_x509_crl_get_dn_oid(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_issuer_dn2:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @dn: a pointer to a structure to hold the name
*
* This function will allocate buffer and copy the name of the CRL issuer.
@@ -322,7 +322,7 @@ gnutls_x509_crl_get_issuer_dn2(gnutls_x509_crl_t crl, gnutls_datum_t * dn)
/**
* gnutls_x509_crl_get_signature_algorithm:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
*
* This function will return a value of the #gnutls_sign_algorithm_t
* enumeration that is the signature algorithm.
@@ -362,7 +362,7 @@ int gnutls_x509_crl_get_signature_algorithm(gnutls_x509_crl_t crl)
/**
* gnutls_x509_crl_get_signature:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @sig: a pointer where the signature part will be copied (may be null).
* @sizeof_sig: initially holds the size of @sig
*
@@ -416,7 +416,7 @@ gnutls_x509_crl_get_signature(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_version:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
*
* This function will return the version of the specified CRL.
*
@@ -445,7 +445,7 @@ int gnutls_x509_crl_get_version(gnutls_x509_crl_t crl)
/**
* gnutls_x509_crl_get_this_update:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
*
* This function will return the time this CRL was issued.
*
@@ -464,7 +464,7 @@ time_t gnutls_x509_crl_get_this_update(gnutls_x509_crl_t crl)
/**
* gnutls_x509_crl_get_next_update:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
*
* This function will return the time the next CRL will be issued.
* This field is optional in a CRL so it might be normal to get an
@@ -485,7 +485,7 @@ time_t gnutls_x509_crl_get_next_update(gnutls_x509_crl_t crl)
/**
* gnutls_x509_crl_get_crt_count:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
*
* This function will return the number of revoked certificates in the
* given CRL.
@@ -517,7 +517,7 @@ int gnutls_x509_crl_get_crt_count(gnutls_x509_crl_t crl)
/**
* gnutls_x509_crl_get_crt_serial:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @indx: the index of the certificate to extract (starting from 0)
* @serial: where the serial number will be copied
* @serial_size: initially holds the size of serial
@@ -575,9 +575,9 @@ gnutls_x509_crl_get_crt_serial(gnutls_x509_crl_t crl, int indx,
/**
* gnutls_x509_crl_iter_deinit:
- * @iter: The iterator structure to be deinitialized
+ * @iter: The iterator to be deinitialized
*
- * This function will deinitialize an iterator structure.
+ * This function will deinitialize an iterator type.
**/
void gnutls_x509_crl_iter_deinit(gnutls_x509_crl_iter_t iter)
{
@@ -589,7 +589,7 @@ void gnutls_x509_crl_iter_deinit(gnutls_x509_crl_iter_t iter)
/**
* gnutls_x509_crl_iter_crt_serial:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @iter: A pointer to an iterator (initially the iterator should be %NULL)
* @serial: where the serial number will be copied
* @serial_size: initially holds the size of serial
@@ -675,7 +675,7 @@ gnutls_x509_crl_iter_crt_serial(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_raw_issuer_dn:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @dn: will hold the starting point of the DN
*
* This function will return a pointer to the DER encoded DN structure
@@ -761,9 +761,9 @@ gnutls_x509_crl_export2(gnutls_x509_crl_t crl,
}
/*-
- * _gnutls_x509_crl_cpy - This function copies a gnutls_x509_crl_t structure
- * @dest: The structure where to copy
- * @src: The structure to be copied
+ * _gnutls_x509_crl_cpy - This function copies a gnutls_x509_crl_t type
+ * @dest: The data where to copy
+ * @src: The data to be copied
*
* This function will copy an X.509 certificate structure.
*
@@ -839,7 +839,7 @@ _get_authority_key_id(gnutls_x509_crl_t cert, ASN1_TYPE * c2,
/**
* gnutls_x509_crl_get_authority_key_gn_serial:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @alt: is the place where the alternative name will be copied to
* @alt_size: holds the size of alt.
@@ -911,7 +911,7 @@ gnutls_x509_crl_get_authority_key_gn_serial(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_authority_key_id:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @id: The place where the identifier will be copied
* @id_size: Holds the size of the result field.
* @critical: will be non-zero if the extension is marked as critical
@@ -963,7 +963,7 @@ gnutls_x509_crl_get_authority_key_id(gnutls_x509_crl_t crl, void *id,
/**
* gnutls_x509_crl_get_number:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @ret: The place where the number will be copied
* @ret_size: Holds the size of the result field.
* @critical: will be non-zero if the extension is marked as critical
@@ -1021,9 +1021,9 @@ gnutls_x509_crl_get_number(gnutls_x509_crl_t crl, void *ret,
/**
* gnutls_x509_crl_get_extension_oid:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @indx: Specifies which extension OID to send, use (0) to get the first one.
- * @oid: a pointer to a structure 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
*
* This function will return the requested extension OID in the CRL.
@@ -1060,9 +1060,9 @@ gnutls_x509_crl_get_extension_oid(gnutls_x509_crl_t crl, int indx,
/**
* gnutls_x509_crl_get_extension_info:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @indx: Specifies which extension OID to send, 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.
@@ -1134,7 +1134,7 @@ gnutls_x509_crl_get_extension_info(gnutls_x509_crl_t crl, int indx,
/**
* gnutls_x509_crl_get_extension_data:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @indx: Specifies which extension OID to send. Use (0) to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
* @sizeof_data: initially holds the size of @oid
@@ -1186,7 +1186,7 @@ gnutls_x509_crl_get_extension_data(gnutls_x509_crl_t crl, int indx,
/**
* gnutls_x509_crl_list_import2:
- * @crls: The structures to store the parsed crl list. Must not be initialized.
+ * @crls: Will contain the parsed crl list.
* @size: It will contain the size of the list.
* @data: The PEM encoded CRL.
* @format: One of DER or PEM.
@@ -1248,7 +1248,7 @@ gnutls_x509_crl_list_import2(gnutls_x509_crl_t ** crls,
/**
* gnutls_x509_crl_list_import:
- * @crls: The structures to store the parsed CRLs. Must not be initialized.
+ * @crls: Indicates where the parsed CRLs will be copied to. Must not be initialized.
* @crl_max: Initially must hold the maximum number of crls. It will be updated with the number of crls available.
* @data: The PEM encoded CRLs
* @format: One of DER or PEM.
diff --git a/lib/x509/crl_write.c b/lib/x509/crl_write.c
index 24d5bf029d..e87b7dc863 100644
--- a/lib/x509/crl_write.c
+++ b/lib/x509/crl_write.c
@@ -38,7 +38,7 @@ static void disable_optional_stuff(gnutls_x509_crl_t crl);
/**
* gnutls_x509_crl_set_version:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @version: holds the version number. For CRLv1 crls must be 1.
*
* This function will set the version of the CRL. This
@@ -74,7 +74,7 @@ gnutls_x509_crl_set_version(gnutls_x509_crl_t crl, unsigned int version)
/**
* gnutls_x509_crl_sign2:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @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 the safe choice unless you know what you're doing.
@@ -132,7 +132,7 @@ gnutls_x509_crl_sign2(gnutls_x509_crl_t crl, gnutls_x509_crt_t issuer,
/**
* gnutls_x509_crl_sign:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
*
@@ -154,7 +154,7 @@ gnutls_x509_crl_sign(gnutls_x509_crl_t crl, gnutls_x509_crt_t issuer,
/**
* gnutls_x509_crl_set_this_update:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @act_time: The actual time
*
* This function will set the time this CRL was issued.
@@ -175,7 +175,7 @@ int gnutls_x509_crl_set_this_update(gnutls_x509_crl_t crl, time_t act_time)
/**
* gnutls_x509_crl_set_next_update:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @exp_time: The actual time
*
* This function will set the time this CRL will be updated.
@@ -195,7 +195,7 @@ int gnutls_x509_crl_set_next_update(gnutls_x509_crl_t crl, time_t exp_time)
/**
* gnutls_x509_crl_set_crt_serial:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @serial: The revoked certificate's serial number
* @serial_size: Holds the size of the serial field.
* @revocation_time: The time this certificate was revoked
@@ -257,7 +257,7 @@ gnutls_x509_crl_set_crt_serial(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_set_crt:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @crt: a certificate of type #gnutls_x509_crt_t with the revoked certificate
* @revocation_time: The time this certificate was revoked
*
@@ -443,7 +443,7 @@ gnutls_x509_crl_set_number(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_privkey_sign:
- * @crl: should contain a gnutls_x509_crl_t structure
+ * @crl: should contain a gnutls_x509_crl_t type
* @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 the safe choice unless you know what you're doing.
diff --git a/lib/x509/crq.c b/lib/x509/crq.c
index a6be6a5d82..bb7d7abb6f 100644
--- a/lib/x509/crq.c
+++ b/lib/x509/crq.c
@@ -39,7 +39,7 @@
/**
* gnutls_x509_crq_init:
- * @crq: The structure to be initialized
+ * @crq: A pointer to the type to be initialized
*
* This function will initialize a PKCS#10 certificate request
* structure.
@@ -71,7 +71,7 @@ int gnutls_x509_crq_init(gnutls_x509_crq_t * crq)
/**
* gnutls_x509_crq_deinit:
- * @crq: The structure to be initialized
+ * @crq: A pointer to the type to be initialized
*
* This function will deinitialize a PKCS#10 certificate request
* structure.
@@ -92,12 +92,12 @@ void gnutls_x509_crq_deinit(gnutls_x509_crq_t crq)
/**
* gnutls_x509_crq_import:
- * @crq: The structure to store the parsed certificate request.
+ * @crq: The data to store the parsed certificate request.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
*
* This function will convert the given DER or PEM encoded certificate
- * request to a #gnutls_x509_crq_t structure. The output will be
+ * request to a #gnutls_x509_crq_t type. The output will be
* stored in @crq.
*
* If the Certificate is PEM encoded it should have a header of "NEW
@@ -161,7 +161,7 @@ gnutls_x509_crq_import(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_signature_algorithm:
- * @crq: should contain a #gnutls_x509_cr_t structure
+ * @crq: should contain a #gnutls_x509_cr_t type
*
* This function will return a value of the #gnutls_sign_algorithm_t
* enumeration that is the signature algorithm that has been used to
@@ -180,7 +180,7 @@ int gnutls_x509_crq_get_signature_algorithm(gnutls_x509_crq_t crq)
/**
* gnutls_x509_crq_get_private_key_usage_period:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @activation: The activation time
* @expiration: The expiration time
* @critical: the extension status
@@ -245,7 +245,7 @@ gnutls_x509_crq_get_private_key_usage_period(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_dn:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @buf: a pointer to a structure to hold the name (may be %NULL)
* @buf_size: initially holds the size of @buf
*
@@ -274,7 +274,7 @@ gnutls_x509_crq_get_dn(gnutls_x509_crq_t crq, char *buf, size_t * buf_size)
/**
* gnutls_x509_crq_get_dn2:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @dn: a pointer to a structure to hold the name
*
* This function will allocate buffer and copy the name of the Certificate
@@ -301,7 +301,7 @@ int gnutls_x509_crq_get_dn2(gnutls_x509_crq_t crq, gnutls_datum_t * dn)
/**
* gnutls_x509_crq_get_dn_by_oid:
- * @crq: should contain a gnutls_x509_crq_t structure
+ * @crq: should contain a gnutls_x509_crq_t type
* @oid: holds an Object Identifier in a null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies
* which to get. Use (0) to get the first one.
@@ -349,7 +349,7 @@ gnutls_x509_crq_get_dn_by_oid(gnutls_x509_crq_t crq, const char *oid,
/**
* gnutls_x509_crq_get_dn_oid:
- * @crq: should contain a gnutls_x509_crq_t structure
+ * @crq: should contain a gnutls_x509_crq_t type
* @indx: Specifies which DN OID to get. Use (0) to get the first one.
* @oid: a pointer to a structure to hold the name (may be %NULL)
* @sizeof_oid: initially holds the size of @oid
@@ -497,7 +497,7 @@ parse_attribute(ASN1_TYPE asn1_struct,
/**
* gnutls_x509_crq_get_challenge_password:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @pass: will hold a (0)-terminated password string
* @pass_size: Initially holds the size of @pass.
*
@@ -675,7 +675,7 @@ set_attribute(ASN1_TYPE asn, const char *root,
/**
* gnutls_x509_crq_set_attribute_by_oid:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @oid: holds an Object Identifier in a null-terminated string
* @buf: a pointer to a structure that holds the attribute data
* @buf_size: holds the size of @buf
@@ -712,7 +712,7 @@ gnutls_x509_crq_set_attribute_by_oid(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_attribute_by_oid:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @oid: holds an Object Identifier in null-terminated string
* @indx: In case multiple same OIDs exist in the attribute list, this
* specifies which to get, use (0) to get the first one
@@ -754,7 +754,7 @@ gnutls_x509_crq_get_attribute_by_oid(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_set_dn_by_oid:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @oid: holds an Object Identifier in a (0)-terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
* @data: a pointer to the input data
@@ -789,7 +789,7 @@ gnutls_x509_crq_set_dn_by_oid(gnutls_x509_crq_t crq, const char *oid,
/**
* gnutls_x509_crq_set_version:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @version: holds the version number, for v1 Requests must be 1
*
* This function will set the version of the certificate request. For
@@ -825,7 +825,7 @@ gnutls_x509_crq_set_version(gnutls_x509_crq_t crq, unsigned int version)
/**
* gnutls_x509_crq_get_version:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
*
* This function will return the version of the specified Certificate
* request.
@@ -859,7 +859,7 @@ int gnutls_x509_crq_get_version(gnutls_x509_crq_t crq)
/**
* gnutls_x509_crq_set_key:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @key: holds a private key
*
* This function will set the public parameters from the given private
@@ -954,7 +954,7 @@ gnutls_x509_crq_get_key_rsa_raw(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_set_key_rsa_raw:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @m: holds the modulus
* @e: holds the public exponent
*
@@ -1020,7 +1020,7 @@ gnutls_x509_crq_set_key_rsa_raw(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_set_challenge_password:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @pass: holds a (0)-terminated password
*
* This function will set a challenge password to be used when
@@ -1065,7 +1065,7 @@ gnutls_x509_crq_set_challenge_password(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_sign2:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @key: holds a private key
* @dig: The message digest to use, i.e., %GNUTLS_DIG_SHA1
* @flags: must be 0
@@ -1124,7 +1124,7 @@ gnutls_x509_crq_sign2(gnutls_x509_crq_t crq, gnutls_x509_privkey_t key,
/**
* gnutls_x509_crq_sign:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @key: holds a private key
*
* This function is the same a gnutls_x509_crq_sign2() with no flags,
@@ -1142,7 +1142,7 @@ int gnutls_x509_crq_sign(gnutls_x509_crq_t crq, gnutls_x509_privkey_t key)
/**
* gnutls_x509_crq_export:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a certificate request PEM or DER encoded
* @output_data_size: holds the size of output_data (and will be
@@ -1177,7 +1177,7 @@ gnutls_x509_crq_export(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_export2:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @format: the format of output params. One of PEM or DER.
* @out: will contain a certificate request PEM or DER encoded
*
@@ -1208,7 +1208,7 @@ gnutls_x509_crq_export2(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_pk_algorithm:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @bits: if bits is non-%NULL it will hold the size of the parameters' in bits
*
* This function will return the public key algorithm of a PKCS#10
@@ -1242,7 +1242,7 @@ gnutls_x509_crq_get_pk_algorithm(gnutls_x509_crq_t crq, unsigned int *bits)
/**
* gnutls_x509_crq_get_attribute_info:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @indx: Specifies which attribute number to get. Use (0) to get the first one.
* @oid: a pointer to a structure to hold the OID
* @sizeof_oid: initially holds the maximum size of @oid, on return
@@ -1297,7 +1297,7 @@ gnutls_x509_crq_get_attribute_info(gnutls_x509_crq_t crq, int indx,
/**
* gnutls_x509_crq_get_attribute_data:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @indx: Specifies which attribute number to get. Use (0) to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
* @sizeof_data: initially holds the size of @oid
@@ -1350,7 +1350,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 structure
+ * @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
* @sizeof_oid: initially holds the maximum size of @oid, on return
@@ -1477,7 +1477,7 @@ gnutls_x509_crq_get_extension_info(gnutls_x509_crq_t crq, int indx,
/**
* gnutls_x509_crq_get_extension_data:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @indx: Specifies which extension number to get. Use (0) to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
* @sizeof_data: initially holds the size of @oid
@@ -1518,7 +1518,7 @@ gnutls_x509_crq_get_extension_data(gnutls_x509_crq_t crq, int indx,
/**
* gnutls_x509_crq_get_extension_data2:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @extension_id: An X.509 extension OID.
* @indx: Specifies which extension OID to read. Use (0) to get the first one.
* @data: will contain the extension DER-encoded data
@@ -1616,7 +1616,7 @@ gnutls_x509_crq_get_extension_data2(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_key_usage:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @key_usage: where the key usage bits will be stored
* @critical: will be non-zero if the extension is marked as critical
*
@@ -1671,7 +1671,7 @@ gnutls_x509_crq_get_key_usage(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_basic_constraints:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @critical: will be non-zero if the extension is marked as critical
* @ca: pointer to output integer indicating CA status, may be NULL,
* value is 1 if the certificate CA flag is set, 0 otherwise.
@@ -1807,7 +1807,7 @@ get_subject_alt_name(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_subject_alt_name:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @seq: specifies the sequence number of the alt name, 0 for the
* first one, 1 for the second etc.
* @ret: is the place where the alternative name will be copied to
@@ -1846,7 +1846,7 @@ gnutls_x509_crq_get_subject_alt_name(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_subject_alt_othername_oid:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @ret: is the place where the otherName OID will be copied to
* @ret_size: holds the size of ret.
@@ -1883,7 +1883,7 @@ gnutls_x509_crq_get_subject_alt_othername_oid(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_extension_by_oid:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @oid: holds an Object Identifier in a null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this
* specifies which to get. Use (0) to get the first one.
@@ -1943,7 +1943,7 @@ gnutls_x509_crq_get_extension_by_oid(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_extension_by_oid2:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @oid: holds an Object Identifier in a null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this
* specifies which to get. Use (0) to get the first one.
@@ -2211,7 +2211,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 structure
+ * @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)
* @sizeof_oid: initially holds the size of @oid
@@ -2493,7 +2493,7 @@ gnutls_x509_crq_get_key_id(gnutls_x509_crq_t crq, unsigned int flags,
/**
* gnutls_x509_crq_privkey_sign:
- * @crq: should contain a #gnutls_x509_crq_t structure
+ * @crq: should contain a #gnutls_x509_crq_t type
* @key: holds a private key
* @dig: The message digest to use, i.e., %GNUTLS_DIG_SHA1
* @flags: must be 0
diff --git a/lib/x509/dn.c b/lib/x509/dn.c
index 7d71abcbe7..9166587c54 100644
--- a/lib/x509/dn.c
+++ b/lib/x509/dn.c
@@ -741,7 +741,7 @@ _gnutls_x509_set_dn_oid(ASN1_TYPE asn1_struct,
* gnutls_x509_dn_init:
* @dn: the object to be initialized
*
- * This function initializes a #gnutls_x509_dn_t structure.
+ * This function initializes a #gnutls_x509_dn_t type.
*
* The object returned must be deallocated using
* gnutls_x509_dn_deinit().
@@ -774,7 +774,7 @@ int gnutls_x509_dn_init(gnutls_x509_dn_t * dn)
* @data: should contain a DER encoded RDN sequence
*
* This function parses an RDN sequence and stores the result to a
- * #gnutls_x509_dn_t structure. The structure must have been initialized
+ * #gnutls_x509_dn_t type. The data must have been initialized
* with gnutls_x509_dn_init(). You may use gnutls_x509_dn_get_rdn_ava() to
* decode the DN.
*
diff --git a/lib/x509/extensions.c b/lib/x509/extensions.c
index 3f674d8a77..af90dec6c2 100644
--- a/lib/x509/extensions.c
+++ b/lib/x509/extensions.c
@@ -161,7 +161,7 @@ _gnutls_x509_crt_get_extension(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_extension_data2:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @indx: Specifies which extension OID to read. Use (0) to get the first one.
* @data: will contain the extension DER-encoded data
*
@@ -197,7 +197,7 @@ _gnutls_x509_crl_get_extension(gnutls_x509_crl_t crl,
/**
* gnutls_x509_crl_get_extension_data2:
- * @crl: should contain a #gnutls_x509_crl_t structure
+ * @crl: should contain a #gnutls_x509_crl_t type
* @indx: Specifies which extension OID to read. Use (0) to get the first one.
* @data: will contain the extension DER-encoded data
*
diff --git a/lib/x509/hostname-verify.c b/lib/x509/hostname-verify.c
index e40aa5dc5a..a9bca262a4 100644
--- a/lib/x509/hostname-verify.c
+++ b/lib/x509/hostname-verify.c
@@ -29,7 +29,7 @@
/**
* gnutls_x509_crt_check_hostname:
- * @cert: should contain an gnutls_x509_crt_t structure
+ * @cert: should contain an gnutls_x509_crt_t type
* @hostname: A null terminated string that contains a DNS name
*
* This function will check if the given certificate's subject matches
@@ -93,7 +93,7 @@ static int has_embedded_null(const char *str, unsigned size)
/**
* gnutls_x509_crt_check_hostname:
- * @cert: should contain an gnutls_x509_crt_t structure
+ * @cert: should contain an gnutls_x509_crt_t type
* @hostname: A null terminated string that contains a DNS name
* @flags: gnutls_certificate_verify_flags
*
diff --git a/lib/x509/name_constraints.c b/lib/x509/name_constraints.c
index 65ee409eb1..0734283216 100644
--- a/lib/x509/name_constraints.c
+++ b/lib/x509/name_constraints.c
@@ -130,12 +130,12 @@ int _gnutls_extract_name_constraints(ASN1_TYPE c2, const char *vstr,
/**
* gnutls_x509_crt_get_name_constraints:
- * @crt: should contain a #gnutls_x509_crt_t structure
- * @nc: The nameconstraints intermediate structure
+ * @crt: should contain a #gnutls_x509_crt_t type
+ * @nc: The nameconstraints intermediate type
* @flags: zero or %GNUTLS_NAME_CONSTRAINTS_FLAG_APPEND
* @critical: the extension status
*
- * This function will return an intermediate structure containing
+ * This function will return an intermediate type containing
* the name constraints of the provided CA certificate. That
* structure can be used in combination with gnutls_x509_name_constraints_check()
* to verify whether a server's name is in accordance with the constraints.
@@ -192,9 +192,9 @@ int gnutls_x509_crt_get_name_constraints(gnutls_x509_crt_t crt,
/**
* gnutls_x509_name_constraints_deinit:
- * @nc: The nameconstraints structure
+ * @nc: The nameconstraints
*
- * This function will deinitialize a name constraints structure.
+ * This function will deinitialize a name constraints type.
*
* Since: 3.3.0
**/
@@ -222,9 +222,9 @@ void gnutls_x509_name_constraints_deinit(gnutls_x509_name_constraints_t nc)
/**
* gnutls_x509_name_constraints_init:
- * @nc: The nameconstraints structure
+ * @nc: The nameconstraints
*
- * This function will initialize a name constraints structure.
+ * This function will initialize a name constraints type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -296,7 +296,7 @@ int name_constraints_add(gnutls_x509_name_constraints_t nc,
/**
* gnutls_x509_name_constraints_add_permitted:
- * @nc: The nameconstraints structure
+ * @nc: The nameconstraints
* @type: The type of the constraints
* @name: The data of the constraints
*
@@ -316,7 +316,7 @@ int gnutls_x509_name_constraints_add_permitted(gnutls_x509_name_constraints_t nc
/**
* gnutls_x509_name_constraints_add_excluded:
- * @nc: The nameconstraints structure
+ * @nc: The nameconstraints
* @type: The type of the constraints
* @name: The data of the constraints
*
@@ -336,7 +336,7 @@ int gnutls_x509_name_constraints_add_excluded(gnutls_x509_name_constraints_t nc,
/**
* gnutls_x509_crt_set_name_constraints:
- * @crt: The certificate structure
+ * @crt: The certificate
* @nc: The nameconstraints structure
* @critical: whether this extension will be critical
*
@@ -561,7 +561,7 @@ gnutls_datum_t rname;
/**
* gnutls_x509_name_constraints_check:
- * @nc: the extracted name constraints structure
+ * @nc: the extracted name constraints
* @type: the type of the constraint to check (of type gnutls_x509_subject_alt_name_t)
* @name: the name to be checked
*
@@ -588,7 +588,7 @@ unsigned gnutls_x509_name_constraints_check(gnutls_x509_name_constraints_t nc,
/**
* gnutls_x509_name_constraints_check_crt:
- * @nc: the extracted name constraints structure
+ * @nc: the extracted name constraints
* @type: the type of the constraint to check (of type gnutls_x509_subject_alt_name_t)
* @cert: the certificate to be checked
*
@@ -741,12 +741,12 @@ unsigned found_one;
/**
* gnutls_x509_name_constraints_get_permitted:
- * @nc: the extracted name constraints structure
+ * @nc: the extracted name constraints
* @idx: the index of the constraint
* @type: the type of the constraint (of type gnutls_x509_subject_alt_name_t)
* @name: the name in the constraint (of the specific type)
*
- * This function will return an intermediate structure containing
+ * This function will return an intermediate type containing
* the name constraints of the provided CA certificate. That
* structure can be used in combination with gnutls_x509_name_constraints_check()
* to verify whether a server's name is in accordance with the constraints.
@@ -785,12 +785,12 @@ int gnutls_x509_name_constraints_get_permitted(gnutls_x509_name_constraints_t nc
/**
* gnutls_x509_name_constraints_get_excluded:
- * @nc: the extracted name constraints structure
+ * @nc: the extracted name constraints
* @idx: the index of the constraint
* @type: the type of the constraint (of type gnutls_x509_subject_alt_name_t)
* @name: the name in the constraint (of the specific type)
*
- * This function will return an intermediate structure containing
+ * This function will return an intermediate type containing
* the name constraints of the provided CA certificate. That
* structure can be used in combination with gnutls_x509_name_constraints_check()
* to verify whether a server's name is in accordance with the constraints.
diff --git a/lib/x509/ocsp.c b/lib/x509/ocsp.c
index 937d38a93f..46befc1aec 100644
--- a/lib/x509/ocsp.c
+++ b/lib/x509/ocsp.c
@@ -50,7 +50,7 @@ typedef struct gnutls_ocsp_resp_int {
/**
* gnutls_ocsp_req_init:
- * @req: The structure to be initialized
+ * @req: A pointer to the type to be initialized
*
* This function will initialize an OCSP request structure.
*
@@ -81,7 +81,7 @@ int gnutls_ocsp_req_init(gnutls_ocsp_req_t * req)
/**
* gnutls_ocsp_req_deinit:
- * @req: The structure to be deinitialized
+ * @req: The data to be deinitialized
*
* This function will deinitialize a OCSP request structure.
**/
@@ -99,7 +99,7 @@ void gnutls_ocsp_req_deinit(gnutls_ocsp_req_t req)
/**
* gnutls_ocsp_resp_init:
- * @resp: The structure to be initialized
+ * @resp: A pointer to the type to be initialized
*
* This function will initialize an OCSP response structure.
*
@@ -140,7 +140,7 @@ int gnutls_ocsp_resp_init(gnutls_ocsp_resp_t * resp)
/**
* gnutls_ocsp_resp_deinit:
- * @resp: The structure to be deinitialized
+ * @resp: The data to be deinitialized
*
* This function will deinitialize a OCSP response structure.
**/
@@ -165,7 +165,7 @@ void gnutls_ocsp_resp_deinit(gnutls_ocsp_resp_t resp)
/**
* gnutls_ocsp_req_import:
- * @req: The structure to store the parsed request.
+ * @req: The data to store the parsed request.
* @data: DER encoded OCSP request.
*
* This function will convert the given DER encoded OCSP request to
@@ -211,7 +211,7 @@ gnutls_ocsp_req_import(gnutls_ocsp_req_t req, const gnutls_datum_t * data)
/**
* gnutls_ocsp_resp_import:
- * @resp: The structure to store the parsed response.
+ * @resp: The data to store the parsed response.
* @data: DER encoded OCSP response.
*
* This function will convert the given DER encoded OCSP response to
@@ -362,7 +362,7 @@ int gnutls_ocsp_resp_export(gnutls_ocsp_resp_t resp, gnutls_datum_t * data)
/**
* gnutls_ocsp_req_get_version:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
*
* This function will return the version of the OCSP request.
* Typically this is always 1 indicating version 1.
@@ -394,7 +394,7 @@ int gnutls_ocsp_req_get_version(gnutls_ocsp_req_t req)
/**
* gnutls_ocsp_req_get_cert_id:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @indx: Specifies which extension OID to get. Use (0) to get the first one.
* @digest: output variable with #gnutls_digest_algorithm_t hash algorithm
* @issuer_name_hash: output buffer with hash of issuer's DN
@@ -508,7 +508,7 @@ gnutls_ocsp_req_get_cert_id(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_add_cert_id:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @digest: hash algorithm, a #gnutls_digest_algorithm_t value
* @issuer_name_hash: hash of issuer's DN
* @issuer_key_hash: hash of issuer's public key
@@ -621,7 +621,7 @@ gnutls_ocsp_req_add_cert_id(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_add_cert:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @digest: hash algorithm, a #gnutls_digest_algorithm_t value
* @issuer: issuer of @subject certificate
* @cert: certificate to request status for
@@ -707,7 +707,7 @@ gnutls_ocsp_req_add_cert(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_get_extension:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @indx: Specifies which extension OID to get. Use (0) to get the first one.
* @oid: will hold newly allocated buffer with OID of extension, may be NULL
* @critical: output variable with critical flag, may be NULL.
@@ -792,7 +792,7 @@ gnutls_ocsp_req_get_extension(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_set_extension:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @oid: buffer with OID of extension as a string.
* @critical: critical flag, normally false.
* @data: the extension data
@@ -821,7 +821,7 @@ gnutls_ocsp_req_set_extension(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_get_nonce:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @critical: whether nonce extension is marked critical, or NULL
* @nonce: will hold newly allocated buffer with nonce data
*
@@ -868,7 +868,7 @@ gnutls_ocsp_req_get_nonce(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_set_nonce:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
* @critical: critical flag, normally false.
* @nonce: the nonce data
*
@@ -920,7 +920,7 @@ gnutls_ocsp_req_set_nonce(gnutls_ocsp_req_t req,
/**
* gnutls_ocsp_req_randomize_nonce:
- * @req: should contain a #gnutls_ocsp_req_t structure
+ * @req: should contain a #gnutls_ocsp_req_t type
*
* This function will add or update an nonce extension to the OCSP
* request with a newly generated random value.
@@ -956,7 +956,7 @@ int gnutls_ocsp_req_randomize_nonce(gnutls_ocsp_req_t req)
/**
* gnutls_ocsp_resp_get_status:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
*
* This function will return the status of a OCSP response, an
* #gnutls_ocsp_resp_status_t enumeration.
@@ -998,7 +998,7 @@ int gnutls_ocsp_resp_get_status(gnutls_ocsp_resp_t resp)
/**
* gnutls_ocsp_resp_get_response:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @response_type_oid: newly allocated output buffer with response type OID
* @response: newly allocated output buffer with DER encoded response
*
@@ -1055,7 +1055,7 @@ gnutls_ocsp_resp_get_response(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_version:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
*
* This function will return the version of the Basic OCSP Response.
* Typically this is always 1 indicating version 1.
@@ -1089,7 +1089,7 @@ int gnutls_ocsp_resp_get_version(gnutls_ocsp_resp_t resp)
/**
* gnutls_ocsp_resp_get_responder:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @dn: newly allocated buffer with name
*
* This function will extract the name of the Basic OCSP Response in
@@ -1152,7 +1152,7 @@ gnutls_ocsp_resp_get_responder(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_responder_by_key:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @type: should be %GNUTLS_OCSP_RESP_ID_KEY or %GNUTLS_OCSP_RESP_ID_DN
* @raw: newly allocated buffer with the raw ID
*
@@ -1228,7 +1228,7 @@ gnutls_ocsp_resp_get_responder_raw_id(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_produced:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
*
* This function will return the time when the OCSP response was
* signed.
@@ -1262,7 +1262,7 @@ time_t gnutls_ocsp_resp_get_produced(gnutls_ocsp_resp_t resp)
/**
* gnutls_ocsp_resp_check_crt:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @indx: Specifies response number to get. Use (0) to get the first one.
* @crt: The certificate to check
*
@@ -1357,7 +1357,7 @@ gnutls_ocsp_resp_check_crt(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_single:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @indx: Specifies response number to get. Use (0) to get the first one.
* @digest: output variable with #gnutls_digest_algorithm_t hash algorithm
* @issuer_name_hash: output buffer with hash of issuer's DN
@@ -1558,7 +1558,7 @@ gnutls_ocsp_resp_get_single(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_extension:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @indx: Specifies which extension OID to get. Use (0) to get the first one.
* @oid: will hold newly allocated buffer with OID of extension, may be NULL
* @critical: output variable with critical flag, may be NULL.
@@ -1644,7 +1644,7 @@ gnutls_ocsp_resp_get_extension(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_nonce:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @critical: whether nonce extension is marked critical
* @nonce: will hold newly allocated buffer with nonce data
*
@@ -1689,7 +1689,7 @@ gnutls_ocsp_resp_get_nonce(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_signature_algorithm:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
*
* This function will return a value of the #gnutls_sign_algorithm_t
* enumeration that is the signature algorithm that has been used to
@@ -1719,7 +1719,7 @@ int gnutls_ocsp_resp_get_signature_algorithm(gnutls_ocsp_resp_t resp)
/**
* gnutls_ocsp_resp_get_signature:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @sig: newly allocated output buffer with signature data
*
* This function will extract the signature field of a OCSP response.
@@ -1749,7 +1749,7 @@ gnutls_ocsp_resp_get_signature(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_get_certs:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @certs: newly allocated array with #gnutls_x509_crt_t certificates
* @ncerts: output variable with number of allocated certs.
*
@@ -2048,7 +2048,7 @@ static int check_ocsp_purpose(gnutls_x509_crt_t signercert)
/**
* gnutls_ocsp_resp_verify_direct:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
* @issuer: certificate believed to have signed the response
* @verify: output variable with verification status, an #gnutls_ocsp_verify_reason_t
* @flags: verification flags, 0 for now.
@@ -2124,8 +2124,8 @@ gnutls_ocsp_resp_verify_direct(gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_verify:
- * @resp: should contain a #gnutls_ocsp_resp_t structure
- * @trustlist: trust anchors as a #gnutls_x509_trust_list_t structure
+ * @resp: should contain a #gnutls_ocsp_resp_t type
+ * @trustlist: trust anchors as a #gnutls_x509_trust_list_t type
* @verify: output variable with verification status, an #gnutls_ocsp_verify_reason_t
* @flags: verification flags, 0 for now.
*
diff --git a/lib/x509/ocsp_output.c b/lib/x509/ocsp_output.c
index 4994dd6b61..8a15975cfe 100644
--- a/lib/x509/ocsp_output.c
+++ b/lib/x509/ocsp_output.c
@@ -155,7 +155,7 @@ static void print_req(gnutls_buffer_st * str, gnutls_ocsp_req_t req)
/**
* gnutls_ocsp_req_print:
- * @req: The structure to be printed
+ * @req: The data to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with (0) terminated string.
*
@@ -625,7 +625,7 @@ print_resp(gnutls_buffer_st * str, gnutls_ocsp_resp_t resp,
/**
* gnutls_ocsp_resp_print:
- * @resp: The structure to be printed
+ * @resp: The data to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with (0) terminated string.
*
diff --git a/lib/x509/output.c b/lib/x509/output.c
index ec94ca66e2..135a6bc387 100644
--- a/lib/x509/output.c
+++ b/lib/x509/output.c
@@ -1661,7 +1661,7 @@ static void print_oneline(gnutls_buffer_st * str, gnutls_x509_crt_t cert)
/**
* gnutls_x509_crt_print:
- * @cert: The structure to be printed
+ * @cert: The data to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with null terminated string.
*
@@ -2035,7 +2035,7 @@ print_crl(gnutls_buffer_st * str, gnutls_x509_crl_t crl, int notsigned)
/**
* gnutls_x509_crl_print:
- * @crl: The structure to be printed
+ * @crl: The data to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with null terminated string.
*
@@ -2333,7 +2333,7 @@ static void print_crq_other(gnutls_buffer_st * str, gnutls_x509_crq_t crq)
/**
* gnutls_x509_crq_print:
- * @crq: The structure to be printed
+ * @crq: The data to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with null terminated string.
*
@@ -2402,7 +2402,7 @@ print_pubkey_other(gnutls_buffer_st * str, gnutls_pubkey_t pubkey,
/**
* gnutls_pubkey_print:
- * @pubkey: The structure to be printed
+ * @pubkey: The data to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with null terminated string.
*
@@ -2438,7 +2438,7 @@ gnutls_pubkey_print(gnutls_pubkey_t pubkey,
/**
* gnutls_x509_ext_print:
- * @exts: The structures to be printed
+ * @exts: The data to be printed
* @exts_size: the number of available structures
* @format: Indicate the format to use
* @out: Newly allocated datum with null terminated string.
diff --git a/lib/x509/pkcs12.c b/lib/x509/pkcs12.c
index 04019f3847..5e4fe11528 100644
--- a/lib/x509/pkcs12.c
+++ b/lib/x509/pkcs12.c
@@ -138,9 +138,9 @@ int result;
/**
* gnutls_pkcs12_init:
- * @pkcs12: The structure to be initialized
+ * @pkcs12: A pointer to the type to be initialized
*
- * This function will initialize a PKCS12 structure. PKCS12 structures
+ * This function will initialize a PKCS12 type. PKCS12 structures
* usually contain lists of X.509 Certificates and X.509 Certificate
* revocation lists.
*
@@ -165,9 +165,9 @@ int gnutls_pkcs12_init(gnutls_pkcs12_t * pkcs12)
/**
* gnutls_pkcs12_deinit:
- * @pkcs12: The structure to be initialized
+ * @pkcs12: The type to be initialized
*
- * This function will deinitialize a PKCS12 structure.
+ * This function will deinitialize a PKCS12 type.
**/
void gnutls_pkcs12_deinit(gnutls_pkcs12_t pkcs12)
{
@@ -182,7 +182,7 @@ void gnutls_pkcs12_deinit(gnutls_pkcs12_t pkcs12)
/**
* gnutls_pkcs12_import:
- * @pkcs12: The structure to store the parsed PKCS12.
+ * @pkcs12: The data to store the parsed PKCS12.
* @data: The DER or PEM encoded PKCS12.
* @format: One of DER or PEM
* @flags: an ORed sequence of gnutls_privkey_pkcs8_flags
@@ -260,7 +260,7 @@ gnutls_pkcs12_import(gnutls_pkcs12_t pkcs12,
/**
* gnutls_pkcs12_export:
- * @pkcs12: Holds the pkcs12 structure
+ * @pkcs12: A pkcs12 type
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a structure PEM or DER encoded
* @output_data_size: holds the size of output_data (and will be
@@ -294,7 +294,7 @@ gnutls_pkcs12_export(gnutls_pkcs12_t pkcs12,
/**
* gnutls_pkcs12_export2:
- * @pkcs12: Holds the pkcs12 structure
+ * @pkcs12: A pkcs12 type
* @format: the format of output params. One of PEM or DER.
* @out: will contain a structure PEM or DER encoded
*
@@ -586,7 +586,7 @@ _parse_safe_contents(ASN1_TYPE sc, const char *sc_name,
/**
* gnutls_pkcs12_get_bag:
- * @pkcs12: should contain a gnutls_pkcs12_t structure
+ * @pkcs12: A pkcs12 type
* @indx: contains the index of the bag to extract
* @bag: An initialized bag, where the contents of the bag will be copied
*
@@ -726,7 +726,7 @@ static int create_empty_pfx(ASN1_TYPE pkcs12)
/**
* gnutls_pkcs12_set_bag:
- * @pkcs12: should contain a gnutls_pkcs12_t structure
+ * @pkcs12: should contain a gnutls_pkcs12_t type
* @bag: An initialized bag
*
* This function will insert a Bag into the PKCS12 structure.
@@ -849,7 +849,7 @@ int gnutls_pkcs12_set_bag(gnutls_pkcs12_t pkcs12, gnutls_pkcs12_bag_t bag)
/**
* gnutls_pkcs12_generate_mac2:
- * @pkcs12: should contain a gnutls_pkcs12_t structure
+ * @pkcs12: A pkcs12 type
* @mac: the MAC algorithm to use
* @pass: The password for the MAC
*
@@ -980,7 +980,7 @@ int gnutls_pkcs12_generate_mac2(gnutls_pkcs12_t pkcs12, gnutls_mac_algorithm_t m
/**
* gnutls_pkcs12_generate_mac:
- * @pkcs12: should contain a gnutls_pkcs12_t structure
+ * @pkcs12: A pkcs12 type
* @pass: The password for the MAC
*
* This function will generate a MAC for the PKCS12 structure.
@@ -995,7 +995,7 @@ int gnutls_pkcs12_generate_mac(gnutls_pkcs12_t pkcs12, const char *pass)
/**
* gnutls_pkcs12_verify_mac:
- * @pkcs12: should contain a gnutls_pkcs12_t structure
+ * @pkcs12: should contain a gnutls_pkcs12_t type
* @pass: The password for the MAC
*
* This function will verify the MAC for the PKCS12 structure.
@@ -1395,7 +1395,7 @@ static int make_chain(gnutls_x509_crt_t ** chain, unsigned int *chain_len,
/**
* gnutls_pkcs12_simple_parse:
- * @p12: should contain a gnutls_pkcs12_t structure
+ * @p12: A pkcs12 type
* @password: optional password used to decrypt the structure, bags and keys.
* @key: a structure to store the parsed private key.
* @chain: the corresponding to key certificate chain (may be %NULL)
@@ -1823,7 +1823,7 @@ gnutls_pkcs12_simple_parse(gnutls_pkcs12_t p12,
/**
* gnutls_pkcs12_mac_info:
- * @pkcs12: The PKCS #12 structure
+ * @pkcs12: A pkcs12 type
* @mac: the MAC algorithm used as %gnutls_mac_algorithm_t
* @salt: the salt used for string to key (if non-NULL then @salt_size initially holds its size)
* @salt_size: string to key salt size
diff --git a/lib/x509/pkcs12_bag.c b/lib/x509/pkcs12_bag.c
index d7100a7b10..2807b5dd9a 100644
--- a/lib/x509/pkcs12_bag.c
+++ b/lib/x509/pkcs12_bag.c
@@ -34,7 +34,7 @@
/**
* gnutls_pkcs12_bag_init:
- * @bag: The structure to be initialized
+ * @bag: A pointer to the type to be initialized
*
* This function will initialize a PKCS12 bag structure. PKCS12 Bags
* usually contain private keys, lists of X.509 Certificates and X.509
@@ -70,7 +70,7 @@ static inline void _pkcs12_bag_free_data(gnutls_pkcs12_bag_t bag)
/**
* gnutls_pkcs12_bag_deinit:
- * @bag: The structure to be initialized
+ * @bag: A pointer to the type to be initialized
*
* This function will deinitialize a PKCS12 Bag structure.
**/
diff --git a/lib/x509/pkcs7.c b/lib/x509/pkcs7.c
index d0adf7c087..b15db8cdf6 100644
--- a/lib/x509/pkcs7.c
+++ b/lib/x509/pkcs7.c
@@ -144,7 +144,7 @@ static int pkcs7_reinit(gnutls_pkcs7_t pkcs7)
/**
* gnutls_pkcs7_init:
- * @pkcs7: The structure to be initialized
+ * @pkcs7: A pointer to the type to be initialized
*
* This function will initialize a PKCS7 structure. PKCS7 structures
* usually contain lists of X.509 Certificates and X.509 Certificate
@@ -171,9 +171,9 @@ int gnutls_pkcs7_init(gnutls_pkcs7_t * pkcs7)
/**
* gnutls_pkcs7_deinit:
- * @pkcs7: The structure to be initialized
+ * @pkcs7: A pointer to the type to be initialized
*
- * This function will deinitialize a PKCS7 structure.
+ * This function will deinitialize a PKCS7 type.
**/
void gnutls_pkcs7_deinit(gnutls_pkcs7_t pkcs7)
{
@@ -188,7 +188,7 @@ void gnutls_pkcs7_deinit(gnutls_pkcs7_t pkcs7)
/**
* gnutls_pkcs7_import:
- * @pkcs7: The structure to store the parsed PKCS7.
+ * @pkcs7: The data to store the parsed PKCS7.
* @data: The DER or PEM encoded PKCS7.
* @format: One of DER or PEM
*
@@ -259,7 +259,7 @@ gnutls_pkcs7_import(gnutls_pkcs7_t pkcs7, const gnutls_datum_t * data,
/**
* gnutls_pkcs7_get_crt_raw:
- * @pkcs7: should contain a gnutls_pkcs7_t structure
+ * @pkcs7: should contain a gnutls_pkcs7_t type
* @indx: contains the index of the certificate to extract
* @certificate: the contents of the certificate will be copied
* there (may be null)
@@ -360,7 +360,7 @@ gnutls_pkcs7_get_crt_raw(gnutls_pkcs7_t pkcs7,
/**
* gnutls_pkcs7_get_crt_count:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: should contain a #gnutls_pkcs7_t type
*
* This function will return the number of certifcates in the PKCS7
* or RFC2630 certificate set.
@@ -401,7 +401,7 @@ int gnutls_pkcs7_get_crt_count(gnutls_pkcs7_t pkcs7)
/**
* gnutls_pkcs7_export:
- * @pkcs7: Holds the pkcs7 structure
+ * @pkcs7: The pkcs7 type
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a structure PEM or DER encoded
* @output_data_size: holds the size of output_data (and will be
@@ -433,7 +433,7 @@ gnutls_pkcs7_export(gnutls_pkcs7_t pkcs7,
/**
* gnutls_pkcs7_export2:
- * @pkcs7: Holds the pkcs7 structure
+ * @pkcs7: The pkcs7 type
* @format: the format of output params. One of PEM or DER.
* @out: will contain a structure PEM or DER encoded
*
@@ -537,7 +537,7 @@ static int create_empty_signed_data(ASN1_TYPE pkcs7, ASN1_TYPE * sdata)
/**
* gnutls_pkcs7_set_crt_raw:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @crt: the DER encoded certificate to be added
*
* This function will add a certificate to the PKCS7 or RFC2630
@@ -626,7 +626,7 @@ gnutls_pkcs7_set_crt_raw(gnutls_pkcs7_t pkcs7, const gnutls_datum_t * crt)
/**
* gnutls_pkcs7_set_crt:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @crt: the certificate to be copied.
*
* This function will add a parsed certificate to the PKCS7 or
@@ -665,7 +665,7 @@ int gnutls_pkcs7_set_crt(gnutls_pkcs7_t pkcs7, gnutls_x509_crt_t crt)
/**
* gnutls_pkcs7_delete_crt:
- * @pkcs7: should contain a gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @indx: the index of the certificate to delete
*
* This function will delete a certificate from a PKCS7 or RFC2630
@@ -728,7 +728,7 @@ int gnutls_pkcs7_delete_crt(gnutls_pkcs7_t pkcs7, int indx)
/**
* gnutls_pkcs7_get_crl_raw:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @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
@@ -802,7 +802,7 @@ gnutls_pkcs7_get_crl_raw(gnutls_pkcs7_t pkcs7,
/**
* gnutls_pkcs7_get_crl_count:
- * @pkcs7: should contain a gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
*
* This function will return the number of certifcates in the PKCS7
* or RFC2630 crl set.
@@ -843,7 +843,7 @@ int gnutls_pkcs7_get_crl_count(gnutls_pkcs7_t pkcs7)
/**
* gnutls_pkcs7_set_crl_raw:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @crl: the DER encoded crl to be added
*
* This function will add a crl to the PKCS7 or RFC2630 crl set.
@@ -921,7 +921,7 @@ gnutls_pkcs7_set_crl_raw(gnutls_pkcs7_t pkcs7, const gnutls_datum_t * crl)
/**
* gnutls_pkcs7_set_crl:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @crl: the DER encoded crl to be added
*
* This function will add a parsed CRL to the PKCS7 or RFC2630 crl
@@ -958,7 +958,7 @@ int gnutls_pkcs7_set_crl(gnutls_pkcs7_t pkcs7, gnutls_x509_crl_t crl)
/**
* gnutls_pkcs7_delete_crl:
- * @pkcs7: should contain a #gnutls_pkcs7_t structure
+ * @pkcs7: The pkcs7 type
* @indx: the index of the crl to delete
*
* This function will delete a crl from a PKCS7 or RFC2630 crl set.
diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c
index e05d977319..1203ad10c9 100644
--- a/lib/x509/privkey.c
+++ b/lib/x509/privkey.c
@@ -36,9 +36,9 @@
/**
* gnutls_x509_privkey_init:
- * @key: The structure to be initialized
+ * @key: A pointer to the type to be initialized
*
- * This function will initialize an private key structure.
+ * This function will initialize a private key type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -68,7 +68,7 @@ void _gnutls_x509_privkey_reinit(gnutls_x509_privkey_t key)
/**
* gnutls_x509_privkey_deinit:
- * @key: The structure to be deinitialized
+ * @key: The key to be deinitialized
*
* This function will deinitialize a private key structure.
**/
@@ -434,7 +434,7 @@ decode_dsa_key(const gnutls_datum_t * raw_key, gnutls_x509_privkey_t pkey)
/**
* gnutls_x509_privkey_import:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
*
@@ -626,7 +626,7 @@ static int import_pkcs12_privkey(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_import2:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @data: The DER or PEM encoded key.
* @format: One of DER or PEM
* @password: A password (optional)
@@ -716,7 +716,7 @@ gnutls_x509_privkey_import2(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_import_rsa_raw:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @m: holds the modulus
* @e: holds the public exponent
* @d: holds the private exponent
@@ -746,7 +746,7 @@ gnutls_x509_privkey_import_rsa_raw(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_import_rsa_raw2:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @m: holds the modulus
* @e: holds the public exponent
* @d: holds the private exponent
@@ -882,7 +882,7 @@ gnutls_x509_privkey_import_rsa_raw2(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_import_dsa_raw:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @p: holds the p
* @q: holds the q
* @g: holds the g
@@ -969,7 +969,7 @@ gnutls_x509_privkey_import_dsa_raw(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_import_ecc_raw:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @curve: holds the curve
* @x: holds the x
* @y: holds the y
@@ -1038,7 +1038,7 @@ gnutls_x509_privkey_import_ecc_raw(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_get_pk_algorithm:
- * @key: should contain a #gnutls_x509_privkey_t structure
+ * @key: should contain a #gnutls_x509_privkey_t type
*
* This function will return the public key algorithm of a private
* key.
@@ -1058,7 +1058,7 @@ int gnutls_x509_privkey_get_pk_algorithm(gnutls_x509_privkey_t key)
/**
* gnutls_x509_privkey_get_pk_algorithm2:
- * @key: should contain a #gnutls_x509_privkey_t structure
+ * @key: should contain a #gnutls_x509_privkey_t type
* @bits: The number of bits in the public key algorithm
*
* This function will return the public key algorithm of a private
@@ -1179,7 +1179,7 @@ gnutls_x509_privkey_export2(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_sec_param:
- * @key: a key structure
+ * @key: a key
*
* This function will return the security parameter appropriate with
* this private key.
@@ -1202,7 +1202,7 @@ gnutls_sec_param_t gnutls_x509_privkey_sec_param(gnutls_x509_privkey_t key)
/**
* gnutls_x509_privkey_export_ecc_raw:
- * @key: a structure that holds the rsa parameters
+ * @key: a key
* @curve: will hold the curve
* @x: will hold the x coordinate
* @y: will hold the y coordinate
@@ -1233,7 +1233,7 @@ int gnutls_x509_privkey_export_ecc_raw(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_export_rsa_raw:
- * @key: a structure that holds the rsa parameters
+ * @key: a key
* @m: will hold the modulus
* @e: will hold the public exponent
* @d: will hold the private exponent
@@ -1259,7 +1259,7 @@ gnutls_x509_privkey_export_rsa_raw(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_export_rsa_raw2:
- * @key: a structure that holds the rsa parameters
+ * @key: a key
* @m: will hold the modulus
* @e: will hold the public exponent
* @d: will hold the private exponent
@@ -1291,7 +1291,7 @@ gnutls_x509_privkey_export_rsa_raw2(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_export_dsa_raw:
- * @key: a structure that holds the DSA parameters
+ * @key: a key
* @p: will hold the p
* @q: will hold the q
* @g: will hold the g
@@ -1405,7 +1405,7 @@ cleanup:
/**
* gnutls_x509_privkey_generate:
- * @key: should contain a #gnutls_x509_privkey_t structure
+ * @key: a key
* @algo: is one of the algorithms in #gnutls_pk_algorithm_t.
* @bits: the size of the modulus
* @flags: unused for now. Must be 0.
@@ -1487,7 +1487,7 @@ gnutls_x509_privkey_generate(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_verify_params:
- * @key: should contain a #gnutls_x509_privkey_t structure
+ * @key: a key
*
* This function will verify the private key parameters.
*
@@ -1509,7 +1509,7 @@ int gnutls_x509_privkey_verify_params(gnutls_x509_privkey_t key)
/**
* gnutls_x509_privkey_get_key_id:
- * @key: Holds the key
+ * @key: a key
* @flags: should be 0 for now
* @output_data: will contain the key ID
* @output_data_size: holds the size of output_data (and will be
@@ -1615,7 +1615,7 @@ _gnutls_x509_privkey_sign_hash2(gnutls_x509_privkey_t signer,
/**
* gnutls_x509_privkey_sign_hash:
- * @key: Holds the key
+ * @key: a key
* @hash: holds the data to be signed
* @signature: will contain newly allocated signature
*
@@ -1655,7 +1655,7 @@ gnutls_x509_privkey_sign_hash(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_sign_data:
- * @key: Holds the key
+ * @key: a key
* @digest: should be MD5 or SHA1
* @flags: should be 0 for now
* @data: holds the data to be signed
@@ -1731,7 +1731,7 @@ gnutls_x509_privkey_sign_data(gnutls_x509_privkey_t key,
/**
* gnutls_x509_privkey_fix:
- * @key: Holds the key
+ * @key: a key
*
* This function will recalculate the secondary parameters in a key.
* In RSA keys, this can be the coefficient and exponent1,2.
diff --git a/lib/x509/privkey_openssl.c b/lib/x509/privkey_openssl.c
index 97753eab44..c6feb00630 100644
--- a/lib/x509/privkey_openssl.c
+++ b/lib/x509/privkey_openssl.c
@@ -102,7 +102,7 @@ static const struct pem_cipher pem_ciphers[] = {
/**
* gnutls_x509_privkey_import_openssl:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @data: The DER or PEM encoded key.
* @password: the password to decrypt the key (if it is encrypted).
*
diff --git a/lib/x509/privkey_pkcs8.c b/lib/x509/privkey_pkcs8.c
index 0065ae1d6b..d9aed063f7 100644
--- a/lib/x509/privkey_pkcs8.c
+++ b/lib/x509/privkey_pkcs8.c
@@ -1411,7 +1411,7 @@ error:
/**
* gnutls_x509_privkey_import_pkcs8:
- * @key: The structure to store the parsed key
+ * @key: The data to store the parsed key
* @data: The DER or PEM encoded key.
* @format: One of DER or PEM
* @password: the password to decrypt the key (if it is encrypted).
diff --git a/lib/x509/verify-high.c b/lib/x509/verify-high.c
index 96d61a81ac..6e3a4be20e 100644
--- a/lib/x509/verify-high.c
+++ b/lib/x509/verify-high.c
@@ -69,7 +69,7 @@ struct gnutls_x509_trust_list_iter {
/**
* gnutls_x509_trust_list_init:
- * @list: The structure to be initialized
+ * @list: A pointer to the type to be initialized
* @size: The size of the internal hash table. Use (0) for default size.
*
* This function will initialize an X.509 trust list structure.
@@ -111,7 +111,7 @@ gnutls_x509_trust_list_init(gnutls_x509_trust_list_t * list,
/**
* gnutls_x509_trust_list_deinit:
- * @list: The structure to be deinitialized
+ * @list: The list to be deinitialized
* @all: if non-zero it will deinitialize all the certificates and CRLs contained in the structure.
*
* This function will deinitialize a trust list. Note that the
@@ -250,7 +250,7 @@ trust_list_add_compat(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_add_cas:
- * @list: The structure of the list
+ * @list: The list
* @clist: A list of CAs
* @clist_size: The length of the CA list
* @flags: should be 0 or an or'ed sequence of %GNUTLS_TL options.
@@ -386,7 +386,7 @@ advance_iter(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_iter_get_ca:
- * @list: The structure of the list
+ * @list: The list
* @iter: A pointer to an iterator (initially the iterator should be %NULL)
* @crt: where the certificate will be copied
*
@@ -539,7 +539,7 @@ int ret;
/**
* gnutls_x509_trust_list_remove_cas:
- * @list: The structure of the list
+ * @list: The list
* @clist: A list of CAs
* @clist_size: The length of the CA list
*
@@ -611,7 +611,7 @@ gnutls_x509_trust_list_remove_cas(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_add_named_crt:
- * @list: The structure of the list
+ * @list: The list
* @cert: A certificate
* @name: An identifier for the certificate
* @name_size: The size of the identifier
@@ -676,7 +676,7 @@ gnutls_x509_trust_list_add_named_crt(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_add_crls:
- * @list: The structure of the list
+ * @list: The list
* @crl_list: A list of CRLs
* @crl_size: The length of the CRL list
* @flags: if GNUTLS_TL_VERIFY_CRL is given the CRLs will be verified before being added.
@@ -865,7 +865,7 @@ int trust_list_get_issuer_by_dn(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_get_issuer:
- * @list: The structure of the list
+ * @list: The list
* @cert: is the certificate to find issuer for
* @issuer: Will hold the issuer if any. Should be treated as constant.
* @flags: Use zero or %GNUTLS_TL_GET_COPY
@@ -940,7 +940,7 @@ int gnutls_x509_trust_list_get_issuer(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_get_issuer_by_dn:
- * @list: The structure of the list
+ * @list: The list
* @dn: is the issuer's DN
* @issuer: Will hold the issuer if any. Should be treated as constant.
* @flags: Use zero
@@ -1019,7 +1019,7 @@ unsigned i, j;
/**
* gnutls_x509_trust_list_verify_crt:
- * @list: The structure of the list
+ * @list: The list
* @cert_list: is the certificate list to be verified
* @cert_list_size: is the certificate list size
* @flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations.
@@ -1051,7 +1051,7 @@ gnutls_x509_trust_list_verify_crt(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_verify_crt2:
- * @list: The structure of the list
+ * @list: The list
* @cert_list: is the certificate list to be verified
* @cert_list_size: is the certificate list size
* @data: an array of typed data
@@ -1265,7 +1265,7 @@ gnutls_x509_trust_list_verify_crt2(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_verify_named_crt:
- * @list: The structure of the list
+ * @list: The list
* @cert: is the certificate to be verified
* @name: is the certificate's name
* @name_size: is the certificate's name size
diff --git a/lib/x509/verify-high2.c b/lib/x509/verify-high2.c
index 09eefd4000..b7b69c29bf 100644
--- a/lib/x509/verify-high2.c
+++ b/lib/x509/verify-high2.c
@@ -48,7 +48,7 @@
/**
* gnutls_x509_trust_list_add_trust_mem:
- * @list: The structure of the list
+ * @list: The list
* @cas: A buffer containing a list of CAs (optional)
* @crls: A buffer containing a list of CRLs (optional)
* @type: The format of the certificates
@@ -119,7 +119,7 @@ gnutls_x509_trust_list_add_trust_mem(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_remove_trust_mem:
- * @list: The structure of the list
+ * @list: The list
* @cas: A buffer containing a list of CAs (optional)
* @type: The format of the certificates
*
@@ -282,7 +282,7 @@ int remove_pkcs11_object_url(gnutls_x509_trust_list_t list, const char *url)
/**
* gnutls_x509_trust_list_add_trust_file:
- * @list: The structure of the list
+ * @list: The list
* @ca_file: A file containing a list of CAs (optional)
* @crl_file: A file containing a list of CRLs (optional)
* @type: The format of the certificates
@@ -424,7 +424,7 @@ int load_dir_certs(const char *dirname,
/**
* gnutls_x509_trust_list_add_trust_dir:
- * @list: The structure of the list
+ * @list: The list
* @ca_dir: A directory containing the CAs (optional)
* @crl_dir: A directory containing a list of CRLs (optional)
* @type: The format of the certificates
@@ -470,7 +470,7 @@ gnutls_x509_trust_list_add_trust_dir(gnutls_x509_trust_list_t list,
/**
* gnutls_x509_trust_list_remove_trust_file:
- * @list: The structure of the list
+ * @list: The list
* @ca_file: A file containing a list of CAs
* @type: The format of the certificates
*
diff --git a/lib/x509/x509.c b/lib/x509/x509.c
index a8cd8a9a01..75ca8a7e20 100644
--- a/lib/x509/x509.c
+++ b/lib/x509/x509.c
@@ -60,7 +60,7 @@ static int crt_reinit(gnutls_x509_crt_t crt)
/**
* gnutls_x509_crt_init:
- * @cert: The structure to be initialized
+ * @cert: A pointer to the type to be initialized
*
* This function will initialize an X.509 certificate structure.
*
@@ -97,9 +97,9 @@ int gnutls_x509_crt_init(gnutls_x509_crt_t * cert)
}
/*-
- * _gnutls_x509_crt_cpy - This function copies a gnutls_x509_crt_t structure
- * @dest: The structure where to copy
- * @src: The structure to be copied
+ * _gnutls_x509_crt_cpy - This function copies a gnutls_x509_crt_t type
+ * @dest: The data where to copy
+ * @src: The data to be copied
*
* This function will copy an X.509 certificate structure.
*
@@ -152,7 +152,7 @@ int _gnutls_x509_crt_cpy(gnutls_x509_crt_t dest, gnutls_x509_crt_t src)
/**
* gnutls_x509_crt_deinit:
- * @cert: The structure to be deinitialized
+ * @cert: The data to be deinitialized
*
* This function will deinitialize a certificate structure.
**/
@@ -234,7 +234,7 @@ static int compare_sig_algorithm(gnutls_x509_crt_t cert)
/**
* gnutls_x509_crt_import:
- * @cert: The structure to store the parsed certificate.
+ * @cert: The data to store the parsed certificate.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
*
@@ -374,7 +374,7 @@ gnutls_x509_crt_import(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_issuer_dn:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @buf: a pointer to a structure to hold the name (may be null)
* @buf_size: initially holds the size of @buf
*
@@ -405,7 +405,7 @@ gnutls_x509_crt_get_issuer_dn(gnutls_x509_crt_t cert, char *buf,
/**
* gnutls_x509_crt_get_issuer_dn2:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @dn: a pointer to a structure to hold the name
*
* This function will allocate buffer and copy the name of issuer of the Certificate.
@@ -433,7 +433,7 @@ gnutls_x509_crt_get_issuer_dn2(gnutls_x509_crt_t cert, gnutls_datum_t * dn)
/**
* gnutls_x509_crt_get_issuer_dn_by_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one.
* @raw_flag: If non-zero returns the raw DER data of the DN part.
@@ -485,7 +485,7 @@ gnutls_x509_crt_get_issuer_dn_by_oid(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_issuer_dn_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_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_size: initially holds the size of @oid
@@ -518,7 +518,7 @@ gnutls_x509_crt_get_issuer_dn_oid(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_dn:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @buf: a pointer to a structure to hold the name (may be null)
* @buf_size: initially holds the size of @buf
*
@@ -549,7 +549,7 @@ gnutls_x509_crt_get_dn(gnutls_x509_crt_t cert, char *buf,
/**
* gnutls_x509_crt_get_dn2:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @dn: a pointer to a structure to hold the name
*
* This function will allocate buffer and copy the name of the Certificate.
@@ -576,7 +576,7 @@ int gnutls_x509_crt_get_dn2(gnutls_x509_crt_t cert, gnutls_datum_t * dn)
/**
* gnutls_x509_crt_get_dn_by_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one.
* @raw_flag: If non-zero returns the raw DER data of the DN part.
@@ -627,7 +627,7 @@ gnutls_x509_crt_get_dn_by_oid(gnutls_x509_crt_t cert, const char *oid,
/**
* gnutls_x509_crt_get_dn_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_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_size: initially holds the size of @oid
@@ -660,7 +660,7 @@ gnutls_x509_crt_get_dn_oid(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_signature_algorithm:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
*
* This function will return a value of the #gnutls_sign_algorithm_t
* enumeration that is the signature algorithm that has been used to
@@ -677,7 +677,7 @@ int gnutls_x509_crt_get_signature_algorithm(gnutls_x509_crt_t cert)
/**
* gnutls_x509_crt_get_signature:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @sig: a pointer where the signature part will be copied (may be null).
* @sig_size: initially holds the size of @sig
*
@@ -714,7 +714,7 @@ gnutls_x509_crt_get_signature(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_version:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
*
* This function will return the version of the specified Certificate.
*
@@ -746,7 +746,7 @@ int gnutls_x509_crt_get_version(gnutls_x509_crt_t cert)
/**
* gnutls_x509_crt_get_activation_time:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
*
* This function will return the time this Certificate was or will be
* activated.
@@ -767,7 +767,7 @@ time_t gnutls_x509_crt_get_activation_time(gnutls_x509_crt_t cert)
/**
* gnutls_x509_crt_get_expiration_time:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
*
* This function will return the time this Certificate was or will be
* expired.
@@ -791,7 +791,7 @@ time_t gnutls_x509_crt_get_expiration_time(gnutls_x509_crt_t cert)
/**
* gnutls_x509_crt_get_private_key_usage_period:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @activation: The activation time
* @expiration: The expiration time
* @critical: the extension status
@@ -845,7 +845,7 @@ gnutls_x509_crt_get_private_key_usage_period(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_serial:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @result: The place where the serial number will be copied
* @result_size: Holds the size of the result field.
*
@@ -884,7 +884,7 @@ gnutls_x509_crt_get_serial(gnutls_x509_crt_t cert, void *result,
/**
* gnutls_x509_crt_get_subject_key_id:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @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)
@@ -951,7 +951,7 @@ inline static int is_type_printable(int type)
/**
* gnutls_x509_crt_get_authority_key_gn_serial:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @alt: is the place where the alternative name will be copied to
* @alt_size: holds the size of alt.
@@ -1049,7 +1049,7 @@ gnutls_x509_crt_get_authority_key_gn_serial(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_authority_key_id:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @id: The place where the identifier will be copied
* @id_size: Holds the size of the id field.
* @critical: will be non-zero if the extension is marked as critical (may be null)
@@ -1135,7 +1135,7 @@ gnutls_x509_crt_get_authority_key_id(gnutls_x509_crt_t cert, void *id,
/**
* gnutls_x509_crt_get_pk_algorithm:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
* This function will return the public key algorithm of an X.509
@@ -1432,7 +1432,7 @@ cleanup:
/**
* gnutls_x509_crt_get_subject_alt_name:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @san: is the place where the alternative name will be copied to
* @san_size: holds the size of san.
@@ -1472,7 +1472,7 @@ gnutls_x509_crt_get_subject_alt_name(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_issuer_alt_name:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @ian: is the place where the alternative name will be copied to
* @ian_size: holds the size of ian.
@@ -1515,7 +1515,7 @@ gnutls_x509_crt_get_issuer_alt_name(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_subject_alt_name2:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @san: is the place where the alternative name will be copied to
* @san_size: holds the size of ret.
@@ -1550,7 +1550,7 @@ gnutls_x509_crt_get_subject_alt_name2(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_issuer_alt_name2:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @ian: is the place where the alternative name will be copied to
* @ian_size: holds the size of ret.
@@ -1588,7 +1588,7 @@ gnutls_x509_crt_get_issuer_alt_name2(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_subject_alt_othername_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @oid: is the place where the otherName OID will be copied to
* @oid_size: holds the size of ret.
@@ -1627,7 +1627,7 @@ gnutls_x509_crt_get_subject_alt_othername_oid(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_issuer_alt_othername_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
* @ret: is the place where the otherName OID will be copied to
* @ret_size: holds the size of ret.
@@ -1668,7 +1668,7 @@ gnutls_x509_crt_get_issuer_alt_othername_oid(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_basic_constraints:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @critical: will be non-zero if the extension is marked as critical
* @ca: pointer to output integer indicating CA status, may be NULL,
* value is 1 if the certificate CA flag is set, 0 otherwise.
@@ -1728,7 +1728,7 @@ gnutls_x509_crt_get_basic_constraints(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_ca_status:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @critical: will be non-zero if the extension is marked as critical
*
* This function will return certificates CA status, by reading the
@@ -1757,7 +1757,7 @@ gnutls_x509_crt_get_ca_status(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_key_usage:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @key_usage: where the key usage bits will be stored
* @critical: will be non-zero if the extension is marked as critical
*
@@ -1811,7 +1811,7 @@ gnutls_x509_crt_get_key_usage(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_proxy:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @critical: will be non-zero if the extension is marked as critical
* @pathlen: pointer to output integer indicating path length (may be
* NULL), non-negative error codes indicate a present pCPathLenConstraint
@@ -1887,7 +1887,7 @@ void gnutls_x509_policy_release(struct gnutls_x509_policy_st *policy)
/**
* gnutls_x509_crt_get_policy:
- * @crt: should contain a #gnutls_x509_crt_t structure
+ * @crt: should contain a #gnutls_x509_crt_t type
* @indx: This specifies which policy to return. Use (0) to get the first one.
* @policy: A pointer to a policy structure.
* @critical: will be non-zero if the extension is marked as critical
@@ -1962,7 +1962,7 @@ gnutls_x509_crt_get_policy(gnutls_x509_crt_t crt, int indx,
/**
* gnutls_x509_crt_get_extension_by_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this specifies which to send. Use (0) to get the first one.
* @buf: a pointer to a structure to hold the name (may be null)
@@ -2022,7 +2022,7 @@ gnutls_x509_crt_get_extension_by_oid(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_extension_by_oid2:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this specifies which to send. Use (0) to get the first one.
* @output: will hold the allocated extension data
@@ -2069,7 +2069,7 @@ gnutls_x509_crt_get_extension_by_oid2(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_extension_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @indx: Specifies which extension OID to send. Use (0) to get the first one.
* @oid: a pointer to a structure to hold the OID (may be null)
* @oid_size: initially holds the size of @oid
@@ -2108,7 +2108,7 @@ gnutls_x509_crt_get_extension_oid(gnutls_x509_crt_t cert, int indx,
/**
* gnutls_x509_crt_get_extension_info:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @indx: Specifies which extension OID to send. Use (0) to get the first one.
* @oid: a pointer to a structure to hold the OID
* @oid_size: initially holds the maximum size of @oid, on return
@@ -2181,7 +2181,7 @@ gnutls_x509_crt_get_extension_info(gnutls_x509_crt_t cert, int indx,
/**
* gnutls_x509_crt_get_extension_data:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @indx: Specifies which extension OID to send. Use (0) to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
* @sizeof_data: initially holds the size of @data
@@ -2236,7 +2236,7 @@ gnutls_x509_crt_get_extension_data(gnutls_x509_crt_t cert, int indx,
/**
* gnutls_x509_crt_get_raw_issuer_dn:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @dn: will hold the starting point of the DN
*
* This function will return a pointer to the DER encoded DN structure
@@ -2260,7 +2260,7 @@ gnutls_x509_crt_get_raw_issuer_dn(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_raw_dn:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @dn: will hold the starting point of the DN
*
* This function will return a pointer to the DER encoded DN structure and
@@ -2290,7 +2290,7 @@ get_dn(gnutls_x509_crt_t cert, const char *whom, gnutls_x509_dn_t * dn)
/**
* gnutls_x509_crt_get_subject:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @dn: output variable with pointer to uint8_t DN.
*
* Return the Certificate's Subject DN as a %gnutls_x509_dn_t data type,
@@ -2310,7 +2310,7 @@ gnutls_x509_crt_get_subject(gnutls_x509_crt_t cert, gnutls_x509_dn_t * dn)
/**
* gnutls_x509_crt_get_issuer:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @dn: output variable with pointer to uint8_t DN
*
* Return the Certificate's Issuer DN as a %gnutls_x509_dn_t data type,
@@ -2447,7 +2447,7 @@ gnutls_x509_dn_get_rdn_ava(gnutls_x509_dn_t dn,
/**
* gnutls_x509_crt_get_fingerprint:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @algo: is a digest algorithm
* @buf: a pointer to a structure to hold the fingerprint (may be null)
* @buf_size: initially holds the size of @buf
@@ -2767,8 +2767,8 @@ _gnutls_x509_crt_check_revocation(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_check_revocation:
- * @cert: should contain a #gnutls_x509_crt_t structure
- * @crl_list: should contain a list of gnutls_x509_crl_t structures
+ * @cert: should contain a #gnutls_x509_crt_t type
+ * @crl_list: should contain a list of gnutls_x509_crl_t types
* @crl_list_length: the length of the crl_list
*
* This function will return check if the given certificate is
@@ -2839,7 +2839,7 @@ gnutls_x509_crt_get_preferred_hash_algorithm(gnutls_x509_crt_t crt,
/**
* gnutls_x509_crt_get_crl_dist_points:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_t type
* @seq: specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.)
* @san: is the place where the distribution point will be copied to
* @san_size: holds the size of ret.
@@ -2927,7 +2927,7 @@ gnutls_x509_crt_get_crl_dist_points(gnutls_x509_crt_t cert,
/**
* gnutls_x509_crt_get_key_purpose_oid:
- * @cert: should contain a #gnutls_x509_crt_t structure
+ * @cert: should contain a #gnutls_x509_crt_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_size: initially holds the size of @oid
@@ -3152,7 +3152,7 @@ gnutls_x509_crt_get_pk_dsa_raw(gnutls_x509_crt_t crt,
/**
* gnutls_x509_crt_list_import2:
- * @certs: The structures to store the parsed certificate. Must not be initialized.
+ * @certs: Will hold the parsed certificate list.
* @size: It will contain the size of the list.
* @data: The PEM encoded certificate.
* @format: One of DER or PEM.
@@ -3217,7 +3217,7 @@ gnutls_x509_crt_list_import2(gnutls_x509_crt_t ** certs,
/**
* gnutls_x509_crt_list_import:
- * @certs: The structures to store the parsed certificate. Must not be initialized.
+ * @certs: Indicates where the parsed list will be copied to. Must not be initialized.
* @cert_max: Initially must hold the maximum number of certs. It will be updated with the number of certs available.
* @data: The PEM encoded certificate.
* @format: One of DER or PEM.
@@ -3716,7 +3716,7 @@ void gnutls_x509_crt_set_pin_function(gnutls_x509_crt_t crt,
* @flags: One of GNUTLS_PKCS11_OBJ_* flags
*
* This function will import a PKCS 11 certificate directly from a token
- * without involving the #gnutls_pkcs11_obj_t structure. This function will
+ * without involving the #gnutls_pkcs11_obj_t type. This function will
* fail if the certificate stored is not of X.509 type.
*
* Despite its name this function will attempt to import any kind of
diff --git a/lib/x509/x509_ext.c b/lib/x509/x509_ext.c
index c1f0f2d8cb..bdec2412d0 100644
--- a/lib/x509/x509_ext.c
+++ b/lib/x509/x509_ext.c
@@ -45,7 +45,7 @@ struct gnutls_subject_alt_names_st {
/**
* gnutls_subject_alt_names_init:
- * @sans: The alternative names structure
+ * @sans: The alternative names
*
* This function will initialize an alternative names structure.
*
@@ -77,7 +77,7 @@ static void subject_alt_names_deinit(gnutls_subject_alt_names_t sans)
/**
* gnutls_subject_alt_names_deinit:
- * @sans: The alternative names structure
+ * @sans: The alternative names
*
* This function will deinitialize an alternative names structure.
*
@@ -91,14 +91,14 @@ void gnutls_subject_alt_names_deinit(gnutls_subject_alt_names_t sans)
/**
* gnutls_subject_alt_names_get:
- * @sans: The alternative names structure
+ * @sans: The alternative names
* @seq: The index of the name to get
* @san_type: Will hold the type of the name (of %gnutls_subject_alt_names_t)
* @san: The alternative name data (should be treated as constant)
* @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME (should be treated as constant)
*
* This function will return a specific alternative name as stored in
- * the @sans structure. The returned values should be treated as constant
+ * the @sans type. The returned values should be treated as constant
* and valid for the lifetime of @sans.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
@@ -163,13 +163,13 @@ int subject_alt_names_set(struct name_st **names,
/**
* gnutls_subject_alt_names_set:
- * @sans: The alternative names structure
+ * @sans: The alternative names
* @san_type: The type of the name (of %gnutls_subject_alt_names_t)
* @san: The alternative name data
* @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME
*
* This function will store the specified alternative name in
- * the @sans structure.
+ * the @sans.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value.
*
@@ -205,13 +205,13 @@ int gnutls_subject_alt_names_set(gnutls_subject_alt_names_t sans,
/**
* gnutls_x509_ext_import_subject_alt_names:
* @ext: The DER-encoded extension data
- * @sans: The alternative names structure
+ * @sans: The alternative names
* @flags: should be zero
*
* This function will export the alternative names in the provided DER-encoded
- * SubjectAltName PKIX extension, to a %gnutls_subject_alt_names_t structure. The structure
- * must have been initialized.
- *
+ * SubjectAltName PKIX extension, to a %gnutls_subject_alt_names_t type. @sans
+ * must be initialized.
+ *
* This function will succeed even if there no subject alternative names
* in the structure.
*
@@ -291,7 +291,7 @@ int gnutls_x509_ext_import_subject_alt_names(const gnutls_datum_t * ext,
/**
* gnutls_x509_ext_export_subject_alt_names:
- * @sans: The alternative names structure
+ * @sans: The alternative names
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
* This function will convert the provided alternative names structure to a
@@ -347,18 +347,17 @@ int gnutls_x509_ext_export_subject_alt_names(gnutls_subject_alt_names_t sans,
/**
* gnutls_x509_ext_import_name_constraints:
* @ext: a DER encoded extension
- * @nc: The nameconstraints intermediate structure
+ * @nc: The nameconstraints
* @flags: zero or %GNUTLS_NAME_CONSTRAINTS_FLAG_APPEND
*
- * This function will return an intermediate structure containing
+ * This function will return an intermediate type containing
* the name constraints of the provided NameConstraints extension. That
- * structure can be used in combination with gnutls_x509_name_constraints_check()
+ * can be used in combination with gnutls_x509_name_constraints_check()
* to verify whether a server's name is in accordance with the constraints.
*
* When the @flags is set to %GNUTLS_NAME_CONSTRAINTS_FLAG_APPEND, then if
- * the @nc structure is empty
- * this function will behave identically as if the flag was not set.
- * Otherwise if there are elements in the @nc structure then only the
+ * the @nc type is empty this function will behave identically as if the flag was not set.
+ * Otherwise if there are elements in the @nc type then only the
* excluded constraints will be appended to the constraints.
*
* Note that @nc must be initialized prior to calling this function.
@@ -418,10 +417,10 @@ int gnutls_x509_ext_import_name_constraints(const gnutls_datum_t * ext,
/**
* gnutls_x509_ext_export_name_constraints:
- * @nc: The nameconstraints structure
+ * @nc: The nameconstraints
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
- * This function will convert the provided name constraints structure to a
+ * This function will convert the provided name constraints type to a
* DER-encoded PKIX NameConstraints (2.5.29.30) extension. The output data in
* @ext will be allocated usin gnutls_malloc().
*
@@ -663,9 +662,9 @@ struct gnutls_x509_aki_st {
/**
* gnutls_x509_aki_init:
- * @aki: The authority key ID structure
+ * @aki: The authority key ID type
*
- * This function will initialize an authority key ID structure.
+ * This function will initialize an authority key ID.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -682,9 +681,9 @@ int gnutls_x509_aki_init(gnutls_x509_aki_t * aki)
/**
* gnutls_x509_aki_deinit:
- * @aki: The authority key identifier structure
+ * @aki: The authority key identifier type
*
- * This function will deinitialize an authority key identifier structure.
+ * This function will deinitialize an authority key identifier.
*
* Since: 3.3.0
**/
@@ -698,11 +697,11 @@ void gnutls_x509_aki_deinit(gnutls_x509_aki_t aki)
/**
* gnutls_x509_aki_get_id:
- * @aki: The authority key ID structure
+ * @aki: The authority key ID
* @id: Will hold the identifier
*
* This function will return the key identifier as stored in
- * the @aki structure. The identifier should be treated as constant.
+ * the @aki type. The identifier should be treated as constant.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
* if the index is out of bounds, otherwise a negative error value.
@@ -720,11 +719,11 @@ int gnutls_x509_aki_get_id(gnutls_x509_aki_t aki, gnutls_datum_t * id)
/**
* gnutls_x509_aki_set_id:
- * @aki: The authority key ID structure
+ * @aki: The authority key ID
* @id: the key identifier
*
* This function will set the keyIdentifier to be stored in the @aki
- * structure.
+ * type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -737,14 +736,14 @@ int gnutls_x509_aki_set_id(gnutls_x509_aki_t aki, const gnutls_datum_t * id)
/**
* gnutls_x509_aki_set_cert_issuer:
- * @aki: The authority key ID structure
+ * @aki: The authority key ID
* @san_type: the type of the name (of %gnutls_subject_alt_names_t), may be null
* @san: The alternative name data
* @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME
* @serial: The authorityCertSerialNumber number (may be null)
*
* This function will set the authorityCertIssuer name and the authorityCertSerialNumber
- * to be stored in the @aki structure. When storing multiple names, the serial
+ * to be stored in the @aki type. When storing multiple names, the serial
* should be set on the first call, and subsequent calls should use a %NULL serial.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
@@ -793,7 +792,7 @@ int gnutls_x509_aki_set_cert_issuer(gnutls_x509_aki_t aki,
/**
* gnutls_x509_aki_get_cert_issuer:
- * @aki: The authority key ID structure
+ * @aki: The authority key ID
* @seq: The index of the name to get
* @san_type: Will hold the type of the name (of %gnutls_subject_alt_names_t)
* @san: The alternative name data
@@ -801,7 +800,7 @@ int gnutls_x509_aki_set_cert_issuer(gnutls_x509_aki_t aki,
* @serial: The authorityCertSerialNumber number
*
* This function will return a specific authorityCertIssuer name as stored in
- * the @aki structure, as well as the authorityCertSerialNumber. All the returned
+ * the @aki type, as well as the authorityCertSerialNumber. All the returned
* values should be treated as constant, and may be set to %NULL when are not required.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
@@ -847,7 +846,7 @@ int gnutls_x509_aki_get_cert_issuer(gnutls_x509_aki_t aki, unsigned int seq,
/**
* gnutls_x509_ext_import_authority_key_id:
* @ext: a DER encoded extension
- * @aki: An initialized authority key identifier structure
+ * @aki: An initialized authority key identifier type
* @flags: should be zero
*
* This function will return the subject key ID stored in the provided
@@ -952,7 +951,7 @@ int gnutls_x509_ext_import_authority_key_id(const gnutls_datum_t * ext,
/**
* gnutls_x509_ext_export_authority_key_id:
- * @aki: An initialized authority key identifier structure
+ * @aki: An initialized authority key identifier
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
* This function will convert the provided key identifier to a
@@ -1644,9 +1643,9 @@ struct gnutls_x509_policies_st {
/**
* gnutls_x509_policies_init:
- * @policies: The authority key ID structure
+ * @policies: The authority key ID
*
- * This function will initialize an authority key ID structure.
+ * This function will initialize an authority key ID type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -1663,9 +1662,9 @@ int gnutls_x509_policies_init(gnutls_x509_policies_t * policies)
/**
* gnutls_x509_policies_deinit:
- * @policies: The authority key identifier structure
+ * @policies: The authority key identifier
*
- * This function will deinitialize an authority key identifier structure.
+ * This function will deinitialize an authority key identifier type.
*
* Since: 3.3.0
**/
@@ -1680,12 +1679,12 @@ void gnutls_x509_policies_deinit(gnutls_x509_policies_t policies)
/**
* gnutls_x509_policies_get:
- * @policies: The policies structure
+ * @policies: The policies
* @seq: The index of the name to get
* @policy: Will hold the policy
*
* This function will return a specific policy as stored in
- * the @policies structure. The returned values should be treated as constant
+ * the @policies type. The returned values should be treated as constant
* and valid for the lifetime of @policies.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
@@ -1719,12 +1718,12 @@ void _gnutls_x509_policies_erase(gnutls_x509_policies_t policies,
/**
* gnutls_x509_policies_set:
- * @policies: An initialized policies structure
+ * @policies: An initialized policies
* @seq: The index of the name to get
* @policy: Contains the policy to set
*
* This function will store the specified policy in
- * the provided @policies structure.
+ * the provided @policies.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value.
*
@@ -1767,11 +1766,11 @@ int gnutls_x509_policies_set(gnutls_x509_policies_t policies,
/**
* gnutls_x509_ext_import_policies:
* @ext: the DER encoded extension data
- * @policies: A pointer to an initialized policies structures.
+ * @policies: A pointer to an initialized policies.
* @flags: should be zero
*
* This function will extract the certificate policy extension (2.5.29.32)
- * and store it the provided structure.
+ * and store it the provided policies.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -1973,7 +1972,7 @@ static int encode_user_notice(const gnutls_datum_t * txt,
/**
* gnutls_x509_ext_export_policies:
- * @policies: A pointer to an initialized policies structure.
+ * @policies: A pointer to an initialized policies.
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
* This function will convert the provided policies, to a certificate policy
@@ -2131,9 +2130,9 @@ struct gnutls_x509_crl_dist_points_st {
/**
* gnutls_x509_crl_dist_points_init:
- * @cdp: The CRL distribution points structure
+ * @cdp: The CRL distribution points
*
- * This function will initialize a CRL distribution points structure.
+ * This function will initialize a CRL distribution points type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -2150,9 +2149,9 @@ int gnutls_x509_crl_dist_points_init(gnutls_x509_crl_dist_points_t * cdp)
/**
* gnutls_x509_crl_dist_points_deinit:
- * @cdp: The CRL distribution points structure
+ * @cdp: The CRL distribution points
*
- * This function will deinitialize a CRL distribution points structure.
+ * This function will deinitialize a CRL distribution points type.
*
* Since: 3.3.0
**/
@@ -2169,14 +2168,14 @@ void gnutls_x509_crl_dist_points_deinit(gnutls_x509_crl_dist_points_t cdp)
/**
* gnutls_x509_crl_dist_points_get:
- * @cdp: The CRL distribution points structure
+ * @cdp: The CRL distribution points
* @seq: specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.)
* @type: The name type of the corresponding name (gnutls_x509_subject_alt_name_t)
* @san: The distribution point names (to be treated as constant)
* @reasons: Revocation reasons. An ORed sequence of flags from %gnutls_x509_crl_reason_flags_t.
*
* This function retrieves the individual CRL distribution points (2.5.29.31),
- * contained in provided structure.
+ * contained in provided type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
* if the index is out of bounds, otherwise a negative error value.
@@ -2231,13 +2230,13 @@ int crl_dist_points_set(gnutls_x509_crl_dist_points_t cdp,
/**
* gnutls_x509_crl_dist_points_set:
- * @cdp: The CRL distribution points structure
+ * @cdp: The CRL distribution points
* @type: The type of the name (of %gnutls_subject_alt_names_t)
* @san: The point name data
* @reasons: Revocation reasons. An ORed sequence of flags from %gnutls_x509_crl_reason_flags_t.
*
* This function will store the specified CRL distibution point value
- * the @cdp structure.
+ * the @cdp type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value.
*
@@ -2267,11 +2266,11 @@ int gnutls_x509_crl_dist_points_set(gnutls_x509_crl_dist_points_t cdp,
/**
* gnutls_x509_ext_import_crl_dist_points:
* @ext: the DER encoded extension data
- * @cdp: A pointer to an initialized CRL distribution points structure.
+ * @cdp: A pointer to an initialized CRL distribution points.
* @flags: should be zero
*
* This function will extract the CRL distribution points extension (2.5.29.31)
- * and store it into the provided structure.
+ * and store it into the provided type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -2372,7 +2371,7 @@ int gnutls_x509_ext_import_crl_dist_points(const gnutls_datum_t * ext,
/**
* gnutls_x509_ext_export_crl_dist_points:
- * @cdp: A pointer to an initialized CRL distribution points structure.
+ * @cdp: A pointer to an initialized CRL distribution points.
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
* This function will convert the provided policies, to a certificate policy
@@ -2488,9 +2487,9 @@ struct gnutls_x509_aia_st {
/**
* gnutls_x509_aia_init:
- * @aia: The authority info access structure
+ * @aia: The authority info access
*
- * This function will initialize a CRL distribution points structure.
+ * This function will initialize an authority info access type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -2507,9 +2506,9 @@ int gnutls_x509_aia_init(gnutls_x509_aia_t * aia)
/**
* gnutls_x509_aia_deinit:
- * @aia: The authority info access structure
+ * @aia: The authority info access
*
- * This function will deinitialize a CRL distribution points structure.
+ * This function will deinitialize an authority info access type.
*
* Since: 3.3.0
**/
@@ -2527,13 +2526,13 @@ void gnutls_x509_aia_deinit(gnutls_x509_aia_t aia)
/**
* gnutls_x509_aia_get:
- * @aia: The authority info access structure
+ * @aia: The authority info access
* @seq: specifies the sequence number of the access descriptor (0 for the first one, 1 for the second etc.)
* @oid: the type of available data; to be treated as constant.
* @san_type: Will hold the type of the name of %gnutls_subject_alt_names_t (may be null).
* @san: the access location name; to be treated as constant (may be null).
*
- * This function reads from the Authority Information Access structure.
+ * This function reads from the Authority Information Access type.
*
* The @seq input parameter is used to indicate which member of the
* sequence the caller is interested in. The first member is 0, the
@@ -2571,14 +2570,14 @@ int gnutls_x509_aia_get(gnutls_x509_aia_t aia, unsigned int seq,
/**
* gnutls_x509_aia_set:
- * @aia: The authority info access structure
+ * @aia: The authority info access
* @oid: the type of data.
* @san_type: The type of the name (of %gnutls_subject_alt_names_t)
* @san: The alternative name data
* @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME
*
* This function will store the specified alternative name in
- * the @aia structure.
+ * the @aia type.
*
* Typically the value for @oid should be %GNUTLS_OID_AD_OCSP, or
* %GNUTLS_OID_AD_CAISSUERS.
@@ -2678,7 +2677,7 @@ static int parse_aia(ASN1_TYPE c2, gnutls_x509_aia_t aia)
/**
* gnutls_x509_ext_import_aia:
* @ext: The DER-encoded extension data
- * @aia: The authority info access structure
+ * @aia: The authority info access
* @flags: should be zero
*
* This function extracts the Authority Information Access (AIA)
@@ -2730,7 +2729,7 @@ int gnutls_x509_ext_import_aia(const gnutls_datum_t * ext,
/**
* gnutls_x509_ext_export_aia:
- * @aia: The authority info access structure
+ * @aia: The authority info access
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
* This function will DER encode the Authority Information Access (AIA)
@@ -2807,9 +2806,9 @@ struct gnutls_x509_key_purposes_st {
/**
* gnutls_subject_alt_names_init:
- * @p: The key purposes structure
+ * @p: The key purposes
*
- * This function will initialize an alternative names structure.
+ * This function will initialize an alternative names type.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -2837,9 +2836,9 @@ static void key_purposes_deinit(gnutls_x509_key_purposes_t p)
/**
* gnutls_x509_key_purpose_deinit:
- * @p: The key purposes structure
+ * @p: The key purposes
*
- * This function will deinitialize an alternative names structure.
+ * This function will deinitialize a key purposes type.
*
* Since: 3.3.0
**/
@@ -2851,11 +2850,11 @@ void gnutls_x509_key_purpose_deinit(gnutls_x509_key_purposes_t p)
/**
* gnutls_x509_key_purpose_set:
- * @p: The key purposes structure
+ * @p: The key purposes
* @oid: The object identifier of the key purpose
*
* This function will store the specified key purpose in the
- * purposes structure.
+ * purposes.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value.
*
@@ -2878,12 +2877,12 @@ int gnutls_x509_key_purpose_set(gnutls_x509_key_purposes_t p, const char *oid)
/**
* gnutls_x509_key_purpose_get:
- * @p: The key purposes structure
+ * @p: The key purposes
* @idx: The index of the key purpose to retrieve
* @oid: Will hold the object identifier of the key purpose (to be treated as constant)
*
* This function will retrieve the specified by the index key purpose in the
- * purposes structure. The object identifier will be a null terminated string.
+ * purposes type. The object identifier will be a null terminated string.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
* if the index is out of bounds, otherwise a negative error value.
@@ -2904,12 +2903,12 @@ int gnutls_x509_key_purpose_get(gnutls_x509_key_purposes_t p, unsigned idx, gnut
/**
* gnutls_x509_ext_import_key_purposes:
* @ext: The DER-encoded extension data
- * @p: The key purposes structure
+ * @p: The key purposes
* @flags: should be zero
*
* This function will extract the key purposes in the provided DER-encoded
- * ExtKeyUsageSyntax PKIX extension, to a %gnutls_x509_key_purposes_t structure.
- * The structure must be initialized.
+ * ExtKeyUsageSyntax PKIX extension, to a %gnutls_x509_key_purposes_t type.
+ * The data must be initialized.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.
*
@@ -2978,10 +2977,10 @@ int gnutls_x509_ext_import_key_purposes(const gnutls_datum_t * ext,
/**
* gnutls_x509_ext_export_key_purposes:
- * @p: The key purposes structure
+ * @p: The key purposes
* @ext: The DER-encoded extension data; must be freed using gnutls_free().
*
- * This function will convert the key purposes structure to a
+ * This function will convert the key purposes type to a
* DER-encoded PKIX ExtKeyUsageSyntax (2.5.29.37) extension. The output data in
* @ext will be allocated usin gnutls_malloc().
*
diff --git a/lib/x509/x509_write.c b/lib/x509/x509_write.c
index ef51a328b1..5ddbc0869d 100644
--- a/lib/x509/x509_write.c
+++ b/lib/x509/x509_write.c
@@ -113,7 +113,7 @@ gnutls_x509_crt_set_issuer_dn_by_oid(gnutls_x509_crt_t crt,
/**
* gnutls_x509_crt_set_proxy_dn:
- * @crt: a gnutls_x509_crt_t structure with the new proxy cert
+ * @crt: a gnutls_x509_crt_t type with the new proxy cert
* @eecrt: the end entity certificate that will be issuing the proxy
* @raw_flag: must be 0, or 1 if the CN is DER encoded
* @name: a pointer to the CN name, may be NULL (but MUST then be added later)
@@ -1530,8 +1530,8 @@ gnutls_x509_crt_set_authority_info_access(gnutls_x509_crt_t crt,
/**
* gnutls_x509_crt_set_policy:
- * @crt: should contain a #gnutls_x509_crt_t structure
- * @policy: A pointer to a policy structure.
+ * @crt: should contain a #gnutls_x509_crt_t type
+ * @policy: A pointer to a policy
* @critical: use non-zero if the extension is marked as critical
*
* This function will set the certificate policy extension (2.5.29.32).