Changes by ACR

Change-Id: I1dee226066a261199da6cafebfa95ea0abfbe420
Signed-off-by: Kyuho Jo <kyuho.jo@samsung.com>

diff --git a/include/widget.h b/include/widget.h
old mode 100644 (file)
new mode 100755 (executable)
index d67918f..6fabf9f
--- a/include/widget.h
+++ b/include/widget.h
@@ -40,10 +40,9 @@ extern "C" {
  * @brief Creates an Evas to draw widget contents
  * @details Creating a new Object using widget frame buffer.
  * @since_tizen 2.3.1
- * @param[in] widget_intance_id widget instance id from widget from widget_provider_event_callback_s functions
+ * @param[in] widget_intance_id widget instance id
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
  * @return instance of Evas
  * @retval Valid pointer of Evas instance on success,
  * @retval @c NULL failed to create, get_last_result() will returns reason of failure
@@ -52,11 +51,10 @@ extern Evas *widget_get_evas(const char *widget_intance_id);
 
 /**
  * @brief Requests to schedule the update operation to a provider.
- * @detail Insert a update event to event queue and it will be handled by update callback function.
+ * @detail Inserts a update event to event queue and it will be handled by update callback function defined by provider
  * @since_tizen 2.3.1
  * @param[in] widget_intance_id A instance id of the widget to be updated
- * @feature http://tizen.org/feature/shell.appwidget
- * @return If succes returns 0 or return less than 0
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully triggered
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Not enough memory

diff --git a/include/widget_internal.h b/include/widget_internal.h
old mode 100644 (file)
new mode 100755 (executable)
index 1daaac5..a498e70
--- a/include/widget_internal.h
+++ b/include/widget_internal.h
@@ -157,7 +157,6 @@ extern "C" {
  * @internal
  * @brief Return values of widget programming interfaces for the plug-in type widgets
  * @since_tizen 2.3.1
- * @feature http://tizen.org/feature/shell.appwidget
  */
 typedef enum widget_api_result {
        WIDGET_DONE = 0x00, /**< Operation is successfully done. */
@@ -172,7 +171,6 @@ typedef enum widget_api_result {
  * @internal
  * @brief System event type for the plug-in type widgets
  * @since_tizen 2.3.1
- * @feature http://tizen.org/feature/shell.appwidget
  */
 typedef enum widget_system_event {
        WIDGET_SYS_EVENT_FONT_CHANGED = 0x01, /**< System font is changed. */
@@ -209,7 +207,6 @@ typedef void (*widget_flush_cb)(void *snapshot_window, const char *id, int statu
  * @param[in] gbar 1 for Glance Bar or 0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
  * @return Handle of desc instance
  * @retval @c NULL Failed to create a desc instance, get_last_result() will returns reason of failure
  * @pre Should be loaded by data-provider-slave.
@@ -227,9 +224,7 @@ extern widget_desc_h widget_desc_open(const char *id, int gbar);
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE If the flushing description data is successfully done
  * @retval #WIDGET_ERROR_INVALID_PARAMETER If the given handle is not valid
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
@@ -247,8 +242,7 @@ extern int widget_desc_close(widget_desc_h handle);
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] id Id string of target object
  * @param[in] category Category string that will be used by layout object
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid handle
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Memory is not enough to add this block
  * @retval index Index(>=0) of added block, which can be used by widget_desc_set_id()
@@ -266,8 +260,7 @@ extern int widget_desc_set_category(widget_desc_h handle, const char *id, const
  * @param[in] id Id string of target object
  * @param[in] w Width in pixel
  * @param[in] h Height in pixel
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Not enough memory to add a new block
  * @retval index Index(>=0) of added block Successfully added
@@ -284,8 +277,7 @@ extern int widget_desc_set_size(widget_desc_h handle, const char *id, int w, int
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] idx Index of target block
  * @param[in] id Id String which will be used by other widget_desc_XXX functions
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Id is successfully updated for given idx of desc block
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_NOT_EXIST Given index of desc block is not exists
@@ -323,8 +315,7 @@ extern int widget_desc_add_block(widget_desc_h handle, const char *id, const cha
  * @details If you discard the added desc block, use this API and the index of the created desc block.
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] idx Index of added block, returned from widget_desc_add_block(), widget_desc_set_size(), widget_desc_set_category(), etc
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully deleted
  * @retval #WIDGET_ERROR_NOT_EXIST Given index of desc block is not exists
  * @pre Index must be exists.
@@ -355,8 +346,7 @@ extern const int WIDGET_USE_NET;
  * @since_tizen 2.3.1
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
  * @param[in] gbar 1 for updating content of Glance Bar or 0(for content of widget)
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Not enough memory
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_IO_ERROR I/O failed, Cannot access given resource file(id)
@@ -378,7 +368,6 @@ extern int widget_content_is_updated(const char *id, int gbar);
  * @param[in] data User data for event handling callback
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
  * @return Buffer handle
  * @retval @c NULL Failed to acquire buffer, get_last_result() will returns reason of failure.
  * @retval handler Handle object
@@ -399,8 +388,7 @@ extern widget_buffer_h widget_create_buffer(const char *id, int gbar, int auto_a
  * @param[in] pixels Pixel size in byte
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return int status
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully allocated
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WIDGET_ERROR_FAULT Unrecoverable error occurred
@@ -435,8 +423,7 @@ extern unsigned int widget_viewer_get_resource_id(widget_buffer_h handle, int id
  * @param[in] idx Index of a buffer, #c WIDGET_PRIMARY_BUFFER is used for accessing the primary buffer
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return int status
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_NONE Successfully released
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
@@ -452,8 +439,7 @@ extern int widget_viewer_release_buffer(widget_buffer_h handle, int idx);
  * @param[in] handle buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return int status
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMTER Invalid argument
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_NONE Successfully destroyed
@@ -470,8 +456,6 @@ extern int widget_destroy_buffer(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return void* address of the render buffer
  * @retval @c NULL If it falis to get buffer address, get_last_result() will returns reason of failure.
  * @retval address If it succeed to get the buffer address
  * @see widget_unref_buffer()
@@ -485,9 +469,7 @@ extern void *widget_ref_buffer(widget_buffer_h handle);
  * @param[in] buffer Address of render buffer
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid handle
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_NONE Successfully unreference
@@ -505,9 +487,7 @@ extern int widget_unref_buffer(void *buffer);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully sync'd
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
@@ -536,9 +516,7 @@ extern int widget_support_hw_buffer(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_ALREADY_EXIST H/W buffer is already created
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
@@ -557,9 +535,7 @@ extern int widget_create_hw_buffer(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully destroyed
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
@@ -576,8 +552,6 @@ extern int widget_destroy_hw_buffer(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return void* type
  * @retval @c NULL Failed to get H/W accelerated buffer address, get_last_result() will returns reason of failure.
  * @retval addr H/W accelerated buffer address
  * @see widget_create_hw_buffer()
@@ -592,8 +566,8 @@ extern void *widget_buffer_hw_buffer(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @return int stride size
  * @retval positive_value length of stride
- * @return #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
- * @return #WIDGET_ERROR_FAULT Unrecoverable error
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIDGET_ERROR_FAULT Unrecoverable error
  * @see widget_create_hw_buffer()
  */
 extern int widget_buffer_stride(widget_buffer_h handle);
@@ -606,9 +580,7 @@ extern int widget_buffer_stride(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid handle
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_NONE Successfully done
@@ -625,8 +597,7 @@ extern int widget_buffer_pre_render(widget_buffer_h handle);
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return If succes returns 0 or return less than 0
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE If succeed
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
@@ -646,9 +617,7 @@ extern int widget_buffer_post_render(widget_buffer_h handle);
  * @param[in] reason #WIDGET_ERROR_NONE(0)
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
@@ -668,7 +637,6 @@ extern int widget_request_close_glance_bar(const char *widgetid, const char *id,
  * @since_tizen 2.3.1
  * @param[in] id
  * @param[in] size_type
- * @return void* window
  * @retval @c NULL failed to create a snapshot window, get_last_result() will returns reason of failure.
  * @retval Object window object (ex, elementary window)
  * @see widget_snapshot_window_flush()
@@ -683,7 +651,7 @@ extern void *widget_snapshot_window_add(const char *id, int size_type);
  * @param[in] timeout After this, the image file will be created
  * @param[in] flush_cb Right after flush an image file, this callback will be called
  * @param[in] data Callback data for flush_cb
- * @return int status
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully flushed (flush timer added)
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid paramter
  * @retval #WIDGET_ERROR_FAULT Failed to create a flush timer
@@ -699,8 +667,7 @@ extern int widget_snapshot_window_flush(void *snapshot_win, double timeout, widg
  * @param[in] idx Index of a buffer
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return int status
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_NONE Successfully sent
  */
 extern int widget_send_updated_by_idx(widget_buffer_h handle, int idx);
@@ -714,16 +681,13 @@ extern int widget_send_updated_by_idx(widget_buffer_h handle, int idx);
  *      provider will send those information to the viewer when the
  *      content is updated.
  * @since_tizen 2.3.1
- * @privlevel N/P
- * @feature http://tizen.org/feature/shell.appwidget
- * @remarks This function only works with the buffer type inhouse provider.
+ * * @remarks This function only works with the buffer type inhouse provider.
  * @param[in] id widget Instance Id
  * @param[in] content Content string that will pass to a widget via widget_create interface when it is re-created.
  * @param[in] title Human readable text for accessibility, summarized text for representing the content of a box.
  * @param[in] icon Path of icon image file - alternative image content
  * @param[in] name Name of a box - alternative text content
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #WIDGET_ERROR_FAULT Unrecoverable error
@@ -744,9 +708,7 @@ extern int widget_set_extra_info(const char *id, const char *content, const char
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
@@ -769,9 +731,7 @@ extern int widget_freeze_scroller(const char *widgetid, const char *id);
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
- * @feature http://tizen.org/feature/shell.appwidget
- * @return #WIDGET_ERROR_NONE on success,
- *          otherwise an error code (see #WIDGET_ERROR_XXX) on failure
+ * @return 0 on success, otherwise a negative error value
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory