ACR:add doc document headers

Change-Id: Iafad752ca1980993c706434f34e136f44ffe3a91
Signed-off-by: sangsu <sangsu.choi@samsung.com>

diff --git a/doc/yaca_doc.h b/doc/yaca_doc.h
new file mode 100755 (executable)
index 0000000..e63e233
--- /dev/null
+++ b/doc/yaca_doc.h
@@ -0,0 +1,62 @@
+/*\r
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the License);\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an AS IS BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+#ifndef __TIZEN_CORE_YACA_DOC_H__\r
+#define __TIZEN_CORE_YACA_DOC_H__\r
+/**\r
+  * @ingroup CAPI_SECURITY_FRAMEWORK\r
+  * @defgroup CAPI_YACA_MODULE yaca crypto module\r
+  * @brief    The yaca(yet another crypto api) provides a crypto function such as key management ,  Data Integrity and data en/decryption .\r
+  *           Key mangement 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.\r
+  *           Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digest and digital signature.\r
+  *           Data en/decryption provides Advanced/Simpled APIs for en/decrypting and sealing/opening a data.\r
+  *\r
+  * @section CAPI_YACA_MODULE_OVERVIEW Overview\r
+  * <table>\r
+  *   <tr><th>API</th><th>Description</th></tr>\r
+  *   <tr>\r
+  *     <td> @ref CAPI_YACA_ENCRYPTION_MODULE</td>\r
+  *     <td> Provides APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys.</td>\r
+  *   </tr>\r
+  *   <tr>\r
+  *     <td> @ref CAPI_YACA_INTEGRITY_MODULE</td>\r
+  *     <td> Provides APIs for creating/verifying a signature, calculating HMAC/CMAC and calculating a message digest.</td>\r
+  *   </tr>\r
+  *   <tr>\r
+  *     <td> @ref CAPI_YACA_KEY_MODULE</td>\r
+  *     <td> Provides APIs for key handling operations such as generating, importing, and exporting a key and deriving a key from password.</td>\r
+  *   </tr>\r
+  *   <tr>\r
+  *     <td> @ref CAPI_YACA_SIMPLE_MODULE</td>\r
+  *     <td> Provides simple APIs for cryptographic operations.</td>\r
+  *   </tr>\r
+  * </table>\r
+  *\r
+  * The yaca provides a crypto function such as key management,  integrity handling  and data en/decryption.\r
+  * Key mangement 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.\r
+  * Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digests and digital signature.\r
+  * Data en/decryption provides Advanced/Simpled APIs for en/decrypting and sealing/opening a data.\r
+  *\r
+  * @image html capi_yaca_overview_diagram.png\r
+  *\r
+  * The yaca provides 3 types of API.\r
+  * - 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.\r
+  * - data en/decryption APIs : These APIs provides Advanced/Simpled API for the data encryption.\r
+  * - integrity APIs : These APIs provides creating a signature using asymmetric private key, verifing a signature using asymmetric public key, calculating a HMAC/CMAC of given message using symmetric key and calculating message digests of given message without key.\r
+  *\r
+  *\r
+  */\r
+\r
+#endif /* __TIZEN_CORE_YACA_DOC_H__ */\r

diff --git a/doc/yaca_encryption_doc.h b/doc/yaca_encryption_doc.h
new file mode 100755 (executable)
index 0000000..2fd3978
--- /dev/null
+++ b/doc/yaca_encryption_doc.h
@@ -0,0 +1,35 @@
+/*\r
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the License);\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an AS IS BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+#ifndef __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__\r
+#define __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__\r
+/**\r
+  * @ingroup CAPI_YACA_MODULE\r
+  * @defgroup CAPI_YACA_ENCRYPTION_MODULE yaca encryption module\r
+  * @brief    Provides APIs for encryption and decryption operations.\r
+  *\r
+  * @section CAPI_YACA_ENCRYPTION_MODULE_HEADER Required Header\r
+  * \#include <yaca/yaca_crypto.h>\r
+  * \#include <yaca/yaca_encrypt.h>\r
+  * \#include <yaca/yaca_seal.h>\r
+  * \#include <yaca/yaca_types.h>\r
+  * \#include <yaca/yaca_error.h>\r
+  *\r
+  * @section CAPI_YACA_ENCRYPTION_MODULE_OVERVIEW Overview\r
+  * It provides advanced APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys.\r
+  *\r
+  */\r
+\r
+#endif /* __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__ */\r

