ACR: Apply changes from API review part 1

- "bogus" -> "incorrect"
- Add missing @see entries for mentioned functions
- "recomend" -> "recommend"
- Remove EC key type from documentation

Change-Id: I311ccb00a099c5c156c97b5821782a57c14e2c98

diff --git a/api/yaca/yaca_crypto.h b/api/yaca/yaca_crypto.h
index 1d4a601..3105e34 100644 (file)
--- a/api/yaca/yaca_crypto.h
+++ b/api/yaca/yaca_crypto.h
@@ -139,7 +139,7 @@ void yaca_free(void *ptr);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0)
  * @retval #YACA_ERROR_INTERNAL Internal error
  */
 int yaca_rand_bytes(char *data, size_t data_len);
@@ -157,8 +157,8 @@ int yaca_rand_bytes(char *data, size_t data_len);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context, invalid param)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context or param)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_ex_param_e
@@ -182,13 +182,14 @@ int yaca_ctx_set_param(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context, invalid param)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context or param)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_ex_param_e
  * @see yaca_ctx_set_param()
+ * @see yaca_free()
  */
 int yaca_ctx_get_param(const yaca_ctx_h ctx,
                        yaca_ex_param_e param,
@@ -220,8 +221,8 @@ void yaca_ctx_free(yaca_ctx_h ctx);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context, invalid input_len)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context or input_len)
  * @retval #YACA_ERROR_INTERNAL Internal error
  */
 int yaca_get_output_length(const yaca_ctx_h ctx, size_t input_len, size_t *output_len);

diff --git a/api/yaca/yaca_digest.h b/api/yaca/yaca_digest.h
index b38ccf8..b599fe1 100644 (file)
--- a/api/yaca/yaca_digest.h
+++ b/api/yaca/yaca_digest.h
@@ -49,14 +49,15 @@ extern "C" {
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_digest_algo_e
  * @see yaca_digest_update()
  * @see yaca_digest_final()
+ * @see yaca_ctx_free()
  */
 int yaca_digest_init(yaca_ctx_h *ctx, yaca_digest_algo_e algo);
 
@@ -71,8 +72,8 @@ int yaca_digest_init(yaca_ctx_h *ctx, yaca_digest_algo_e algo);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_digest_init()
@@ -93,12 +94,13 @@ int yaca_digest_update(yaca_ctx_h ctx, const char *data, size_t data_len);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_digest_init()
  * @see yaca_digest_update()
+ * @see yaca_get_digest_length()
  */
 int yaca_digest_final(yaca_ctx_h ctx, char *digest, size_t *digest_len);
 

diff --git a/api/yaca/yaca_encrypt.h b/api/yaca/yaca_encrypt.h
index 7c7cad4..d7a38f2 100644 (file)
--- a/api/yaca/yaca_encrypt.h
+++ b/api/yaca/yaca_encrypt.h
@@ -52,8 +52,8 @@ extern "C" {
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, bcm, invalid sym_key or iv)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo, bcm, sym_key or iv)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -61,6 +61,7 @@ extern "C" {
  * @see #yaca_block_cipher_mode_e
  * @see yaca_encrypt_update()
  * @see yaca_encrypt_final()
+ * @see yaca_ctx_free()
  */
 int yaca_encrypt_init(yaca_ctx_h *ctx,
                       yaca_enc_algo_e algo,
@@ -83,12 +84,13 @@ int yaca_encrypt_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_encrypt_init()
  * @see yaca_encrypt_final()
+ * @see yaca_get_output_length()
  */
 int yaca_encrypt_update(yaca_ctx_h ctx,
                         const char *plain,
@@ -109,12 +111,13 @@ int yaca_encrypt_update(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_encrypt_init()
  * @see yaca_encrypt_update()
+ * @see yaca_get_output_length()
  */
 int yaca_encrypt_final(yaca_ctx_h ctx,
                        char *cipher,
@@ -133,8 +136,8 @@ int yaca_encrypt_final(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, bcm, invalid sym_key or iv)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo, bcm, sym_key or iv)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -142,6 +145,7 @@ int yaca_encrypt_final(yaca_ctx_h ctx,
  * @see #yaca_block_cipher_mode_e
  * @see yaca_decrypt_update()
  * @see yaca_decrypt_final()
+ * @see yaca_ctx_free()
  */
 int yaca_decrypt_init(yaca_ctx_h *ctx,
                       yaca_enc_algo_e algo,
@@ -164,12 +168,13 @@ int yaca_decrypt_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_decrypt_init()
  * @see yaca_decrypt_final()
+ * @see yaca_get_output_length()
  */
 int yaca_decrypt_update(yaca_ctx_h ctx,
                         const char *cipher,
@@ -190,19 +195,20 @@ int yaca_decrypt_update(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_decrypt_init()
  * @see yaca_decrypt_update()
+ * @see yaca_get_block_length()
  */
 int yaca_decrypt_final(yaca_ctx_h ctx,
                        char *plain,
                        size_t *plain_len);
 
 /**
- * @brief  Returns the recomended/default length of the IV for a given encryption configuration.
+ * @brief  Returns the recommended/default length of the IV for a given encryption configuration.
  *
  * @since_tizen 3.0
  *
@@ -216,7 +222,7 @@ int yaca_decrypt_final(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
  *                                      invalid algo, bcm or key_bits)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *

diff --git a/api/yaca/yaca_key.h b/api/yaca/yaca_key.h
index c5aca0f..daf55a8 100644 (file)
--- a/api/yaca/yaca_key.h
+++ b/api/yaca/yaca_key.h
@@ -104,8 +104,8 @@ int yaca_key_get_bits(const yaca_key_h key, size_t *key_bits);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect key_type or data_len too big)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid key_type or data_len too big)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  * @retval #YACA_ERROR_PASSWORD_INVALID Invalid password given or password was required
@@ -155,8 +155,8 @@ int yaca_key_import(yaca_key_type_e key_type,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect key formats or data_len too big)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid key/file format or data_len too big)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -212,7 +212,7 @@ int yaca_key_gen(yaca_key_type_e key_type,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT prv_key is of incorrect type or pub_key is NULL
+ * @retval #YACA_ERROR_INVALID_ARGUMENT prv_key is of invalid type or pub_key is NULL
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -260,10 +260,13 @@ void yaca_key_free(yaca_key_h key);
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect algo or key_bits not dividable by 8)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid algo or key_bits not dividable by 8)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
+ *
+ * @see #yaca_digest_algo_e
+ * @see yaca_key_free()
  */
 int yaca_key_derive_pbkdf2(const char *password,
                            const char *salt,

diff --git a/api/yaca/yaca_seal.h b/api/yaca/yaca_seal.h
index beea34d..5bf3f2e 100644 (file)
--- a/api/yaca/yaca_seal.h
+++ b/api/yaca/yaca_seal.h
@@ -61,8 +61,8 @@ extern "C" {
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, bcm, sym_key_bits, invalid pub_key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo, bcm, sym_key_bits or pub_key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -71,6 +71,7 @@ extern "C" {
  * @see yaca_seal_update()
  * @see yaca_seal_final()
  * @see yaca_key_free()
+ * @see yaca_ctx_free()
  */
 int yaca_seal_init(yaca_ctx_h *ctx,
                    const yaca_key_h pub_key,
@@ -95,12 +96,13 @@ int yaca_seal_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_seal_init()
  * @see yaca_seal_final()
+ * @see yaca_get_output_length()
  */
 int yaca_seal_update(yaca_ctx_h ctx,
                      const char *plain,
@@ -121,12 +123,13 @@ int yaca_seal_update(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_seal_init()
  * @see yaca_seal_update()
+ * @see yaca_get_block_length()
  */
 int yaca_seal_final(yaca_ctx_h ctx,
                     char *cipher,
@@ -148,9 +151,8 @@ int yaca_seal_final(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, bcm, sym_key_bits,
- *                                      invalid prv_key, sym_key or iv)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo, bcm, sym_key_bits, prv_key, sym_key or iv)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -158,6 +160,7 @@ int yaca_seal_final(yaca_ctx_h ctx,
  * @see #yaca_block_cipher_mode_e
  * @see yaca_open_update()
  * @see yaca_open_final()
+ * @see yaca_ctx_free()
  */
 int yaca_open_init(yaca_ctx_h *ctx,
                    const yaca_key_h prv_key,
@@ -182,12 +185,13 @@ int yaca_open_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_open_init()
  * @see yaca_open_final()
+ * @see yaca_get_output_length()
  */
 int yaca_open_update(yaca_ctx_h ctx,
                      const char *cipher,
@@ -208,12 +212,13 @@ int yaca_open_update(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_open_init()
  * @see yaca_open_update()
+ * @see yaca_get_block_length()
  */
 int yaca_open_final(yaca_ctx_h ctx,
                     char *plain,

diff --git a/api/yaca/yaca_sign.h b/api/yaca/yaca_sign.h
index 658eb67..75ef56c 100644 (file)
--- a/api/yaca/yaca_sign.h
+++ b/api/yaca/yaca_sign.h
@@ -54,12 +54,11 @@ extern "C" {
  *                   on key type, supported key types:
  *                   - #YACA_KEY_TYPE_RSA_PRIV,
  *                   - #YACA_KEY_TYPE_DSA_PRIV,
- *                   - #YACA_KEY_TYPE_EC_PRIV
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -70,6 +69,7 @@ extern "C" {
  * @see yaca_verify_init()
  * @see yaca_verify_update()
  * @see yaca_verify_final()
+ * @see yaca_ctx_free()
  */
 int yaca_sign_init(yaca_ctx_h *ctx,
                    yaca_digest_algo_e algo,
@@ -91,8 +91,8 @@ int yaca_sign_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -101,6 +101,7 @@ int yaca_sign_init(yaca_ctx_h *ctx,
  * @see yaca_sign_update()
  * @see yaca_sign_final()
  * @see yaca_memcmp()
+ * @see yaca_ctx_free()
  */
 int yaca_sign_hmac_init(yaca_ctx_h *ctx,
                         yaca_digest_algo_e algo,
@@ -122,8 +123,8 @@ int yaca_sign_hmac_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -132,6 +133,7 @@ int yaca_sign_hmac_init(yaca_ctx_h *ctx,
  * @see yaca_sign_update()
  * @see yaca_sign_final()
  * @see yaca_memcmp()
+ * @see yaca_ctx_free()
  */
 int yaca_sign_cmac_init(yaca_ctx_h *ctx,
                         yaca_enc_algo_e algo,
@@ -149,8 +151,8 @@ int yaca_sign_cmac_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_sign_init()
@@ -175,14 +177,15 @@ int yaca_sign_update(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_sign_init()
  * @see yaca_sign_update()
  * @see yaca_sign_hmac_init()
  * @see yaca_sign_cmac_init()
+ * @see yaca_get_sign_length()
  */
 int yaca_sign_final(yaca_ctx_h ctx,
                     char *signature,
@@ -199,12 +202,11 @@ int yaca_sign_final(yaca_ctx_h ctx,
  *                   key type, supported key types:
  *                   - #YACA_KEY_TYPE_RSA_PUB,
  *                   - #YACA_KEY_TYPE_DSA_PUB,
- *                   - #YACA_KEY_TYPE_EC_PUB
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
@@ -212,6 +214,7 @@ int yaca_sign_final(yaca_ctx_h ctx,
  * @see #yaca_digest_algo_e
  * @see yaca_verify_update()
  * @see yaca_verify_final()
+ * @see yaca_ctx_free()
  */
 int yaca_verify_init(yaca_ctx_h *ctx,
                      yaca_digest_algo_e algo,
@@ -228,8 +231,8 @@ int yaca_verify_init(yaca_ctx_h *ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_verify_init()
@@ -250,13 +253,14 @@ int yaca_verify_update(yaca_ctx_h ctx,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
- *                                      incorrect context)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL,
+ *                                      invalid context)
  * @retval #YACA_ERROR_INTERNAL Internal error
  * @retval #YACA_ERROR_DATA_MISMATCH The verification failed
  *
  * @see yaca_verify_init()
  * @see yaca_verify_update()
+ * @see yaca_sign_final()
  */
 int yaca_verify_final(yaca_ctx_h ctx,
                       const char *signature,

diff --git a/api/yaca/yaca_simple.h b/api/yaca/yaca_simple.h
index 352b138..c72f2d6 100644 (file)
--- a/api/yaca/yaca_simple.h
+++ b/api/yaca/yaca_simple.h
@@ -61,12 +61,13 @@ extern "C" {
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_digest_algo_e
+ * @see yaca_free()
  */
 int yaca_digest_calc(yaca_digest_algo_e algo,
                      const char *data,
@@ -91,14 +92,15 @@ int yaca_digest_calc(yaca_digest_algo_e algo,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo, bcm, invalid sym_key, iv)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo, bcm, sym_key or iv)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_enc_algo_e
  * @see #yaca_block_cipher_mode_e
  * @see yaca_decrypt()
+ * @see yaca_free()
  */
 int yaca_encrypt(yaca_enc_algo_e algo,
                  yaca_block_cipher_mode_e bcm,
@@ -126,14 +128,15 @@ int yaca_encrypt(yaca_enc_algo_e algo,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo, bcm, invalid sym_key, iv)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo, bcm, sym_key or iv)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_enc_algo_e
  * @see #yaca_block_cipher_mode_e
  * @see yaca_encrypt()
+ * @see yaca_free()
  */
 int yaca_decrypt(yaca_enc_algo_e algo,
                  yaca_block_cipher_mode_e bcm,
@@ -154,7 +157,6 @@ int yaca_decrypt(yaca_enc_algo_e algo,
  *                            deduced based on key type, supported key types:
  *                            - #YACA_KEY_TYPE_RSA_PRIV,
  *                            - #YACA_KEY_TYPE_DSA_PRIV,
- *                            - #YACA_KEY_TYPE_EC_PRIV
  * @param[in]  data           Data to be signed
  * @param[in]  data_len       Length of the data
  * @param[out] signature      Message signature, will be allocated by the
@@ -163,14 +165,15 @@ int yaca_decrypt(yaca_enc_algo_e algo,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_key_type_e
  * @see #yaca_digest_algo_e
  * @see yaca_verify()
+ * @see yaca_free()
  */
 int yaca_sign(yaca_digest_algo_e algo,
               const yaca_key_h key,
@@ -189,7 +192,6 @@ int yaca_sign(yaca_digest_algo_e algo,
  *                            deduced based on key type, supported key types:
  *                            - #YACA_KEY_TYPE_RSA_PUB,
  *                            - #YACA_KEY_TYPE_DSA_PUB,
- *                            - #YACA_KEY_TYPE_EC_PUB
  * @param[in]  data           Signed data
  * @param[in]  data_len       Length of the data
  * @param[in]  signature      Message signature
@@ -197,8 +199,8 @@ int yaca_sign(yaca_digest_algo_e algo,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  * @retval #YACA_ERROR_DATA_MISMATCH The verification failed
@@ -234,14 +236,15 @@ int yaca_verify(yaca_digest_algo_e algo,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_key_type_e
  * @see #yaca_digest_algo_e
  * @see yaca_memcmp()
+ * @see yaca_free()
  */
 int yaca_hmac(yaca_digest_algo_e algo,
               const yaca_key_h key,
@@ -270,14 +273,15 @@ int yaca_hmac(yaca_digest_algo_e algo,
  *
  * @return #YACA_ERROR_NONE on success, negative on error
  * @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0
- *                                      incorrect algo, invalid key)
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have incorrect values (NULL, 0
+ *                                      invalid algo or key)
  * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
  * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_key_type_e
  * @see #yaca_enc_algo_e
  * @see yaca_memcmp()
+ * @see yaca_free()
  */
 int yaca_cmac(yaca_enc_algo_e algo,
               const yaca_key_h key,