From: Minje Ahn Date: Fri, 26 May 2017 02:32:02 +0000 (+0900) Subject: Update description X-Git-Tag: submit/tizen/20170526.075705^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F24%2F131224%2F2;p=platform%2Fcore%2Fapi%2Fthumbnail-util.git Update description Change-Id: Ie4b105e7b6ca1c235a3ec9c79e44172e7a6891c0 Signed-off-by: Minje Ahn --- diff --git a/include/thumbnail_util.h b/include/thumbnail_util.h index 0482905..04789ad 100755 --- a/include/thumbnail_util.h +++ b/include/thumbnail_util.h @@ -40,14 +40,15 @@ extern "C" { * @remarks You must release @a thumb info using thumbnail_util_destroy(). * * @param[in] thumb The handle to thumbnail info - * @return @c 0 on success, - * otherwise a negative error value + * + * @return @c 0 on success, otherwise a negative error value + * * @retval #THUMBNAIL_UTIL_ERROR_NONE Successful * @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 * - * @post Created handle should be released using thumbnail_util_destroy() API. + * @see thumbnail_util_destroy() */ int thumbnail_util_create(thumbnail_h *thumb); @@ -72,8 +73,7 @@ int thumbnail_util_create(thumbnail_h *thumb); * @param[in] user_data The user data to be passed to the callback function * @param[out] request_id The request id for the thumbnail extraction request * - * @return @c 0 on success, - * otherwise a negative error value + * @return @c 0 on success, otherwise a negative error value * * @retval #THUMBNAIL_UTIL_ERROR_NONE Successful * @retval #THUMBNAIL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -81,8 +81,14 @@ int thumbnail_util_create(thumbnail_h *thumb); * * @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(). - * - * @post Thumbnail extraction result except canceled is provided by thumbnail_extracted_cb. + * @see thumbnail_util_create() + * @see thumbnail_util_set_path() + * @see thumbnail_util_set_size() + * @see thumbnail_extracted_cb() + * @see thumbnail_util_cancel() + * @see thumbnail_util_cancel_all() + * @see thumbnail_util_destroy() + * @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); @@ -93,16 +99,16 @@ int thumbnail_util_extract(thumbnail_h thumb, thumbnail_extracted_cb callback, v * @param[in] thumb The thumbnail info handle * @param[in] path The path of the original media file * - * @return @c 0 on success, - * otherwise a negative error value + * @return @c 0 on success, otherwise a negative error value * * @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(). + * @see thumbnail_util_create() + * @see thumbnail_util_set_size() + * @see thumbnail_util_destroy() */ int thumbnail_util_set_path(thumbnail_h thumb, const char *path); @@ -116,16 +122,17 @@ int thumbnail_util_set_path(thumbnail_h thumb, const char *path); * @param[in] width The width of the thumbnail * @param[in] height The height of the thumbnail * - * @return @c 0 on success, - * otherwise a negative error value + * @return @c 0 on success, otherwise a negative error value * * @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 thumbnail_util_create() + * @see thumbnail_util_set_path() + * @see thumbnail_util_destroy() * - * @post Extract the thumbnail by calling thumbnail_util_extract(). */ int thumbnail_util_set_size(thumbnail_h thumb, int width, int height); @@ -137,14 +144,14 @@ int thumbnail_util_set_size(thumbnail_h thumb, int width, int height); * @param[in] thumb The media thumbnail info handle * @param[in] request_id The generated request id by thumbnail extraction request * - * @return @c 0 on success, - * otherwise a negative error value + * @return @c 0 on success, otherwise a negative error value * * @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(). + * @pre It is available before thumbnail_extracted_cb() is called. + * @see thumbnail_util_extract() */ int thumbnail_util_cancel(thumbnail_h thumb, const char *request_id); @@ -155,14 +162,14 @@ int thumbnail_util_cancel(thumbnail_h thumb, const char *request_id); * * @param[in] thumb The media thumbnail info handle * - * @return @c 0 on success, - * otherwise a negative error value + * @return @c 0 on success, otherwise a negative error value * * @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(). + * @pre It is available before thumbnail_extracted_cb() is called. + * @see thumbnail_util_extract() */ int thumbnail_util_cancel_all(thumbnail_h thumb); @@ -176,14 +183,14 @@ int thumbnail_util_cancel_all(thumbnail_h thumb); * * @param[in] thumb The thumbnail info handle * - * @return @c 0 on success, - * otherwise a negative error value + * @return @c 0 on success, otherwise a negative error value * * @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 thumbnail_util_create() */ int thumbnail_util_destroy(thumbnail_h thumb); diff --git a/include/thumbnail_util_type.h b/include/thumbnail_util_type.h index d7734b2..c60f8f5 100755 --- a/include/thumbnail_util_type.h +++ b/include/thumbnail_util_type.h @@ -25,12 +25,6 @@ extern "C" { #endif /* __cplusplus */ -/** - * @file thumbnail_util_type.h - * @brief This file contains API related to thumbnail_util enumerations for classes of errors. \n - * Listed APIs are called when extracting thumbnail from media files, \n - */ - /** * @addtogroup CAPI_MEDIA_THUMBNAIL_UTIL_MODULE * @{ @@ -65,19 +59,14 @@ typedef struct thumbnail_s *thumbnail_h; /** * @ingroup CAPI_MEDIA_THUMBNAIL_UTIL_MODULE * @brief Called when creating the thumbnail. + * @details This callback is called for completion of generating the thumbnail. + * * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * * @remarks Color space of the generated thumbnail is BGRA. \n * The callback is called in a separate thread(not in the main loop). \n * You must release @a thumb_data using free(). * - * @details This callback is called for completion of generating the thumbnail. - * The following error codes can be delivered. \n - * #MEDIA_CONTENT_ERROR_NONE, \n - * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER, \n - * #MEDIA_CONTENT_ERROR_INVALID_OPERATION, \n - * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED, \n - * #MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT - * * @param[in] error The error code * @param[in] request_id The generated request id by thumbnail extraction request * @param[in] thumb_width The width of the thumbnail which is generated @@ -86,8 +75,7 @@ typedef struct thumbnail_s *thumbnail_h; * @param[in] thumb_size The size of the thumbnail which is generated * @param[in] user_data The user data passed from the thumbnail_util_extract() function * - * @pre thumbnail_util_extract() - * + * @pre thumbnail_util_extract() calls this callback. * @see thumbnail_util_extract() */ typedef void (*thumbnail_extracted_cb)(thumbnail_util_error_e error, const char *request_id, int thumb_width, int thumb_height, unsigned char *thumb_data, int thumb_size, void *user_data);