diff --git a/doc/yaca_integrity_doc.h b/doc/yaca_integrity_doc.h
new file mode 100755 (executable)
index 0000000..4ca565c
--- /dev/null
+++ b/doc/yaca_integrity_doc.h
@@ -0,0 +1,32 @@
+/*\r
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the License);\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an AS IS BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+#ifndef __TIZEN_CORE_YACA_INTEGRITY_DOC_H__\r
+#define __TIZEN_CORE_YACA_INTEGRITY_DOC_H__\r
+/**\r
+  * @ingroup CAPI_YACA_MODULE\r
+  * @defgroup CAPI_YACA_INTEGRITY_MODULE yaca integrity module\r
+  * @brief    Provides APIs for creating/verifying a signature and digesting a message.\r
+  *\r
+  * @section CAPI_YACA_INTEGRITY_MODULE_HEADER Required Header\r
+  * \#include <yaca/yaca_sign.h>\r
+  * \#include <yaca/yaca_digest.h>\r
+  *\r
+  * @section CAPI_YACA_INTEGRITY_MODULE_OVERVIEW Overview\r
+  * It provides advanced APIs for creating a signature using asymmetric private key, verifing a signature using asymmetric public key, calculating a HMAC/CMAC of given message using symmetric key and calculating message digests of given message without key.\r
+  *\r
+  */\r
+\r
+#endif /* __TIZEN_CORE_YACA_INTEGRITY_DOC_H__ */\r

diff --git a/doc/yaca_key_doc.h b/doc/yaca_key_doc.h
new file mode 100755 (executable)
index 0000000..ff887f3
--- /dev/null
+++ b/doc/yaca_key_doc.h
@@ -0,0 +1,31 @@
+/*\r
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the License);\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an AS IS BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+#ifndef __TIZEN_CORE_YACA_KEY_DOC_H__\r
+#define __TIZEN_CORE_YACA_KEY_DOC_H__\r
+/**\r
+  * @ingroup CAPI_YACA_MODULE\r
+  * @defgroup CAPI_YACA_KEY_MODULE yaca key management module\r
+  * @brief    Provides APIs for key handling operations such as generating and importing a key.\r
+  *\r
+  * @section CAPI_YACA_KEY_MODULE_HEADER Required Header\r
+  * \#include <yaca/yaca_key.h>\r
+  *\r
+  * @section CAPI_YACA_KEY_MODULE_OVERVIEW Overview\r
+  * It provides APIs for 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.\r
+  *\r
+  */\r
+\r
+#endif /* __TIZEN_CORE_YACA_KEY_DOC_H__ */\r

diff --git a/doc/yaca_simple_doc.h b/doc/yaca_simple_doc.h
new file mode 100755 (executable)
index 0000000..a4e6982
--- /dev/null
+++ b/doc/yaca_simple_doc.h
@@ -0,0 +1,31 @@
+/*\r
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved\r
+ *\r
+ * Licensed under the Apache License, Version 2.0 (the License);\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an AS IS BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+#ifndef __TIZEN_CORE_YACA_SIMPLE_DOC_H__\r
+#define __TIZEN_CORE_YACA_SIMPLE_DOC_H__\r
+/**\r
+  * @ingroup CAPI_YACA_MODULE\r
+  * @defgroup CAPI_YACA_SIMPLE_MODULE yaca simple crypto module\r
+  * @brief    Provides simple APIs for cryptographic operations.\r
+  *\r
+  * @section CAPI_YACA_SIMPLE_MODULE_HEADER Required Header\r
+  * \#include <yaca/yaca_simple.h>\r
+  *\r
+  * @section CAPI_YACA_SIMPLE_MODULE_OVERVIEW Overview\r
+  * It provides simple APIs for encryption/decryption, signing/verification, and message digestion.\r
+  *\r
+  */\r
+\r
+#endif /* __TIZEN_CORE_YACA_SIMPLE_DOC_H__ */\r