Change API description by API review

Change-Id: I18a16d9cdc031af5fae04ff8d7e5dd4ae6b20526

diff --git a/doc/sticker_doc.h b/doc/sticker_doc.h
index 4c3b325..9938252 100644 (file)
--- a/doc/sticker_doc.h
+++ b/doc/sticker_doc.h
@@ -25,6 +25,8 @@
  *
  * @section CAPI_UIX_STICKER_MODULE_OVERVIEW Overview
  * Using sticker library, a sticker application can provide sticker information to applications that want to read the sticker information as the standard specification.
+ * A <a href="https://en.wikipedia.org/wiki/Sticker_(messaging)">sticker</a> is an image (possibly animated) that is used in an IM conversation.
+ * The Sticker API covers the exchange of sticker data between applications. How the images are used depends on a particular sticker consumer application.
  *
  * @section CAPI_UIX_STICKER_MODULE_FEATURE Related Feature
  * This API is related with the following feature:\n

diff --git a/include/sticker_consumer.h b/include/sticker_consumer.h
index 7231f26..8ac5845 100644 (file)
--- a/include/sticker_consumer.h
+++ b/include/sticker_consumer.h
@@ -40,9 +40,9 @@ extern "C" {
  * @since_tizen 5.5
  */
 typedef enum {
-    STICKER_CONSUMER_EVENT_TYPE_INSERT, /**< Insert event type */
-    STICKER_CONSUMER_EVENT_TYPE_DELETE, /**< Delete event type */
-    STICKER_CONSUMER_EVENT_TYPE_UPDATE, /**< Update event type */
+    STICKER_CONSUMER_EVENT_TYPE_INSERT, /**< A sticker data has been added */
+    STICKER_CONSUMER_EVENT_TYPE_DELETE, /**< A sticker data has been removed */
+    STICKER_CONSUMER_EVENT_TYPE_UPDATE, /**< A sticker data has been updated */
 } sticker_consumer_event_type_e;
 
 /**
@@ -100,9 +100,9 @@ typedef void (*sticker_consumer_keyword_list_foreach_cb)(const char *keyword, vo
  * @since_tizen 5.5
  * @remarks @a data_handle should not be freed and can be used only in the callback.
  *          If you want to use it outside of the callback, you need to use a clone which can be obtained sticker_data_clone().
- *          When the @a event_type is STICKER_CONSUMER_EVENT_TYPE_DELETE, sticker data can be obtained using @a data_handle,
- *          but unable to access file because it has been deleted.
- * @param[in] event_type The event type of sticker
+ *          When the @a event_type is #STICKER_CONSUMER_EVENT_TYPE_DELETE, sticker data can be obtained using @a data_handle,
+ *          but the files have been already deleted.
+ * @param[in] event_type The event type
  * @param[in] data_handle The sticker data handle
  * @param[in] user_data The user data passed from sticker_consumer_set_event_callback()
  * @pre The callback can be registered using sticker_consumer_set_event_callback()
@@ -289,7 +289,7 @@ int sticker_consumer_keyword_list_foreach_all(sticker_consumer_h consumer_handle
 int sticker_consumer_data_foreach_by_display_type(sticker_consumer_h consumer_handle, int offset, int count, int *result, sticker_data_display_type_e type, sticker_consumer_data_foreach_cb callback, void *user_data);
 
 /**
- * @brief Retrieves all group name in the sticker database using display type.
+ * @brief Retrieves all group names assigned to stickers with a matching display @a type.
  * @since_tizen 5.5
  * @param[in] consumer_handle The sticker consumer handle
  * @param[in] type The display type of the sticker for getting sticker data
@@ -306,7 +306,7 @@ int sticker_consumer_data_foreach_by_display_type(sticker_consumer_h consumer_ha
 int sticker_consumer_group_list_foreach_by_display_type(sticker_consumer_h consumer_handle, sticker_data_display_type_e type, sticker_consumer_group_list_foreach_cb callback, void *user_data);
 
 /**
- * @brief Add history to recently used stickers list
+ * @brief Adds entry to recently used stickers list.
  * @since_tizen 5.5
  * @param[in] consumer_handle The sticker consumer handle
  * @param[in] data_handle The sticker data handle

diff --git a/include/sticker_data.h b/include/sticker_data.h
index e27197c..088c386 100644 (file)
--- a/include/sticker_data.h
+++ b/include/sticker_data.h
@@ -50,7 +50,12 @@ typedef enum {
  */
 typedef enum {
     STICKER_DATA_DISP_EMOJI = 1, /**< Emoji type */
-    STICKER_DATA_DISP_WALLPAPER, /**< Wallpaper type */
+    /**
+     * @brief Wallpaper type
+     * @details The stickers of the wallpaper type are intended to be used by
+     * a wallpaper application and usually have larger size.
+     */
+    STICKER_DATA_DISP_WALLPAPER,
 } sticker_data_display_type_e;
 
 /**

diff --git a/include/sticker_provider.h b/include/sticker_provider.h
index 8271ad7..cdfbac4 100644 (file)
--- a/include/sticker_provider.h
+++ b/include/sticker_provider.h
@@ -98,7 +98,7 @@ int sticker_provider_destroy(sticker_provider_h provider_handle);
  * @brief Inserts a sticker data to the sticker database.
  * @since_tizen 5.5
  * @remarks All data except thumbnail, description, display_type must be set in the @a data_handle to insert the sticker data.
- *          If the uri type is #STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
+ *          If the URI type is #STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
  *          It is recommended to delete your sticker file after inserting a sticker data.
  * @param[in] provider_handle The sticker provider handle
  * @param[in] data_handle The sticker data handle to be saved
@@ -115,15 +115,15 @@ int sticker_provider_destroy(sticker_provider_h provider_handle);
 int sticker_provider_insert_data(sticker_provider_h provider_handle, sticker_data_h data_handle);
 
 /**
- * @brief Inserts a sticker data using json file.
+ * @brief Inserts a sticker data using JSON file.
  * @details @a json_path must be a relative path like '/data/message_sticker.json'.
  * @since_tizen 5.5
- * @remarks All data except thumbnail, description, display_type must be set in the json file to insert the sticker data.
+ * @remarks All data except thumbnail, description, display_type must be set in the JSON file to insert the sticker data.
  *          @a json_path must have a non-null value and must be an existing file. If not, the error as invalid parameter will be returned.
- *          If the uri type is #STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
+ *          If the URI type is #STICKER_DATA_URI_LOCAL_PATH, the sticker file is copied to a sticker directory.
  *          It is recommended to delete your sticker files after inserting a sticker data.
  * @param[in] provider_handle The sticker provider handle
- * @param[in] json_path The path of json file containing sticker information to be saved
+ * @param[in] json_path The path of JSON file containing sticker information to be saved
  * @param[in] callback The callback function to invoke
  * @param[in] user_data The user data to be passed to the callback function
  * @return 0 on success, otherwise a negative error value
@@ -135,7 +135,7 @@ int sticker_provider_insert_data(sticker_provider_h provider_handle, sticker_dat
  * @see sticker_provider_insert_finished_cb()
  *
  * @code
- //json file format
+ //JSON file format
  {
     "sticker":
     [
@@ -201,7 +201,8 @@ int sticker_provider_update_data(sticker_provider_h provider_handle, sticker_dat
 int sticker_provider_delete_data(sticker_provider_h provider_handle, sticker_data_h data_handle);
 
 /**
- * @brief Deletes a sticker data in the sticker database using URI.
+ * @brief Deletes a sticker data with the given @a uri from the sticker database.
+ * @details If the database does not have a sticker that matches the given @a uri, the STICKER_ERROR_NO_SUCH_FILE error is returned.
  * @since_tizen 5.5
  * @param[in] provider_handle The sticker provider handle
  * @param[in] uri The URI of the sticker data to be deleted