Do not enumerate all related modules with only one @see tag. 11/71911/3
authorDariusz Michaluk <d.michaluk@samsung.com>
Fri, 27 May 2016 12:34:51 +0000 (14:34 +0200)
committerDariusz Michaluk <d.michaluk@samsung.com>
Fri, 27 May 2016 14:53:52 +0000 (16:53 +0200)
Change-Id: I5b7e3856794f099e7f2f65dde3e67bc35a81625a

api/yaca/yaca_crypto.h
api/yaca/yaca_digest.h
api/yaca/yaca_encrypt.h
api/yaca/yaca_key.h
api/yaca/yaca_seal.h
api/yaca/yaca_sign.h
api/yaca/yaca_simple.h

index 30c2734..6b8e634 100644 (file)
@@ -52,6 +52,7 @@ extern "C" {
  * @since_tizen 3.0
  *
  * @return YACA_ERROR_NONE on success, negative on error.
+ *
  * @see yaca_exit()
  */
 int yaca_init(void);
@@ -73,7 +74,10 @@ void yaca_exit(void);
  * @param[in] size  Size of the allocation (bytes).
  *
  * @return NULL on failure, pointer to allocated memory otherwise.
- * @see yaca_zalloc(), yaca_realloc(), yaca_free()
+ *
+ * @see yaca_zalloc()
+ * @see yaca_realloc()
+ * @see yaca_free()
  */
 void *yaca_malloc(size_t size);
 
@@ -85,7 +89,10 @@ void *yaca_malloc(size_t size);
  * @param[in] size  Size of the allocation (bytes).
  *
  * @return NULL on failure, pointer to allocated and zeroed memory otherwise.
- * @see yaca_malloc(), yaca_realloc(), yaca_free()
+ *
+ * @see yaca_malloc()
+ * @see yaca_realloc()
+ * @see yaca_free()
  */
 void *yaca_zalloc(size_t size);
 
@@ -98,7 +105,10 @@ void *yaca_zalloc(size_t size);
  * @param[in] size  Size of the new allocation (bytes).
  *
  * @return NULL on failure, pointer to allocated memory otherwise.
- * @see yaca_malloc(), yaca_zalloc(), yaca_free()
+ *
+ * @see yaca_malloc()
+ * @see yaca_zalloc()
+ * @see yaca_free()
  */
 void *yaca_realloc(void *addr, size_t size);
 
@@ -109,7 +119,10 @@ void *yaca_realloc(void *addr, size_t size);
  * @since_tizen 3.0
  *
  * @param[in] ptr  Pointer to the memory to be freed.
- * @see yaca_malloc(), yaca_zalloc(), yaca_realloc()
+ *
+ * @see yaca_malloc()
+ * @see yaca_zalloc()
+ * @see yaca_realloc()
  *
  */
 void yaca_free(void *ptr);
@@ -138,7 +151,9 @@ int yaca_rand_bytes(char *data, size_t data_len);
  * @param[in]     value_len  Length of the parameter value.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_ex_param_e, yaca_ctx_get_param()
+ *
+ * @see #yaca_ex_param_e
+ * @see yaca_ctx_get_param()
  */
 int yaca_ctx_set_param(yaca_ctx_h ctx,
                        yaca_ex_param_e param,
@@ -157,7 +172,9 @@ int yaca_ctx_set_param(yaca_ctx_h ctx,
  * @param[out] value_len  Length of the parameter value will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_ex_param_e, yaca_ctx_set_param()
+ *
+ * @see #yaca_ex_param_e
+ * @see yaca_ctx_set_param()
  */
 int yaca_ctx_get_param(const yaca_ctx_h ctx,
                        yaca_ex_param_e param,
@@ -171,6 +188,7 @@ int yaca_ctx_get_param(const yaca_ctx_h ctx,
  * @since_tizen 3.0
  *
  * @param[in,out] ctx  Crypto context.
+ *
  * @see #yaca_ctx_h
  *
  */
index 2c7be86..c91298a 100644 (file)
@@ -48,7 +48,10 @@ extern "C" {
  * @param[in]  algo  Digest algorithm that will be used.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_digest_algo_e, yaca_digest_update(), yaca_digest_final()
+ *
+ * @see #yaca_digest_algo_e
+ * @see yaca_digest_update()
+ * @see yaca_digest_final()
  */
 int yaca_digest_init(yaca_ctx_h *ctx, yaca_digest_algo_e algo);
 
@@ -62,7 +65,9 @@ int yaca_digest_init(yaca_ctx_h *ctx, yaca_digest_algo_e algo);
  * @param[in]     data_len  Length of the data.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_digest_init(), yaca_digest_final()
+ *
+ * @see yaca_digest_init()
+ * @see yaca_digest_final()
  */
 int yaca_digest_update(yaca_ctx_h ctx, const char *data, size_t data_len);
 
@@ -77,7 +82,9 @@ int yaca_digest_update(yaca_ctx_h ctx, const char *data, size_t data_len);
  * @param[out]    digest_len  Length of the digest, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_digest_init(), yaca_digest_update()
+ *
+ * @see yaca_digest_init()
+ * @see yaca_digest_update()
  */
 int yaca_digest_final(yaca_ctx_h ctx, char *digest, size_t *digest_len);
 
index cba5332..02269c0 100644 (file)
@@ -51,7 +51,11 @@ extern "C" {
  * @param[in]  iv       Initialization vector that will be used.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_enc_algo_e, #yaca_block_cipher_mode_e, yaca_encrypt_update(), yaca_encrypt_final()
+ *
+ * @see #yaca_enc_algo_e
+ * @see #yaca_block_cipher_mode_e
+ * @see yaca_encrypt_update()
+ * @see yaca_encrypt_final()
  */
 int yaca_encrypt_init(yaca_ctx_h *ctx,
                       yaca_enc_algo_e algo,
@@ -72,7 +76,9 @@ int yaca_encrypt_init(yaca_ctx_h *ctx,
  * @param[out]    cipher_len  Length of the encrypted data, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_encrypt_init(), yaca_encrypt_final()
+ *
+ * @see yaca_encrypt_init()
+ * @see yaca_encrypt_final()
  */
 int yaca_encrypt_update(yaca_ctx_h ctx,
                         const char *plain,
@@ -91,7 +97,9 @@ int yaca_encrypt_update(yaca_ctx_h ctx,
  * @param[out]    cipher_len  Length of the final piece, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_encrypt_init(), yaca_encrypt_update()
+ *
+ * @see yaca_encrypt_init()
+ * @see yaca_encrypt_update()
  */
 int yaca_encrypt_final(yaca_ctx_h ctx,
                        char *cipher,
@@ -109,7 +117,11 @@ int yaca_encrypt_final(yaca_ctx_h ctx,
  * @param[in]  iv       Initialization vector that was used to encrypt the data.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_enc_algo_e, #yaca_block_cipher_mode_e, yaca_decrypt_update(), yaca_decrypt_final()
+ *
+ * @see #yaca_enc_algo_e
+ * @see #yaca_block_cipher_mode_e
+ * @see yaca_decrypt_update()
+ * @see yaca_decrypt_final()
  */
 int yaca_decrypt_init(yaca_ctx_h *ctx,
                       yaca_enc_algo_e algo,
@@ -130,7 +142,9 @@ int yaca_decrypt_init(yaca_ctx_h *ctx,
  * @param[out]    plain_len   Length of the decrypted data, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_decrypt_init(), yaca_decrypt_final()
+ *
+ * @see yaca_decrypt_init()
+ * @see yaca_decrypt_final()
  */
 int yaca_decrypt_update(yaca_ctx_h ctx,
                         const char *cipher,
@@ -149,7 +163,9 @@ int yaca_decrypt_update(yaca_ctx_h ctx,
  * @param[out]    plain_len  Length of the final piece, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_decrypt_init(), yaca_decrypt_update()
+ *
+ * @see yaca_decrypt_init()
+ * @see yaca_decrypt_update()
  */
 int yaca_decrypt_final(yaca_ctx_h ctx,
                        char *plain,
index 4786d9a..455df79 100755 (executable)
@@ -96,7 +96,10 @@ int yaca_key_get_bits(const yaca_key_h key, size_t *key_bits);
  *
  * @return YACA_ERROR_NONE on success, YACA_ERROR_PASSWORD_INVALID if wrong password given,
  *         negative on error.
- * @see #yaca_key_type_e, yaca_key_export(), yaca_key_free()
+ *
+ * @see #yaca_key_type_e
+ * @see yaca_key_export()
+ * @see yaca_key_free()
  */
 int yaca_key_import(yaca_key_h *key,
                     yaca_key_type_e key_type,
@@ -137,7 +140,11 @@ int yaca_key_import(yaca_key_h *key,
  * @param[out] data_len      Size of the output data.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_fmt_e, #yaca_key_file_fmt_e, yaca_key_import(), yaca_key_free()
+ *
+ * @see #yaca_key_fmt_e
+ * @see #yaca_key_file_fmt_e
+ * @see yaca_key_import()
+ * @see yaca_key_free()
  */
 int yaca_key_export(const yaca_key_h key,
                     yaca_key_fmt_e key_fmt,
@@ -158,7 +165,10 @@ int yaca_key_export(const yaca_key_h key,
  * @param[in]  key_bits  Length of the key (in bits) to be generated.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_key_bits_e, yaca_key_free()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_key_bits_e
+ * @see yaca_key_free()
  */
 int yaca_key_gen(yaca_key_h *key,
                  yaca_key_type_e key_type,
@@ -173,7 +183,10 @@ int yaca_key_gen(yaca_key_h *key,
  * @param[out] pub_key   Extracted public key (must be freed with yaca_key_free()).
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_key_gen(), yaca_key_import(), yaca_key_free()
+ *
+ * @see yaca_key_gen()
+ * @see yaca_key_import()
+ * @see yaca_key_free()
  */
 int yaca_key_extract_public(const yaca_key_h prv_key, yaca_key_h *pub_key);
 
@@ -183,7 +196,10 @@ int yaca_key_extract_public(const yaca_key_h prv_key, yaca_key_h *pub_key);
  * @since_tizen 3.0
  *
  * @param key  Key to be freed.
- * @see yaca_key_import(), yaca_key_export(), yaca_key_gen()
+ *
+ * @see yaca_key_import()
+ * @see yaca_key_export()
+ * @see yaca_key_gen()
  *
  */
 void yaca_key_free(yaca_key_h key);
index 81cd401..190be94 100644 (file)
@@ -57,7 +57,11 @@ extern "C" {
  * @param[out] iv            Generated initialization vector that will be used.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_enc_algo_e, #yaca_block_cipher_mode_e, yaca_seal_update(), yaca_seal_final()
+ *
+ * @see #yaca_enc_algo_e
+ * @see #yaca_block_cipher_mode_e
+ * @see yaca_seal_update()
+ * @see yaca_seal_final()
  */
 int yaca_seal_init(yaca_ctx_h *ctx,
                    const yaca_key_h pub_key,
@@ -80,7 +84,9 @@ int yaca_seal_init(yaca_ctx_h *ctx,
  * @param[out]    cipher_len  Length of the encrypted data, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_seal_init(), yaca_seal_final()
+ *
+ * @see yaca_seal_init()
+ * @see yaca_seal_final()
  */
 int yaca_seal_update(yaca_ctx_h ctx,
                      const char *plain,
@@ -99,7 +105,9 @@ int yaca_seal_update(yaca_ctx_h ctx,
  * @param[out]    cipher_len  Length of the final piece, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_seal_init(), yaca_seal_update()
+ *
+ * @see yaca_seal_init()
+ * @see yaca_seal_update()
  */
 int yaca_seal_final(yaca_ctx_h ctx,
                     char *cipher,
@@ -119,7 +127,11 @@ int yaca_seal_final(yaca_ctx_h ctx,
  * @param[in]  iv            Initialization vector that was used for the encryption.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_enc_algo_e, #yaca_block_cipher_mode_e, yaca_open_update(), yaca_open_final()
+ *
+ * @see #yaca_enc_algo_e
+ * @see #yaca_block_cipher_mode_e
+ * @see yaca_open_update()
+ * @see yaca_open_final()
  */
 int yaca_open_init(yaca_ctx_h *ctx,
                    const yaca_key_h prv_key,
@@ -142,7 +154,9 @@ int yaca_open_init(yaca_ctx_h *ctx,
  * @param[out]    plain_len   Length of the decrypted data, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_open_init(), yaca_open_final()
+ *
+ * @see yaca_open_init()
+ * @see yaca_open_final()
  */
 int yaca_open_update(yaca_ctx_h ctx,
                      const char *cipher,
@@ -161,7 +175,9 @@ int yaca_open_update(yaca_ctx_h ctx,
  * @param[out]    plain_len  Length of the final piece, actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_open_init(), yaca_open_update()
+ *
+ * @see yaca_open_init()
+ * @see yaca_open_update()
  */
 int yaca_open_final(yaca_ctx_h ctx,
                     char *plain,
index d8098c6..0d2f399 100644 (file)
@@ -57,9 +57,14 @@ extern "C" {
  *                   - #YACA_KEY_TYPE_EC_PRIV.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_digest_algo_e, yaca_sign_update(),
- *      yaca_sign_final(), yaca_verify_init(), yaca_verify_update(),
- *      yaca_verify_final()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_digest_algo_e
+ * @see yaca_sign_update()
+ * @see yaca_sign_final()
+ * @see yaca_verify_init()
+ * @see yaca_verify_update()
+ * @see yaca_verify_final()
  */
 int yaca_sign_init(yaca_ctx_h *ctx,
                    yaca_digest_algo_e algo,
@@ -80,8 +85,12 @@ int yaca_sign_init(yaca_ctx_h *ctx,
  *                   - #YACA_KEY_TYPE_DES.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_digest_algo_e, yaca_sign_update(),
- *      yaca_sign_final(), yaca_memcmp()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_digest_algo_e
+ * @see yaca_sign_update()
+ * @see yaca_sign_final()
+ * @see yaca_memcmp()
  */
 int yaca_sign_hmac_init(yaca_ctx_h *ctx,
                         yaca_digest_algo_e algo,
@@ -102,8 +111,12 @@ int yaca_sign_hmac_init(yaca_ctx_h *ctx,
  *                   - #YACA_KEY_TYPE_DES.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_enc_algo_e, yaca_sign_update(),
- *      yaca_sign_final(), yaca_memcmp()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_enc_algo_e
+ * @see yaca_sign_update()
+ * @see yaca_sign_final()
+ * @see yaca_memcmp()
  */
 int yaca_sign_cmac_init(yaca_ctx_h *ctx,
                         yaca_enc_algo_e algo,
@@ -120,8 +133,11 @@ int yaca_sign_cmac_init(yaca_ctx_h *ctx,
  * @param[in]     data_len  Length of the data.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_sign_init(), yaca_sign_final(), yaca_sign_hmac_init(),
- *      yaca_sign_cmac_init()
+ *
+ * @see yaca_sign_init()
+ * @see yaca_sign_final()
+ * @see yaca_sign_hmac_init()
+ * @see yaca_sign_cmac_init()
  */
 int yaca_sign_update(yaca_ctx_h ctx,
                      const char *data,
@@ -139,8 +155,11 @@ int yaca_sign_update(yaca_ctx_h ctx,
  *                                 actual number of bytes written will be returned here.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_sign_init(), yaca_sign_update(), yaca_sign_hmac_init(),
- *      yaca_sign_cmac_init()
+ *
+ * @see yaca_sign_init()
+ * @see yaca_sign_update()
+ * @see yaca_sign_hmac_init()
+ * @see yaca_sign_cmac_init()
  */
 int yaca_sign_final(yaca_ctx_h ctx,
                     char *signature,
@@ -160,8 +179,11 @@ int yaca_sign_final(yaca_ctx_h ctx,
  *                   - #YACA_KEY_TYPE_EC_PUB.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_digest_algo_e, yaca_verify_update(),
- *      yaca_verify_final()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_digest_algo_e
+ * @see yaca_verify_update()
+ * @see yaca_verify_final()
  */
 int yaca_verify_init(yaca_ctx_h *ctx,
                      yaca_digest_algo_e algo,
@@ -177,7 +199,9 @@ int yaca_verify_init(yaca_ctx_h *ctx,
  * @param[in]     data_len  Length of the data.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see yaca_verify_init(), yaca_verify_final()
+ *
+ * @see yaca_verify_init()
+ * @see yaca_verify_final()
  */
 int yaca_verify_update(yaca_ctx_h ctx,
                        const char *data,
@@ -194,7 +218,9 @@ int yaca_verify_update(yaca_ctx_h ctx,
  *
  * @return YACA_ERROR_NONE on success, YACA_ERROR_DATA_MISMATCH if verification fails,
  *         negative on error.
- * @see yaca_verify_init(), yaca_verify_update()
+ *
+ * @see yaca_verify_init()
+ * @see yaca_verify_update()
  */
 int yaca_verify_final(yaca_ctx_h ctx,
                       const char *signature,
index e50f7b2..9f3d90c 100644 (file)
@@ -60,6 +60,7 @@ extern "C" {
  * @param[out] digest_len  Length of message digest (depends on algorithm).
  *
  * @return YACA_ERROR_NONE on success, negative on error.
+ *
  * @see #yaca_digest_algo_e
  */
 int yaca_digest_calc(yaca_digest_algo_e algo,
@@ -84,7 +85,10 @@ int yaca_digest_calc(yaca_digest_algo_e algo,
  * @param[out] cipher_len  Length of the encrypted data (may be larger than decrypted).
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_enc_algo_e, #yaca_block_cipher_mode_e, yaca_decrypt()
+ *
+ * @see #yaca_enc_algo_e
+ * @see #yaca_block_cipher_mode_e
+ * @see yaca_decrypt()
  */
 int yaca_encrypt(yaca_enc_algo_e algo,
                  yaca_block_cipher_mode_e bcm,
@@ -111,7 +115,10 @@ int yaca_encrypt(yaca_enc_algo_e algo,
  * @param[out] plain_len   Length of the decrypted data.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_enc_algo_e, #yaca_block_cipher_mode_e, yaca_encrypt()
+ *
+ * @see #yaca_enc_algo_e
+ * @see #yaca_block_cipher_mode_e
+ * @see yaca_encrypt()
  */
 int yaca_decrypt(yaca_enc_algo_e algo,
                  yaca_block_cipher_mode_e bcm,
@@ -140,7 +147,10 @@ int yaca_decrypt(yaca_enc_algo_e algo,
  * @param[out] signature_len  Length of the signature.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_digest_algo_e, yaca_verify(),
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_digest_algo_e
+ * @see yaca_verify()
  */
 int yaca_sign(yaca_digest_algo_e algo,
               const yaca_key_h key,
@@ -167,7 +177,10 @@ int yaca_sign(yaca_digest_algo_e algo,
  *
  * @return YACA_ERROR_NONE on success, YACA_ERROR_SIGNATURE_INVALID if verification fails,
  *         negative on error.
- * @see #yaca_key_type_e, #yaca_digest_algo_e, yaca_sign(),
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_digest_algo_e
+ * @see yaca_sign()
  */
 int yaca_verify(yaca_digest_algo_e algo,
                 const yaca_key_h key,
@@ -195,7 +208,10 @@ int yaca_verify(yaca_digest_algo_e algo,
  * @param[out] mac_len   Length of the MAC.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_digest_algo_e, yaca_memcmp()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_digest_algo_e
+ * @see yaca_memcmp()
  */
 int yaca_hmac(yaca_digest_algo_e algo,
               const yaca_key_h key,
@@ -223,7 +239,10 @@ int yaca_hmac(yaca_digest_algo_e algo,
  * @param[out] mac_len   Length of the MAC.
  *
  * @return YACA_ERROR_NONE on success, negative on error.
- * @see #yaca_key_type_e, #yaca_enc_algo_e, yaca_memcmp()
+ *
+ * @see #yaca_key_type_e
+ * @see #yaca_enc_algo_e
+ * @see yaca_memcmp()
  */
 int yaca_cmac(yaca_enc_algo_e algo,
               const yaca_key_h key,