[ACR-1393] Modify description

Change-Id: I116d42ea1f49e3d53a5049b38f68cff67e22c57c

diff --git a/include/image_util_decode.h b/include/image_util_decode.h
index 3fa32e5..7cd24ee 100644 (file)
--- a/include/image_util_decode.h
+++ b/include/image_util_decode.h
@@ -72,7 +72,7 @@ int image_util_decode_create(image_util_decode_h *handle);
 * @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_OUT_OF_MEMORY Out of memory
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_decode_create()
 *
@@ -105,7 +105,7 @@ int image_util_decode_set_input_path(image_util_decode_h handle, const char *pat
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation
 * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_decode_create()
 *
@@ -169,7 +169,7 @@ int image_util_decode_set_output_buffer(image_util_decode_h handle, unsigned cha
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_decode_create()
 * @pre image_util_decode_set_input_path() / image_util_decode_set_input_buffer()
@@ -202,7 +202,7 @@ int image_util_decode_set_colorspace(image_util_decode_h handle, image_util_colo
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_decode_create()
 * @pre image_util_decode_set_input_path() / image_util_decode_set_input_buffer()
@@ -307,7 +307,7 @@ int image_util_decode_run_async(image_util_decode_h handle, image_util_decode_co
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation
 * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_decode_create()
 * @pre image_util_decode_set_input_buffer() / image_util_decode_set_input_path().
@@ -341,7 +341,7 @@ int image_util_decode_run2(image_util_decode_h handle, image_util_image_h *image
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation
 * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_decode_create()
 * @pre image_util_decode_set_input_buffer() / image_util_decode_set_input_path().

diff --git a/include/image_util_encode.h b/include/image_util_encode.h
index 53fdf1f..05b9c21 100644 (file)
--- a/include/image_util_encode.h
+++ b/include/image_util_encode.h
@@ -111,7 +111,7 @@ int image_util_encode_set_resolution(image_util_encode_h handle, unsigned long w
 *                 otherwise a negative error value
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 *
 * @pre image_util_encode_create()
@@ -146,7 +146,7 @@ int image_util_encode_set_colorspace(image_util_encode_h handle, image_util_colo
 *                 otherwise a negative error value
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 *
 * @pre image_util_encode_create()
@@ -176,7 +176,7 @@ int image_util_encode_set_quality(image_util_encode_h handle, int quality);
 *                 otherwise a negative error value
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation
 *
@@ -210,7 +210,7 @@ int image_util_encode_set_png_compression(image_util_encode_h handle, image_util
 *                 otherwise a negative error value
 *
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 *
 * @pre image_util_encode_create()
@@ -322,7 +322,7 @@ int image_util_encode_set_output_path(image_util_encode_h handle, const char *pa
 * @retval #IMAGE_UTIL_ERROR_NONE Successful
 * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation
-* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported
+* @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format
 *
 * @pre image_util_encode_create()
 *
@@ -418,15 +418,15 @@ int image_util_encode_run(image_util_encode_h handle, unsigned long long *size)
 int image_util_encode_run_async(image_util_encode_h handle, image_util_encode_completed_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
-* @brief Encodes the image to a file with the given encode handle.
+* @brief Encodes the image and save it to a file in the given encoding handle.
 * @details The function executes synchronously.
 * @since_tizen 5.5
 *
-* @remarks If any of the functions at the pre-condition are not called, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
+* @remarks If any functions at the pre-condition are not called first, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
 *          The only supported colorspace for BMP, GIf and PNG is #IMAGE_UTIL_COLORSPACE_RGBA8888.\n
-*          Use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG format.\n
-*          http://tizen.org/privilege/mediastorage is needed if @a file_path points to media storage.\n
-*          http://tizen.org/privilege/externalstorage is needed if @a file_path points to external storage.
+*          To get supported colorspaces for JPEG format, you can use image_util_foreach_supported_colorspace().\n
+*          http://tizen.org/privilege/mediastorage is required if @a file_path value is media storage.\n
+*          http://tizen.org/privilege/externalstorage is required if @a file_path value is external storage.
 *
 * @param[in] handle The handle of image util encoding
 * @param[in] image The image handle for encoding
@@ -452,14 +452,14 @@ int image_util_encode_run_async(image_util_encode_h handle, image_util_encode_co
 int image_util_encode_run_to_file(image_util_encode_h handle, image_util_image_h image, const char *file_path);
 
 /**
-* @brief Encodes the image to a buffer with the given encode handle.
+* @brief Encodes the image to save it to a buffer in the given encoding handle.
 * @details The function executes synchronously.
 * @since_tizen 5.5
 *
-* @remarks If any of the functions at the pre-condition are not called, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
+* @remarks If any functions at the pre-condition are not called first, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
 *          The @a buffer should be released using free().\n
 *          The only supported colorspace for BMP, GIf and PNG is #IMAGE_UTIL_COLORSPACE_RGBA8888.\n
-*          Use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG format.
+*          To get supported colorspaces for JPEG format, you can use image_util_foreach_supported_colorspace().
 *
 * @param[in] handle The handle of image util encoding
 * @param[in] image The image handle for encoding
@@ -485,15 +485,15 @@ int image_util_encode_run_to_file(image_util_encode_h handle, image_util_image_h
 int image_util_encode_run_to_buffer(image_util_encode_h handle, image_util_image_h image, unsigned char **buffer, size_t *buffer_size);
 
 /**
-* @brief Encodes the image to a file with the given encode handle asynchronously.
+* @brief Encodes the image and save it to a file in the given encoding handle asynchronously.
 * @details The output will be stored in @a file_path. And the function executes asynchronously.
 * @since_tizen 5.5
 *
-* @remarks If any of the functions at the pre-condition are not called, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
+* @remarks If any functions at the pre-condition are not called first, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
 *          The only supported colorspace for BMP, GIf and PNG is #IMAGE_UTIL_COLORSPACE_RGBA8888.\n
-*          Use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG format.\n
-*          http://tizen.org/privilege/mediastorage is needed if @a file_path points to media storage.\n
-*          http://tizen.org/privilege/externalstorage is needed if @a file_path points to external storage.
+*          To get supported colorspaces for JPEG format, you can use image_util_foreach_supported_colorspace().\n
+*          http://tizen.org/privilege/mediastorage is required if @a file_path value is media storage.\n
+*          http://tizen.org/privilege/externalstorage is required if @a file_path value is external storage.
 *
 * @param[in] handle The handle of image util encoding
 * @param[in] image The image handle for encoding
@@ -520,13 +520,13 @@ int image_util_encode_run_to_buffer(image_util_encode_h handle, image_util_image
 int image_util_encode_run_async_to_file(image_util_encode_h handle, image_util_image_h image, const char *file_path, image_util_encode_to_file_completed_cb completed_cb, void *user_data);
 
 /**
-* @brief Encodes the image to a buffer with the given encode handle asynchronously.
+* @brief Encodes the image and save it to a buffer in the given encoding handle asynchronously.
 * @details The output will be stored in a buffer provided by the @a completed_cb callback.
 * @since_tizen 5.5
 *
-* @remarks If any of the @pre function is not called, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
+* @remarks If any functions at the pre-condition are not called first, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n
 *          The only supported colorspace for BMP, GIf and PNG is #IMAGE_UTIL_COLORSPACE_RGBA8888.\n
-*          Use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG format.
+*          To get supported colorspaces for JPEG format, you can use image_util_foreach_supported_colorspace().
 *
 * @param[in] handle The handle of image util encoding
 * @param[in] image The image handle for encoding
@@ -572,12 +572,12 @@ int image_util_encode_run_async_to_buffer(image_util_encode_h handle, image_util
 int image_util_encode_destroy(image_util_encode_h handle);
 
 /**
-* @brief Creates a handle of animated GIF encoding.
+* @brief Creates a handle for encoding an animated GIF.
 * @since_tizen 5.5
 *
 * @remarks The @a handle should be released using image_util_agif_encode_destroy().
 *
-* @param[out] handle The handle of animated GIF encoding
+* @param[out] handle The handle of encoding an animated GIF
 *
 * @return @c 0 on success,
 *                 otherwise a negative error value
@@ -601,14 +601,14 @@ int image_util_agif_encode_create(image_util_agif_encode_h *handle);
 * @since_tizen 5.5
 *
 * @remarks This function should be called for each @a image which you want to add to the animated GIF. Eeach @a image should be the same size.\n
-*          The Supported colorspace is #IMAGE_UTIL_COLORSPACE_RGBA8888.\n
+*          The supported colorspace is #IMAGE_UTIL_COLORSPACE_RGBA8888.\n
 *          You should call image_util_agif_encode_save_to_file() or image_util_agif_encode_save_to_buffer() to save the animated GIF.\n
 *          If you call this function after image_util_agif_encode_save_to_file() or image_util_agif_encode_save_to_buffer() function is called,
 *          this function will encode a new animated GIF.
 *
-* @param[in] handle The handle of animated GIF encoding
+* @param[in] handle The handle of encoding an animated GIF
 * @param[in] image The handle of the image for each frame
-* @param[in] time_delay The time delay between @a image and next image, in 0.01sec units
+* @param[in] time_delay The time delay between @a image and the next image (in 0.01sec increments)
 *
 * @return @c 0 on success,
 *                 otherwise a negative error value
@@ -635,21 +635,24 @@ int image_util_agif_encode_add_frame(image_util_agif_encode_h handle, image_util
 
 /**
 * @brief Saves the animated GIF image to the file.
-* @details After the data has been written to a file, the file cannot be modified (it's not possible to add frames to it).\n
-*          The encoder can still be used after the data is written. For example, the following is correct:\n
-*
-*          1. Add frames 1-10 to an encoder\n
-*          2. Save encoder data to file B1\n
-*          3. Add more frames (11-20) to the same encoder\n
-*          4. Save encoder data to a different file (B2)\n
-*
-*          It would not be possible to save the data to B1 in point 4.
+* @details After the data has been written to a file,
+*          the file cannot be modified. In other words,\n
+*          it is not possible to add frames to the file.\n
+*          However, the encoder can be still used after the data is written.\n
+*          For example, although you write the data to one file(B0),\n
+*          you can do the following operations:\n
+*
+*          1. Add frames 1-10 to the encoder.\n
+*          2. Save the data in the encoder to another file(B1).\n
+*          3. Add more frames (11-20) to the same encoder.\n
+*          4. Save the data in the encoder to the other file (B2)\n
+*             It is not possible to save the changed data to B1 file used in step 4.
 * @since_tizen 5.5
 *
-* @remarks http://tizen.org/privilege/mediastorage is needed if @a file_path points to media storage.\n
-*          http://tizen.org/privilege/externalstorage is needed if @a file_path points to external storage.
+* @remarks http://tizen.org/privilege/mediastorage is required if @a file_path value is media storage.\n
+*          http://tizen.org/privilege/externalstorage is required if @a file_path value is external storage.
 *
-* @param[in] handle The handle of the animated GIF encoding
+* @param[in] handle The handle of encoding an animated GIF
 * @param[in] file_path The file path for saving the animated GIF
 *
 * @return @c 0 on success,
@@ -674,20 +677,23 @@ int image_util_agif_encode_save_to_file(image_util_agif_encode_h handle, const c
 
 /**
 * @brief Saves the animated GIF image to the buffer.
-* @details After the data has been written to a buffer, the buffer cannot be modified (it's not possible to add frames to it).\n
-*          The encoder can still be used after the data is written. For example, the following is correct:\n
-*
-*          1. Add frames 1-10 to an encoder\n
-*          2. Save encoder data to buffer B1\n
-*          3. Add more frames (11-20) to the same encoder\n
-*          4. Save encoder data to a different buffer (B2)\n
-*
-*          It would not be possible to save the data to B1 in point 4.
+* @details After the data has been written to a buffer,
+*          the file cannot be modified. In other words,\n
+*          it is not possible to add frames to the buffer.\n
+*          However, the encoder can be still used after the data is written.\n
+*          For example, although you write the data to one buffer(B0),\n
+*          you can do the following operations:\n
+*
+*          1. Add frames 1-10 to the encoder.\n
+*          2. Save the data in the encoder to another buffer(B1).\n
+*          3. Add more frames (11-20) to the same encoder.\n
+*          4. Save the data in the encoder to the other buffer (B2)\n
+*             It is not possible to save the changed data to B1 file used in step 4.
 * @since_tizen 5.5
 *
 * @remarks The @a buffer should be released using free() after using it.
 *
-* @param[in] handle The handle of the animated GIF encoding
+* @param[in] handle The handle of encoding an animated GIF
 * @param[out] buffer The buffer in which the animated GIF is saved
 * @param[out] buffer_size The size of the buffer
 *
@@ -710,12 +716,12 @@ int image_util_agif_encode_save_to_file(image_util_agif_encode_h handle, const c
 int image_util_agif_encode_save_to_buffer(image_util_agif_encode_h handle, unsigned char **buffer, size_t *buffer_size);
 
 /**
-* @brief Destroys the handle of animated GIF encoding.
+* @brief Destroys the handle for encoding an animated GIF.
 * @since_tizen 5.5
 *
 * @remarks Any created animated GIF encoding handle created should be destroyed.
 *
-* @param[in] handle The handle of the animated GIF encoding
+* @param[in] handle The handle of encoding an animated GIF
 *
 * @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 806c46e..b3ae80a 100644 (file)
--- a/include/image_util_type.h
+++ b/include/image_util_type.h
@@ -268,7 +268,7 @@ typedef void (*image_util_encode_completed_cb) (int error_code, void *user_data,
 
 /**
 * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE
-* @brief Called when image encoding is finished just after storing the output to file.
+* @brief Called when image encoding is finished just after storing the output to the file.
 * @since_tizen 5.5
 *
 * @remarks The output will be stored in the file set using image_util_encode_run_to_file(). \n
@@ -288,7 +288,7 @@ typedef void (*image_util_encode_to_file_completed_cb) (image_util_error_e error
 
 /**
 * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE
-* @brief Called when image encoding is finished just after storing the output to buffer.
+* @brief Called when image encoding is finished just after storing the output to the buffer.
 * @since_tizen 5.5
 *
 * @remarks The output will be stored in the @a buffer. \n