Just update API descriptions

Change-Id: I5a15d0cfd35ce5dc43a6b4631153da26480d4d42

diff --git a/include/image_util.h b/include/image_util.h
index 5292a1f..4f023d2 100755 (executable)
--- a/include/image_util.h
+++ b/include/image_util.h
@@ -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 to image util
+* @param[in] handle The handle of image util
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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 to image util transform
+* @param[in] handle The handle of image util transform
 * @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
@@ -336,7 +336,7 @@ 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 to image util transform
+* @param[in] src The handle of image util transform
 * @param[in] callback The callback function to be invoked
 * @param[in] user_data The user data to be passed to the callback function
 *
@@ -359,7 +359,7 @@ int image_util_transform_run(transformation_h handle, media_packet_h src, image_
 *               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 to image util transform
+* @param[in] handle The handle of image util transform
 *
 * @return @c 0 on success,
 *               otherwise a negative error value

diff --git a/include/image_util_decode.h b/include/image_util_decode.h
index 5d89fc7..febad0e 100755 (executable)
--- a/include/image_util_decode.h
+++ b/include/image_util_decode.h
@@ -60,7 +60,7 @@ int image_util_decode_create(image_util_decode_h *handle);
 *             http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\n
 *             Finds out image type by reading the header of the image provided in input path.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] path The path to input image
 *
 * @return @c 0 on success,
@@ -95,7 +95,7 @@ int image_util_decode_set_input_path(image_util_decode_h handle, const char *pat
 *              If both are set then the latest input set, is considered.\n
 *              Finds out image type by reading the header of the image provided in input buffer.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] src_buffer The input image buffer
 * @param[in] src_size The input image buffer size
 *
@@ -130,7 +130,7 @@ int image_util_decode_set_input_buffer(image_util_decode_h handle, const unsigne
 *             Use image_util_decode_set_colorspace to change the colorspace.
 *             @a dst_buffer should be released after @c image_util_decode_run() or @c image_util_decode_run_async().
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] dst_buffer The decoded output buffer
 *
 * @return @c 0 on success,
@@ -162,7 +162,7 @@ int image_util_decode_set_output_buffer(image_util_decode_h handle, unsigned cha
 *             Use image_util_foreach_supported_colorspace to get supported colorspaces for each image format.\n
 *             Errors would be returned if not supported.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] colorspace The decoded image colorspace
 *
 * @return @c 0 on success,
@@ -196,7 +196,7 @@ int image_util_decode_set_colorspace(image_util_decode_h handle, image_util_colo
 *
 * @remarks This is API is supported only for JPEG decoding.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] down_scale The downscale at which image is to be decoded
 *
 * @return @c 0 on success,
@@ -230,7 +230,7 @@ int image_util_decode_set_jpeg_downscale(image_util_decode_h handle, image_util_
 *          The function executes synchronously.\n
 *          When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[out] width Width of the decoded image
 * @param[out] height Height of the decoded image
 * @param[out] size Size of the decoded image
@@ -264,7 +264,7 @@ int image_util_decode_run(image_util_decode_h handle, unsigned long *width, unsi
 *          The function executes asynchronously, which contains complete callback.\n
 *          When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] callback The callback function to be invoked
 * @param[in] user_data The user data to be passed to the callback function
 *
@@ -295,7 +295,7 @@ int image_util_decode_run_async(image_util_decode_h handle, image_util_decode_co
 *
 * @remarks Any image handle created should be destroyed.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 *
 * @return @c 0 on success,
 *                 otherwise a negative error value

diff --git a/include/image_util_encode.h b/include/image_util_encode.h
index 18317df..e088169 100755 (executable)
--- a/include/image_util_encode.h
+++ b/include/image_util_encode.h
@@ -58,7 +58,7 @@ int image_util_encode_create(image_util_type_e image_type, image_util_encode_h *
 * @remarks This should be called before calling image_util_encode_run().\n
 *               While encoding animated gif image, resolution should be set for each frame.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] width Width of the original image
 * @param[in] height Height of the original image
 *
@@ -92,7 +92,7 @@ int image_util_encode_set_resolution(image_util_encode_h handle, unsigned long w
 *             Use image_util_foreach_supported_colorspace to get supported colorspaces for each image format.\n
 *             Errors would be returned if not supported.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] colorspace The colorspace of the input image to encode
 *
 * @return @c 0 on success,
@@ -127,7 +127,7 @@ int image_util_encode_set_colorspace(image_util_encode_h handle, image_util_colo
 * @remarks If application does not set this, then by default quality of 75 is set.\n
 *              Quality is supported for JPEG format. IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT will be returned for other formats.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] quality Encoding quality from 1~100
 *
 * @return @c 0 on success,
@@ -159,7 +159,7 @@ int image_util_encode_set_quality(image_util_encode_h handle, int quality);
 *
 * @remarks If application does not set this, then default compression of 6 is set.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] compression The compression value valid from 0~9
 *
 * @return @c 0 on success,
@@ -194,7 +194,7 @@ int image_util_encode_set_png_compression(image_util_encode_h handle, image_util
 *             This should be set for each frame in the animated gif image.\n
 *             This can be set a different value for each frame, which results in different delay time between different frames.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] delay_time Time delay between each frame in the encoded image, in 0.01sec units.
 *
 * @return @c 0 on success,
@@ -229,7 +229,7 @@ int image_util_encode_set_gif_frame_delay_time(image_util_encode_h handle, unsig
 *             Use image_util_encode_set_colorspace to change the colorspace.\n
 *             While encoding animated gif image, input buffer should be set for each frame.
 *
-* @param[in] handle The handle to image util decoding
+* @param[in] handle The handle of image util decoding
 * @param[in] src_buffer The input image buffer
 *
 * @return @c 0 on success,
@@ -264,17 +264,17 @@ int image_util_encode_set_input_buffer(image_util_encode_h handle, const unsigne
 *             http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n
 *             http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] path The output file path
 *
 * @return @c 0 on success,
 *                 otherwise a negative error value
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
-* @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file
+* @retval #IMAGE_UTIL_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation
-* @retval #IMAGE_UTIL_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
+* @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file
 *
 * @pre image_util_encode_create()
 *
@@ -301,7 +301,7 @@ int image_util_encode_set_output_path(image_util_encode_h handle, const char *pa
 *           In case of gif encoding, the output buffer will be completely available only after image_util_encode_destroy().
 *           @a dst_buffer should be released after @c image_util_encode_run() or @c image_util_encode_run_async().
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] dst_buffer The output image buffer
 *
 * @return @c 0 on success,
@@ -337,7 +337,7 @@ int image_util_encode_set_output_buffer(image_util_encode_h handle, unsigned cha
 *          image_util_encode_set_gif_frame_delay_time() MUST be called for each frame.
 *          In case of animated gif encoding, call image_util_encode_run() for each frame to encode progressively.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[out] size Size of the encoded image
 *
 * @return @c 0 on success,
@@ -375,7 +375,7 @@ int image_util_encode_run(image_util_encode_h handle, unsigned long long *size);
 *          image_util_encode_set_gif_frame_delay_time() MUST be called for each frame.
 *          In case of animated gif encoding, call image_util_encode_run_async() for each frame to encode progressively.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 * @param[in] callback The callback function to be invoked
 * @param[in] user_data The user data to be passed to the callback function
 *
@@ -409,7 +409,7 @@ int image_util_encode_run_async(image_util_encode_h handle, image_util_encode_co
 *
 * @remarks Any image handle created should be destroyed.
 *
-* @param[in] handle The handle to image util encoding
+* @param[in] handle The handle of image util encoding
 *
 * @return @c 0 on success,
 *                 otherwise a negative error value