Specify property type for tag lengths 14/77914/12
authorKrzysztof Jackiewicz <k.jackiewicz@samsung.com>
Tue, 5 Jul 2016 07:24:23 +0000 (09:24 +0200)
committerKrzysztof Jackiewicz <k.jackiewicz@samsung.com>
Fri, 8 Jul 2016 13:47:17 +0000 (06:47 -0700)
Change-Id: I3fa756c74bd0797d070913020fd0f38588fe7403

api/yaca/yaca_types.h

index 655879e..c1a6430 100644 (file)
@@ -303,7 +303,7 @@ typedef enum {
         *   (recommended 128 bits tag).\n
         *   Set after yaca_encrypt_finalize() / yaca_seal_finalize() and before
         *   yaca_context_get_property(#YACA_PROPERTY_GCM_TAG)
-        *   in encryption / seal operation.\n\n
+        *   in encryption / seal operation. The @a value should be a size_t variable.\n\n
         *
         * - #YACA_PROPERTY_GCM_TAG = GCM tag\n
         *   Get after yaca_encrypt_finalize() / yaca_seal_finalize() in encryption / seal operation.\n
@@ -315,6 +315,7 @@ typedef enum {
         *   Set after yaca_decrypt_initialize() / yaca_open_initialize() and before
         *   yaca_decrypt_update() / yaca_open_update() in decryption / open operation.\n\n
         *
+        *   @see yaca_context_set_property()
         *   @see examples/encrypt_aes_gcm_ccm.c
         *   @see examples/seal.c
         */
@@ -353,7 +354,8 @@ typedef enum {
         * - #YACA_PROPERTY_CCM_TAG_LEN = CCM tag length\n
         *   Supported tag lengths: 32-128 bits in step of 16 bits (recommended 96 bits tag).\n
         *   Set after yaca_encrypt_initialize() / yaca_seal_initialize() and before
-        *   yaca_encrypt_update() / yaca_seal_update() in encryption / seal operation.\n\n
+        *   yaca_encrypt_update() / yaca_seal_update() in encryption / seal operation.
+        *   The @a value should be a size_t variable. \n\n
         *
         * - #YACA_PROPERTY_CCM_TAG = CCM tag\n
         *   Get after yaca_encrypt_finalize() / yaca_seal_finalize() in encryption / seal operation.\n