Include examples in documentation.

Change-Id: Ifeb8ae0e322eae37bc9642dbc166c3ee68c694cc

diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index d034006..af86cf4 100644 (file)
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -839,7 +839,7 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = ../examples/
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -1394,7 +1394,7 @@ GENERATE_TREEVIEW      = YES
 # Minimum value: 0, maximum value: 20, default value: 4.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-ENUM_VALUES_PER_LINE   = 4
+ENUM_VALUES_PER_LINE   = 1
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
 # to set the initial width (in pixels) of the frame in which the tree is shown.

diff --git a/doc/yaca_encryption_doc.h b/doc/yaca_encryption_doc.h
index 7ab66fb..95dcdef 100755 (executable)
--- a/doc/yaca_encryption_doc.h
+++ b/doc/yaca_encryption_doc.h
@@ -30,6 +30,15 @@
   * @section CAPI_YACA_ENCRYPTION_MODULE_OVERVIEW Overview
   * It provides advanced APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys.
   *
+  * @section CAPI_YACA_ENCRYPTION_MODULE_EXAMPLES Examples
+  * Encrypt API example
+  * @snippet examples/encrypt.c Encrypt API example
+  * AES GCM encrypt API example
+  * @snippet examples/encrypt_gcm.c AES GCM encrypt API example
+  * AES CCM encrypt API example
+  * @snippet examples/encrypt_ccm.c AES CCM encrypt API example
+  * Asymmetric Encryption API example
+  * @snippet examples/seal.c Asymmetric Encryption API example
   */
 
 #endif /* __TIZEN_CORE_YACA_ENCRYPTION_DOC_H__ */

diff --git a/doc/yaca_integrity_doc.h b/doc/yaca_integrity_doc.h
index 049043f..c5b61f3 100755 (executable)
--- a/doc/yaca_integrity_doc.h
+++ b/doc/yaca_integrity_doc.h
@@ -27,6 +27,13 @@
   * @section CAPI_YACA_INTEGRITY_MODULE_OVERVIEW Overview
   * It provides advanced APIs for creating a signature using asymmetric private key, verifying 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.
   *
+  * @section CAPI_YACA_INTEGRITY_MODULE_EXAMPLES Examples
+  * Message Digest API example
+  * @snippet examples/digest.c Message Digest API example
+  * Signature API example
+  * @snippet examples/sign.c Signature API example
+  * HMAC Signature API example
+  * @snippet examples/sign_hmac.c HMAC Signature API example
   */
 
 #endif /* __TIZEN_CORE_YACA_INTEGRITY_DOC_H__ */

diff --git a/doc/yaca_key_doc.h b/doc/yaca_key_doc.h
index a28c57c..6bd69d6 100755 (executable)
--- a/doc/yaca_key_doc.h
+++ b/doc/yaca_key_doc.h
@@ -26,6 +26,19 @@
   * @section CAPI_YACA_KEY_MODULE_OVERVIEW Overview
   * 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.
   *
+  * @section CAPI_YACA_KEY_MODULE_EXAMPLES Examples
+  * Key generation API example
+  * @snippet examples/key_gen.c Key generation API example
+  * Symmetric key import/export API example
+  * @snippet examples/key_import_export_sym.c Symmetric key import/export API example
+  * Asymmetric key import/export API example
+  * @snippet examples/key_import_export_asym.c Asymmetric key import/export API example
+  * Key import/export with password API example
+  * @snippet examples/key_password.c Key import/export with password API example
+  * Diffie-Helmann key exchange API example
+  * @snippet examples/key_exchange.c Diffie-Helmann key exchange API example
+  * Key wrapping API example
+  * @snippet examples/key_wrap.c Key wrapping API example
   */
 
 #endif /* __TIZEN_CORE_YACA_KEY_DOC_H__ */

diff --git a/doc/yaca_rsa_doc.h b/doc/yaca_rsa_doc.h
index 4012e68..5645188 100755 (executable)
--- a/doc/yaca_rsa_doc.h
+++ b/doc/yaca_rsa_doc.h
@@ -27,6 +27,11 @@
   * It provides advanced APIs for low-level encryption/decryption operations
   * with asymmetric RSA keys.
   *
+  * @section CAPI_YACA_RSA_MODULE_EXAMPLES Examples
+  * Public RSA Encrypt API example
+  * @snippet examples/rsa_public.c Public RSA Encrypt API example
+  * Private RSA Encrypt API example
+  * @snippet examples/rsa_private.c Private RSA Encrypt API example
   */
 
 #endif /* __TIZEN_CORE_YACA_RSA_DOC_H__ */

diff --git a/doc/yaca_simple_doc.h b/doc/yaca_simple_doc.h
index bc29b5d..ae2fcd1 100755 (executable)
--- a/doc/yaca_simple_doc.h
+++ b/doc/yaca_simple_doc.h
@@ -26,6 +26,15 @@
   * @section CAPI_YACA_SIMPLE_MODULE_OVERVIEW Overview
   * It provides simple APIs for encryption/decryption, signing/verification, and message digestion.
   *
+  * @section CAPI_YACA_SIMPLE_MODULE_EXAMPLES Examples
+  * Simple Encrypt API example
+  * @snippet examples/encrypt_simple.c Simple Encrypt API example
+  * Simple Message Digest API example
+  * @snippet examples/digest_simple.c Simple Message Digest API example
+  * Simple Signature API example
+  * @snippet examples/sign_simple.c Simple Signature API example
+  * Simple CMAC Signature API example
+  * @snippet examples/sign_simple_cmac.c Simple CMAC Signature API example
   */
 
 #endif /* __TIZEN_CORE_YACA_SIMPLE_DOC_H__ */