add @addtogroup 06/72606/12
authorsangsu <sangsu.choi@samsung.com>
Wed, 1 Jun 2016 22:27:46 +0000 (07:27 +0900)
committerkyungwook tak <k.tak@samsung.com>
Mon, 11 Jul 2016 01:05:06 +0000 (18:05 -0700)
Change-Id: I7bf0f7a94540d46edf5a7953d55d6a13f385946b
Signed-off-by: sangsu <sangsu.choi@samsung.com>
api/yaca/yaca_crypto.h [changed mode: 0644->0755]
api/yaca/yaca_digest.h [changed mode: 0644->0755]
api/yaca/yaca_encrypt.h [changed mode: 0644->0755]
api/yaca/yaca_error.h [changed mode: 0644->0755]
api/yaca/yaca_key.h [changed mode: 0644->0755]
api/yaca/yaca_seal.h [changed mode: 0644->0755]
api/yaca/yaca_sign.h [changed mode: 0644->0755]
api/yaca/yaca_simple.h [changed mode: 0644->0755]
api/yaca/yaca_types.h [changed mode: 0644->0755]

old mode 100644 (file)
new mode 100755 (executable)
index 9ee5ed7..d836013
@@ -32,10 +32,14 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Non-Crypto  Yet Another Crypto API - non crypto related functions.
+ * @addtogroup CAPI_YACA_ENCRYPTION_MODULE
+ * @{
+ */
+
+/**
+ * Note:  Non-Crypto  Yet Another Crypto API - non crypto related functions.
  *
  *
- * @{
  */
 
 /**
@@ -282,7 +286,9 @@ int yaca_context_get_output_length(const yaca_context_h ctx,
                                    size_t input_len,
                                    size_t *output_len);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index 0aac56c..a303617
@@ -32,10 +32,14 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Advanced-Digest  Advanced API for the message digests.
+ * @addtogroup CAPI_YACA_INTEGRITY_MODULE
+ * @{
+ */
+
+/**
+ * Note:  Advanced-Digest  Advanced API for the message digests.
  *
  *
- * @{
  */
 
 /**
@@ -108,7 +112,9 @@ int yaca_digest_update(yaca_context_h ctx, const char *data, size_t data_len);
  */
 int yaca_digest_finalize(yaca_context_h ctx, char *digest, size_t *digest_len);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index d2425d4..947b392
@@ -32,10 +32,14 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Advanced-Encryption-Symmetric  Advanced API for the symmetric encryption.
+ * @addtogroup CAPI_YACA_ENCRYPTION_MODULE
+ * @{
+ */
+
+/**
+ * Note:  Advanced-Encryption-Symmetric  Advanced API for the symmetric encryption.
  *
  *
- * @{
  */
 
 /**
@@ -235,7 +239,9 @@ int yaca_decrypt_finalize(yaca_context_h ctx,
                           char *plaintext,
                           size_t *plaintext_len);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index 3b76814..13c291a
@@ -31,14 +31,21 @@ extern "C" {
 #endif
 
 
-#define TIZEN_ERROR_YACA -0x01E30000
+/**
+ * @addtogroup CAPI_YACA_ENCRYPTION_MODULE
+ * @{
+ */
 
 /**
- * @defgroup  Error  Yet another Crypto API - error enums.
+ *  Note:  Error  Yet another Crypto API - error enums.
  *
- * @{
  */
 
+/* define it temporary until this code goes into capi-base-common package */
+#ifndef TIZEN_ERROR_YACA
+#define TIZEN_ERROR_YACA -0x01E30000
+#endif
+
 /**
  * @brief Enumeration of YACA error values.
  *
@@ -60,7 +67,9 @@ typedef enum {
        YACA_ERROR_INVALID_PASSWORD   = TIZEN_ERROR_YACA | 0x03
 } yaca_error_e;
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index 288e6ce..c686b2a
@@ -32,10 +32,14 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Key  Advanced API for the key and IV handling.
+ * @addtogroup CAPI_YACA_KEY_MODULE
+ * @{
+ */
+
+/**
+ * Note:  Key  Advanced API for the key and IV handling.
  *
  *
- * @{
  */
 
 /**
@@ -253,13 +257,11 @@ int yaca_key_extract_public(const yaca_key_h prv_key, yaca_key_h *pub_key);
  */
 void yaca_key_destroy(yaca_key_h key);
 
-/**@}*/
 
 /**
- * @defgroup  Key-Derivation  Advanced API for the key derivation.
+ * Note:  Key-Derivation  Advanced API for the key derivation.
  *
  *
- * @{
  */
 
 /**
@@ -295,7 +297,9 @@ int yaca_key_derive_pbkdf2(const char *password,
                            size_t key_bit_len,
                            yaca_key_h *key);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index 72d090e..041211c
@@ -32,14 +32,18 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Advanced-Encryption-Asymmetric  Advanced API for the asymmetric encryption.
+ * @addtogroup CAPI_YACA_ENCRYPTION_MODULE
+ * @{
+ */
+
+/**
+ * Note  Advanced-Encryption-Asymmetric  Advanced API for the asymmetric encryption.
  *
  *
  * @remarks  Seal does more than just encrypt. It first generates the encryption key and IV,
  *           then encrypts whole message using this key (and selected symmetric algorithm).
  *           Finally it encrypts symmetric key with public key.
  *
- * @{
  */
 
 /**
@@ -236,7 +240,9 @@ int yaca_open_finalize(yaca_context_h ctx,
                        char *plaintext,
                        size_t *plaintext_len);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index a5267d8..ec3209a
@@ -32,10 +32,14 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Advanced-Integrity  Advanced API for the integrity handling - HMAC, CMAC and digital signature.
+ * @addtogroup CAPI_YACA_INTEGRITY_MODULE
+ * @{
+ */
+
+/**
+ * Note:  Advanced-Integrity  Advanced API for the integrity handling - HMAC, CMAC and digital signature.
  *
  *
- * @{
  */
 
 /**
@@ -272,7 +276,9 @@ int yaca_verify_finalize(yaca_context_h ctx,
                          const char *signature,
                          size_t signature_len);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index ecd532a..efcd3c4
@@ -32,7 +32,12 @@ extern "C" {
 #endif
 
 /**
- * @defgroup  Simple-API  Simple API.
+ * @addtogroup CAPI_YACA_SIMPLE_MODULE
+ * @{
+ */
+
+/**
+ * Note:  Simple-API  Simple API.
  *
  *  @remarks  This is simple API.
  *            Design constraints:
@@ -42,7 +47,6 @@ extern "C" {
  *            - GCM and CCM chaining is not supported
  *            - All outputs are allocated by the library
  *
- * @{
  */
 
 /**
@@ -294,7 +298,9 @@ int yaca_simple_calculate_cmac(yaca_encrypt_algorithm_e algo,
                                char **mac,
                                size_t *mac_len);
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */
old mode 100644 (file)
new mode 100755 (executable)
index c1a6430..19bb45c
@@ -29,10 +29,14 @@ extern "C" {
 #endif
 
 /**
- * @defgroup Crypto-Types Yet Another Crypto API - types.
+ * @addtogroup CAPI_YACA_ENCRYPTION_MODULE
+ * @{
+ */
+
+/**
+ * Note: Crypto-Types Yet Another Crypto API - types.
  *
  *
- * @{
  */
 
 /**
@@ -429,7 +433,9 @@ typedef enum {
        YACA_PADDING_PKCS1_PSS,
 } yaca_padding_e;
 
-/**@}*/
+/**
+  * @}
+  */
 
 #ifdef __cplusplus
 } /* extern */