From: Minje Ahn <minje.ahn@samsung.com>
Date: Wed, 11 Nov 2015 05:39:35 +0000 (+0900)
Subject: Update description
X-Git-Tag: submit/tizen/20151112.073116^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F97%2F51597%2F4;p=platform%2Fcore%2Fapi%2Fthumbnail-util.git

Update description

Change-Id: Ie427b51d41f922fdd347188a48afdef0f8814c1c
Signed-off-by: Minje Ahn <minje.ahn@samsung.com>
---

diff --git a/include/thumbnail_util.h b/include/thumbnail_util.h
index 7b1f0b7..bc85844 100755
--- a/include/thumbnail_util.h
+++ b/include/thumbnail_util.h
@@ -46,7 +46,8 @@ extern "C" {
  * @retval #THUMBNAIL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #THUMBNAIL_UTIL_ERROR_OUT_OF_MEMORY Not enough memory is available
  * @retval #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED Permission denied
- * @see thumbnail_util_destroy()
+ *
+ * @post Created handle should be released using thumbnail_util_destroy() API.
  */
 int thumbnail_util_create(thumbnail_h *thumb);
 
@@ -79,9 +80,10 @@ int thumbnail_util_create(thumbnail_h *thumb);
  * @retval #THUMBNAIL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED Permission denied
  *
- * @pre Create a thumbnail info handle by calling thumbnail_util_create().
+ * @pre Create a thumbnail info handle by calling thumbnail_util_create(). \n
+ *           The content path that you want to generate thumbnail must be set by calling thumbnail_util_set_path().
  *
- * @see thumbnail_util_create()
+ * @post Thumbnail extraction result except canceled is provided by thumbnail_extracted_cb.
  */
 int thumbnail_util_extract(thumbnail_h thumb, thumbnail_extracted_cb callback, void *user_data, char **request_id);
 
@@ -98,6 +100,10 @@ int thumbnail_util_extract(thumbnail_h thumb, thumbnail_extracted_cb callback, v
  * @retval #THUMBNAIL_UTIL_ERROR_NONE              Successful
  * @retval #THUMBNAIL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @pre Create a thumbnail info handle by calling thumbnail_util_create().
+ * @see Set the thumbnail size you want by calling thumbnail_util_size().
+ * @post Extract the thumbnail by calling thumbnail_util_extract().
  */
 int thumbnail_util_set_path(thumbnail_h thumb, const char *path);
 
@@ -119,7 +125,8 @@ int thumbnail_util_set_path(thumbnail_h thumb, const char *path);
  * @retval #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre Create a thumbnail info handle by calling thumbnail_util_create().
- * @see thumbnail_util_extract()
+ *
+ * @post Extract the thumbnail by calling thumbnail_util_extract().
  */
 int thumbnail_util_set_size(thumbnail_h thumb, int width, int height);
 
@@ -139,7 +146,6 @@ int thumbnail_util_set_size(thumbnail_h thumb, int width, int height);
  * @retval #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre Create a thumbnail info handle by calling thumbnail_util_create().
- * @post thumbnail_util_extract()
  */
 int thumbnail_util_cancel(thumbnail_h thumb, const char *request_id);
 
@@ -158,7 +164,6 @@ int thumbnail_util_cancel(thumbnail_h thumb, const char *request_id);
  * @retval #THUMBNAIL_UTIL_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre Create a thumbnail info handle by calling thumbnail_util_create().
- * @post thumbnail_util_extract()
  */
 int thumbnail_util_cancel_all(thumbnail_h thumb);