doc: be consistent in the function descriptions

Signed-off-by: Jiří Klimeš <jklimes@redhat.com>

diff --git a/lib/crypto-api.c b/lib/crypto-api.c
index 30f817085fcd0d0b498e6e71ea59ad049085f2b1..46542aa4ff205e24890c90949149eed2d8d9cc4a 100644 (file)
--- a/lib/crypto-api.c
+++ b/lib/crypto-api.c
@@ -37,13 +37,13 @@ typedef struct api_cipher_hd_st {
 
 /**
  * gnutls_cipher_init:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @cipher: the cryptographic algorithm to use
- * @key: The key to be used for encryption/decryption
- * @iv: The IV to use (if not applicable set NULL)
+ * @key: the key to be used for encryption/decryption
+ * @iv: the IV to use (if not applicable set NULL)
  *
- * This function will initialize an context that can be used for
- * encryption/decryption of data. This will effectively use the
+ * This function will initialize the @handle context to be usable
+ * for encryption/decryption of data. This will effectively use the
  * current crypto backend in use by gnutls or the cryptographic
  * accelerator in use.
  *
@@ -84,9 +84,9 @@ gnutls_cipher_init(gnutls_cipher_hd_t * handle,
 
 /**
  * gnutls_cipher_tag:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @tag: will hold the tag
- * @tag_size: The length of the tag to return
+ * @tag_size: the length of the tag to return
  *
  * This function operates on authenticated encryption with
  * associated data (AEAD) ciphers and will return the
@@ -111,9 +111,9 @@ 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 type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @ptext: the data to be authenticated
- * @ptext_size: The length of the data
+ * @ptext_size: the length of the data
  *
  * This function operates on authenticated encryption with
  * associated data (AEAD) ciphers and authenticate the
@@ -140,9 +140,9 @@ gnutls_cipher_add_auth(gnutls_cipher_hd_t handle, const void *ptext,
 
 /**
  * gnutls_cipher_set_iv:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @iv: the IV to set
- * @ivlen: The length of the IV
+ * @ivlen: the length of the IV
  *
  * This function will set the IV to be used for the next
  * encryption block.
@@ -162,9 +162,9 @@ gnutls_cipher_set_iv(gnutls_cipher_hd_t handle, void *iv, size_t ivlen)
 
 /**
  * gnutls_cipher_encrypt:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @ptext: the data to encrypt
- * @ptext_len: The length of data to encrypt
+ * @ptext_len: the length of data to encrypt
  *
  * This function will encrypt the given data using the algorithm
  * specified by the context.
@@ -184,9 +184,9 @@ gnutls_cipher_encrypt(gnutls_cipher_hd_t handle, void *ptext,
 
 /**
  * gnutls_cipher_decrypt:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @ctext: the data to decrypt
- * @ctext_len: The length of data to decrypt
+ * @ctext_len: the length of data to decrypt
  *
  * This function will decrypt the given data using the algorithm
  * specified by the context.
@@ -214,11 +214,11 @@ gnutls_cipher_decrypt(gnutls_cipher_hd_t handle, void *ctext,
 
 /**
  * gnutls_cipher_encrypt2:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @ptext: the data to encrypt
- * @ptextlen: The length of data to encrypt
+ * @ptextlen: the length of data to encrypt
  * @ctext: the encrypted data
- * @ctext_len: The available length for encrypted data
+ * @ctext_len: the available length for encrypted data
  *
  * This function will encrypt the given data using the algorithm
  * specified by the context.
@@ -240,11 +240,11 @@ gnutls_cipher_encrypt2(gnutls_cipher_hd_t handle, const void *ptext,
 
 /**
  * gnutls_cipher_decrypt2:
- * @handle: is a #gnutls_cipher_hd_t type.
+ * @handle: is a #gnutls_cipher_hd_t type
  * @ctext: the data to decrypt
- * @ctext_len: The length of data to decrypt
+ * @ctext_len: the length of data to decrypt
  * @ptext: the decrypted data
- * @ptext_len: The available length for decrypted data
+ * @ptext_len: the available length for decrypted data
  *
  * This function will decrypt the given data using the algorithm
  * specified by the context.
@@ -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 type.
+ * @handle: is a #gnutls_cipher_hd_t type
  *
  * This function will deinitialize all resources occupied by the given
  * encryption context.
@@ -296,10 +296,10 @@ void gnutls_cipher_deinit(gnutls_cipher_hd_t handle)
 
 /**
  * gnutls_hmac_init:
- * @dig: is a #gnutls_hmac_hd_t type.
+ * @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
+ * @key: the key to be used for encryption
+ * @keylen: the length of the key
  *
  * This function will initialize an context that can be used to
  * produce a Message Authentication Code (MAC) of data.  This will
@@ -340,9 +340,9 @@ gnutls_hmac_init(gnutls_hmac_hd_t * dig,
 
 /**
  * gnutls_hmac_set_nonce:
- * @handle: is a #gnutls_hmac_hd_t type.
+ * @handle: is a #gnutls_hmac_hd_t type
  * @nonce: the data to set as nonce
- * @nonce_len: The length of data
+ * @nonce_len: the length of data
  *
  * This function will set the nonce in the MAC algorithm.
  *
@@ -357,9 +357,9 @@ gnutls_hmac_set_nonce(gnutls_hmac_hd_t handle, const void *nonce,
 
 /**
  * gnutls_hmac:
- * @handle: is a #gnutls_hmac_hd_t type.
+ * @handle: is a #gnutls_hmac_hd_t type
  * @ptext: the data to hash
- * @ptext_len: The length of data to hash
+ * @ptext_len: the length of data to hash
  *
  * This function will hash the given data using the algorithm
  * specified by the context.
@@ -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 type.
+ * @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 type.
+ * @handle: is a #gnutls_hmac_hd_t type
  * @digest: is the output value of the MAC
  *
  * This function will deinitialize all resources occupied by
@@ -424,9 +424,9 @@ int gnutls_hmac_get_len(gnutls_mac_algorithm_t algorithm)
  * gnutls_hmac_fast:
  * @algorithm: the hash algorithm to use
  * @key: the key to use
- * @keylen: The length of the key
+ * @keylen: the length of the key
  * @ptext: the data to hash
- * @ptext_len: The length of data to hash
+ * @ptext_len: the length of data to hash
  * @digest: is the output value of the hash
  *
  * This convenience function will hash the given data and return output
@@ -449,7 +449,7 @@ gnutls_hmac_fast(gnutls_mac_algorithm_t algorithm,
 
 /**
  * gnutls_hash_init:
- * @dig: is a #gnutls_hash_hd_t type.
+ * @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,9 +487,9 @@ gnutls_hash_init(gnutls_hash_hd_t * dig,
 
 /**
  * gnutls_hash:
- * @handle: is a #gnutls_hash_hd_t type.
+ * @handle: is a #gnutls_hash_hd_t type
  * @ptext: the data to hash
- * @ptext_len: The length of data to hash
+ * @ptext_len: the length of data to hash
  *
  * This function will hash the given data using the algorithm
  * specified by the context.
@@ -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 type.
+ * @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 type.
+ * @handle: is a #gnutls_hash_hd_t type
  * @digest: is the output value of the hash
  *
  * This function will deinitialize all resources occupied by
@@ -554,7 +554,7 @@ int gnutls_hash_get_len(gnutls_digest_algorithm_t algorithm)
  * gnutls_hash_fast:
  * @algorithm: the hash algorithm to use
  * @ptext: the data to hash
- * @ptext_len: The length of data to hash
+ * @ptext_len: the length of data to hash
  * @digest: is the output value of the hash
  *
  * This convenience function will hash the given data and return output
@@ -574,8 +574,8 @@ gnutls_hash_fast(gnutls_digest_algorithm_t algorithm,
 /**
  * gnutls_key_generate:
  * @key: is a pointer to a #gnutls_datum_t which will contain a newly
- * created key.
- * @key_size: The number of bytes of the key.
+ * created key
+ * @key_size: the number of bytes of the key
  *
  * Generates a random key of @key_size bytes.
  *