Update digest API description 13/75813/2
authorKrzysztof Jackiewicz <k.jackiewicz@samsung.com>
Tue, 21 Jun 2016 13:14:13 +0000 (15:14 +0200)
committerDariusz Michaluk <d.michaluk@samsung.com>
Thu, 23 Jun 2016 09:52:37 +0000 (02:52 -0700)
-Add empty message digest remark
-Add context reuse remark

Change-Id: I255dc403f3f82d4359e56e632607b4d93e811b2f

api/yaca/yaca_digest.h

index 6a66a6f..f45f25b 100644 (file)
@@ -87,6 +87,13 @@ int yaca_digest_update(yaca_context_h ctx, const char *data, size_t data_len);
  *
  * @since_tizen 3.0
  *
+ * @remarks  After returning from this function the context is ready to be reused for another
+ *           message digest calculation. There's no need to initialize it again with
+ *           yaca_digest_initialize().
+ *
+ * @remarks  Skipping yaca_digest_update() and calling only yaca_digest_finalize() will produce an
+ *           empty message digest.
+ *
  * @param[in,out] ctx         A valid digest context
  * @param[out]    digest      Buffer for the message digest
  *                            (must be allocated by client, see yaca_context_get_output_length())