From 8a2ffdfdb6e11bb2935260d1ce5b5dd9e3b83a09 Mon Sep 17 00:00:00 2001 From: Dongsun Lee Date: Tue, 19 Jul 2016 16:45:40 +0900 Subject: [PATCH] Change module names and add line feeds in some API descriptions Change-Id: Ib0b6630226bc250c189dbe0498d17ffe2b2d86cc Signed-off-by: Dongsun Lee --- api/yaca/yaca_types.h | 66 +++++++++++++++++++++++------------------------ doc/yaca_doc.h | 4 +-- doc/yaca_encryption_doc.h | 2 +- doc/yaca_integrity_doc.h | 2 +- doc/yaca_key_doc.h | 2 +- doc/yaca_simple_doc.h | 2 +- 6 files changed, 38 insertions(+), 40 deletions(-) diff --git a/api/yaca/yaca_types.h b/api/yaca/yaca_types.h index bb47cdf..47ede59 100755 --- a/api/yaca/yaca_types.h +++ b/api/yaca/yaca_types.h @@ -170,15 +170,15 @@ typedef enum { /** * AES encryption. * - Supported key lengths: @c 128, @c 192 and @c 256. - * - Supported block cipher modes: - * #YACA_BCM_CBC, - * #YACA_BCM_OFB, - * #YACA_BCM_CFB, - * #YACA_BCM_CFB1, - * #YACA_BCM_CFB8, - * #YACA_BCM_ECB, - * #YACA_BCM_GCM, - * #YACA_BCM_CCM, + * - Supported block cipher modes:\n + * #YACA_BCM_CBC,\n + * #YACA_BCM_OFB,\n + * #YACA_BCM_CFB,\n + * #YACA_BCM_CFB1,\n + * #YACA_BCM_CFB8,\n + * #YACA_BCM_ECB,\n + * #YACA_BCM_GCM,\n + * #YACA_BCM_CCM,\n * #YACA_BCM_CTR * - see #yaca_block_cipher_mode_e for details on additional properties (mandatory). */ @@ -187,12 +187,12 @@ typedef enum { /** * DES encryption. * - Supported key lengths: @c 64. - * - Supported block cipher modes: - * #YACA_BCM_CBC, - * #YACA_BCM_OFB, - * #YACA_BCM_CFB, - * #YACA_BCM_CFB1, - * #YACA_BCM_CFB8, + * - Supported block cipher modes:\n + * #YACA_BCM_CBC,\n + * #YACA_BCM_OFB,\n + * #YACA_BCM_CFB,\n + * #YACA_BCM_CFB1,\n + * #YACA_BCM_CFB8,\n * #YACA_BCM_ECB * - see #yaca_block_cipher_mode_e for details on additional properties (mandatory). */ @@ -201,10 +201,10 @@ typedef enum { /** * 3DES 2-key encryption. * - Supported key lengths: @c 128. - * - Supported block cipher modes: - * #YACA_BCM_CBC, - * #YACA_BCM_OFB, - * #YACA_BCM_CFB, + * - Supported block cipher modes:\n + * #YACA_BCM_CBC,\n + * #YACA_BCM_OFB,\n + * #YACA_BCM_CFB,\n * #YACA_BCM_ECB * - see #yaca_block_cipher_mode_e for details on additional properties (mandatory). * - Use double DES keys to perform corresponding 2-key 3DES encryption. @@ -214,12 +214,12 @@ typedef enum { /** * 3DES 3-key encryption. * - Supported key lengths: @c 192. - * - Supported block cipher modes: - * #YACA_BCM_CBC, - * #YACA_BCM_OFB, - * #YACA_BCM_CFB, - * #YACA_BCM_CFB1, - * #YACA_BCM_CFB8, + * - Supported block cipher modes:\n + * #YACA_BCM_CBC,\n + * #YACA_BCM_OFB,\n + * #YACA_BCM_CFB,\n + * #YACA_BCM_CFB1,\n + * #YACA_BCM_CFB8,\n * #YACA_BCM_ECB * - see #yaca_block_cipher_mode_e for details on additional properties (mandatory). * - Use triple DES keys to perform corresponding 3-key 3DES encryption. @@ -231,10 +231,10 @@ typedef enum { * This is a variable key length cipher. * - Supported key lengths: 8-1024 bits in steps of 8 bits. * - Effective key bits property by default equals to 128. - * - Supported block cipher modes: - * #YACA_BCM_CBC, - * #YACA_BCM_OFB, - * #YACA_BCM_CFB, + * - Supported block cipher modes:\n + * #YACA_BCM_CBC,\n + * #YACA_BCM_OFB,\n + * #YACA_BCM_CFB,\n * #YACA_BCM_ECB */ YACA_ENCRYPT_UNSAFE_RC2, @@ -251,10 +251,10 @@ typedef enum { * CAST5 encryption. * This is a variable key length cipher. * Supported key lengths: 40-128 bits in steps of 8 bits. - * - Supported block cipher modes: - * #YACA_BCM_CBC, - * #YACA_BCM_OFB, - * #YACA_BCM_CFB, + * - Supported block cipher modes:\n + * #YACA_BCM_CBC,\n + * #YACA_BCM_OFB,\n + * #YACA_BCM_CFB,\n * #YACA_BCM_ECB * - see #yaca_block_cipher_mode_e for details on additional properties (mandatory). */ diff --git a/doc/yaca_doc.h b/doc/yaca_doc.h index 86fed86..4b9751d 100755 --- a/doc/yaca_doc.h +++ b/doc/yaca_doc.h @@ -17,7 +17,7 @@ #define __TIZEN_CORE_YACA_DOC_H__ /** * @ingroup CAPI_SECURITY_FRAMEWORK - * @defgroup CAPI_YACA_MODULE yaca crypto module + * @defgroup CAPI_YACA_MODULE YACA * @brief The YACA (Yet Another Crypto Api) provides a crypto function such as key management, data integrity and data en/decryption. * Key management provides APIs for generating secured key,importing a key trying to match it to the key_type specified and exporting a key to arbitrary format. * Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digests and digital signature. @@ -49,8 +49,6 @@ * Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digest and digital signature. * Data en/decryption provides Advanced/Simpled APIs for en/decrypting a data and creating a IV. * - * @image html capi_yaca_overview_diagram.png - * * The yaca provides 3 types of API. * - key management APIs : These APIs provides generating key using random number or password, importing a key trying to match it to the key_type specified and exporting a key to arbitrary format. * - data en/decryption APIs : These APIs provides Advanced/Simpled API for the data encryption. diff --git a/doc/yaca_encryption_doc.h b/doc/yaca_encryption_doc.h index dff823a..7ab66fb 100755 --- a/doc/yaca_encryption_doc.h +++ b/doc/yaca_encryption_doc.h @@ -17,7 +17,7 @@ #define __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__ /** * @ingroup CAPI_YACA_MODULE - * @defgroup CAPI_YACA_ENCRYPTION_MODULE yaca encryption module + * @defgroup CAPI_YACA_ENCRYPTION_MODULE YACA Encryption * @brief Provides APIs for encryption and decryption operations. * * @section CAPI_YACA_ENCRYPTION_MODULE_HEADER Required Header diff --git a/doc/yaca_integrity_doc.h b/doc/yaca_integrity_doc.h index 023d812..049043f 100755 --- a/doc/yaca_integrity_doc.h +++ b/doc/yaca_integrity_doc.h @@ -17,7 +17,7 @@ #define __TIZEN_CORE_YACA_INTEGRITY_DOC_H__ /** * @ingroup CAPI_YACA_MODULE - * @defgroup CAPI_YACA_INTEGRITY_MODULE yaca integrity module + * @defgroup CAPI_YACA_INTEGRITY_MODULE YACA Integrity * @brief Provides APIs for creating/verifying a signature and digesting a message. * * @section CAPI_YACA_INTEGRITY_MODULE_HEADER Required Header diff --git a/doc/yaca_key_doc.h b/doc/yaca_key_doc.h index 382dfdc..a28c57c 100755 --- a/doc/yaca_key_doc.h +++ b/doc/yaca_key_doc.h @@ -17,7 +17,7 @@ #define __TIZEN_CORE_YACA_KEY_DOC_H__ /** * @ingroup CAPI_YACA_MODULE - * @defgroup CAPI_YACA_KEY_MODULE yaca key management module + * @defgroup CAPI_YACA_KEY_MODULE YACA Key Management * @brief Provides APIs for key handling operations such as generating and importing a key. * * @section CAPI_YACA_KEY_MODULE_HEADER Required Header diff --git a/doc/yaca_simple_doc.h b/doc/yaca_simple_doc.h index 3e1125f..bc29b5d 100755 --- a/doc/yaca_simple_doc.h +++ b/doc/yaca_simple_doc.h @@ -17,7 +17,7 @@ #define __TIZEN_CORE_YACA_SIMPLE_DOC_H__ /** * @ingroup CAPI_YACA_MODULE - * @defgroup CAPI_YACA_SIMPLE_MODULE yaca simple crypto module + * @defgroup CAPI_YACA_SIMPLE_MODULE YACA Simple Crypto * @brief Provides simple APIs for cryptographic operations. * * @section CAPI_YACA_SIMPLE_MODULE_HEADER Required Header -- 2.7.4