From: Dariusz Michaluk <d.michaluk@samsung.com>
Date: Mon, 30 May 2016 11:27:44 +0000 (+0200)
Subject: ACR: yaca_digest.h doxygen fixes
X-Git-Tag: accepted/tizen/common/20160810.161523~98
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=03d82d98a4268246cd9a552cffd79aea265fce64;p=platform%2Fcore%2Fsecurity%2Fyaca.git

ACR: yaca_digest.h doxygen fixes

Change-Id: Ia6f8d263b7c31b22fe7d97c4bedd3754b3ae00dc
---

diff --git a/api/yaca/yaca_digest.h b/api/yaca/yaca_digest.h
index c91298a..72d6fe1 100644
--- a/api/yaca/yaca_digest.h
+++ b/api/yaca/yaca_digest.h
@@ -17,7 +17,7 @@
  */
 
 /**
- * @file digest.h
+ * @file yaca_digest.h
  * @brief
  */
 
@@ -44,10 +44,15 @@ extern "C" {
  *
  * @since_tizen 3.0
  *
- * @param[out] ctx   Newly created context (must be freed with yaca_ctx_free()).
- * @param[in]  algo  Digest algorithm that will be used.
+ * @param[out] ctx   Newly created context (must be freed with yaca_ctx_free())
+ * @param[in]  algo  Digest algorithm that will be used
  *
- * @return YACA_ERROR_NONE on success, negative on error.
+ * @return #YACA_ERROR_NONE on success, negative on error
+ * @retval #YACA_ERROR_NONE Succesful
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
+ *                                      incorrect algo)
+ * @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
+ * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see #yaca_digest_algo_e
  * @see yaca_digest_update()
@@ -60,11 +65,15 @@ int yaca_digest_init(yaca_ctx_h *ctx, yaca_digest_algo_e algo);
  *
  * @since_tizen 3.0
  *
- * @param[in,out] ctx       Context created by yaca_digest_init().
- * @param[in]     data      Data from which the digest is to be calculated.
- * @param[in]     data_len  Length of the data.
+ * @param[in,out] ctx       Context created by yaca_digest_init()
+ * @param[in]     data      Data from which the digest is to be calculated
+ * @param[in]     data_len  Length of the data
  *
- * @return YACA_ERROR_NONE on success, negative on error.
+ * @return #YACA_ERROR_NONE on success, negative on error
+ * @retval #YACA_ERROR_NONE Succesful
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL, 0,
+ *                                      incorrect context)
+ * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_digest_init()
  * @see yaca_digest_final()
@@ -76,12 +85,17 @@ int yaca_digest_update(yaca_ctx_h ctx, const char *data, size_t data_len);
  *
  * @since_tizen 3.0
  *
- * @param[in,out] ctx         A valid digest context.
- * @param[out]    digest      Buffer for the message digest (must be allocated by client,
- *                            see yaca_get_digest_length()).
- * @param[out]    digest_len  Length of the digest, actual number of bytes written will be returned here.
- *
- * @return YACA_ERROR_NONE on success, negative on error.
+ * @param[in,out] ctx         A valid digest context
+ * @param[out]    digest      Buffer for the message digest
+ *                            (must be allocated by client, see yaca_get_digest_length())
+ * @param[out]    digest_len  Length of the digest,
+ *                            actual number of bytes written will be returned here
+ *
+ * @return #YACA_ERROR_NONE on success, negative on error
+ * @retval #YACA_ERROR_NONE Succesful
+ * @retval #YACA_ERROR_INVALID_ARGUMENT Required parameters have bogus values (NULL,
+ *                                      incorrect context)
+ * @retval #YACA_ERROR_INTERNAL Internal error
  *
  * @see yaca_digest_init()
  * @see yaca_digest_update()