Update API description

Change-Id: Id3e3943cdb8b0b827cbdb369d54113962717b5c5

diff --git a/include/image_util.h b/include/image_util.h
index c55ba7b..5d6409c 100644 (file)
--- a/include/image_util.h
+++ b/include/image_util.h
@@ -95,7 +95,7 @@ int image_util_extract_color_from_memory(const unsigned char *image_buffer, int
 *
 * @remarks The @a handle should be released using image_util_transform_destroy().
 *
-* @param[out] handle The handle of image util transform
+* @param[out] handle The handle for transforming an image
 *
 * @return @c 0 on success,
 *               otherwise a negative error value
@@ -118,7 +118,7 @@ int image_util_transform_create(transformation_h *handle);
 *
 * @remarks The value returned will be #IMAGE_UTIL_ERROR_NOT_SUPPORTED, if H/W acceleration doesn't support on the device.
 *
-* @param[in] handle The handle of image util
+* @param[in] handle The handle for transforming an image
 * @param[in] mode Set @c true, user can use the hardware acceleration\n
 *                               otherwise set @c false if user can only software image processing
 *
@@ -141,7 +141,7 @@ int image_util_transform_set_hardware_acceleration(transformation_h handle, bool
 * @brief Sets the information of the converting.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in] colorspace The colorspace of the image buffer
 *
 * @return @c 0 on success,
@@ -166,7 +166,7 @@ int image_util_transform_set_colorspace(transformation_h handle, image_util_colo
 *
 * @remarks image_util_transform_set_resolution() and image_util_transform_set_crop_area() can't do that at the same time.
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in] width The width of image buffer
 * @param[in] height The height of image buffer
 *
@@ -189,7 +189,7 @@ int image_util_transform_set_resolution(transformation_h handle, unsigned int wi
 * @brief Sets the information of the rotating.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in] rotation The rotation value of image buffer
 *
 * @return @c 0 on success,
@@ -213,7 +213,7 @@ int image_util_transform_set_rotation(transformation_h handle, image_util_rotati
 *
 * @remarks image_util_transform_set_resolution() and image_util_transform_set_crop_area() can't do that at the same time.
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in] start_x The start x position of cropped image buffer
 * @param[in] start_y The start y position of cropped image buffer
 * @param[in] end_x The end x position of cropped image buffer
@@ -238,7 +238,7 @@ int image_util_transform_set_crop_area(transformation_h handle, unsigned int sta
 * @brief Gets the colorspace of the image buffer.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in,out] colorspace The colorspace of the image buffer
 *
 * @return @c 0 on success,
@@ -261,7 +261,7 @@ int image_util_transform_get_colorspace(transformation_h handle, image_util_colo
 * @brief Gets the resolution of the image buffer.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in,out] width The width of source image buffer
 * @param[in,out] height The height of source image buffer
 *
@@ -284,7 +284,7 @@ int image_util_transform_get_resolution(transformation_h handle, unsigned int *w
 * @brief Gets the information of the rotating.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in,out] rotation The rotation value of image buffer
 *
 * @return @c 0 on success,
@@ -306,7 +306,7 @@ int image_util_transform_get_rotation(transformation_h handle, image_util_rotati
 * @brief Gets the information of the cropping.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 * @param[in,out] start_x The start x position of cropped source image buffer
 * @param[in,out] start_y The start y position of cropped source image buffer
 * @param[in,out] end_x The end x position of cropped source image buffer
@@ -335,8 +335,8 @@ int image_util_transform_get_crop_area(transformation_h handle, unsigned int *st
 *
 * @remarks If H/W acceleration is not set, transformation is done via S/W acceleration.
 *
-* @param[in] handle The handle of transform
-* @param[in] src The handle of image util transform
+* @param[in] handle The handle for transforming an image
+* @param[in] src The handle of source
 * @param[in] callback The callback function to be invoked
 * @param[in] user_data The user data to be passed to the callback function
 *
@@ -353,15 +353,16 @@ int image_util_transform_get_crop_area(transformation_h handle, unsigned int *st
 int image_util_transform_run(transformation_h handle, media_packet_h src, image_util_transform_completed_cb callback, void *user_data);
 
 /**
-* @brief Transforms an image with given transformation handle.
-* @details This function transforms @a src image synchronously.\n
+* @brief Synchronously transforms an image with the given transformation handle.
+* @details This function transforms an image synchronously using the @a src image handle, which has image information such as size, resolution.\n
+*            A transformed image is stored into the @a dst image handle.\n
 * @since_tizen 5.5
 *
 * @remarks If transforming is failed, the @a dst will be null.
 *               The @a dst should be released using image_util_destroy_image().
 *
-* @param[in] handle The handle of transform
-* @param[in] src A handle of src image
+* @param[in] handle The handle for transforming an image
+* @param[in] src The handle of the image
 * @param[out] dst The transformed image
 *
 * @return @c 0 on success,
@@ -385,13 +386,14 @@ int image_util_transform_run(transformation_h handle, media_packet_h src, image_
 int image_util_transform_run2(transformation_h handle, image_util_image_h src, image_util_image_h *dst);
 
 /**
-* @brief Transforms an image with given transformation handle.
-* @details This function transforms @a src image asynchronously, @a callback will be called after completing transform. \n
+* @brief Synchronously transforms an image with the given transformation handle.
+* @details This function transforms an image asynchronously using the @a src image handle, which has image information such as size, resolution.\n
+*            @a callback will be called after completing transform. \n
 * @since_tizen 5.5
 *
 * @remarks If transforming is failed, the dst of callback parameter will be null.
 *
-* @param[in] handle The handle of transform
+* @param[in] handle The handle for transforming an image
 * @param[in] src The image handle to transform
 * @param[in] callback The callback function to be invoked
 * @param[in] user_data The user data to be passed to the callback function
@@ -424,7 +426,7 @@ int image_util_transform_run2_async(transformation_h handle, image_util_image_h
 *               has to be created before the next usage.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 *
-* @param[in] handle The handle of image util transform
+* @param[in] handle The handle for transforming an image
 *
 * @return @c 0 on success,
 *               otherwise a negative error value
@@ -438,7 +440,7 @@ int image_util_transform_run2_async(transformation_h handle, image_util_image_h
 int image_util_transform_destroy(transformation_h handle);
 
 /**
-* @brief Creates a image handle.
+* @brief Creates an image handle.
 * @since_tizen 5.5
 *
 * @remarks The @a image should be released using image_util_destroy_image().
@@ -464,13 +466,13 @@ int image_util_transform_destroy(transformation_h handle);
 int image_util_create_image(unsigned int width, unsigned int height, image_util_colorspace_e colorspace, const unsigned char *data, size_t data_size, image_util_image_h *image);
 
 /**
-* @brief Clones a image handle.
+* @brief Clones an image handle.
 * @since_tizen 5.5
 *
 * @remarks The @a dst should be released using image_util_destroy_image().
 *
-* @param[in] src               The handle of image
-* @param[out] dst              A handle of cloned image
+* @param[in] src               The handle of the image
+* @param[out] dst              A handle of the cloned image
 *
 * @return @c 0 on success,
 *               otherwise a negative error value
@@ -490,7 +492,7 @@ int image_util_clone_image(image_util_image_h src, image_util_image_h *dst);
 *
 * @remarks The @a data should be released using free() if that's not NULL. And if you don't want to get specific information, you can set parameters to NULL.
 *
-* @param[in] image             A handle to image
+* @param[in] image             The handle of the image
 * @param[out] width            The width of image
 * @param[out] height           The height of image
 * @param[out] colorspace       The colorspace of image
@@ -509,12 +511,12 @@ int image_util_clone_image(image_util_image_h src, image_util_image_h *dst);
 int image_util_get_image(image_util_image_h image, unsigned int *width, unsigned int *height, image_util_colorspace_e *colorspace, unsigned char **data, size_t *data_size);
 
 /**
-* @brief Destroys a image handle.
+* @brief Destroys an image handle.
 * @details The function frees all resources related to the @ image. The image handle no longer can be used to perform any operations.
 *               A new image handle has to be created before the next usage.
 * @since_tizen 5.5
 *
-* @param[in] image A handle to image
+* @param[in] image The handle of the image
 *
 * @return @c 0 on success,
 *               otherwise a negative error value

diff --git a/include/image_util_type.h b/include/image_util_type.h
index 241b429..806c46e 100644 (file)
--- a/include/image_util_type.h
+++ b/include/image_util_type.h
@@ -135,7 +135,7 @@ typedef void(*image_util_transform_completed_cb)(media_packet_h *dst, int error_
 
 /**
 * @ingroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE
-* @brief Called when transforming image is completed.
+* @brief Called when transforming an image is completed.
 *
 * @since_tizen 5.5
 *