Update doxygen

Privilege, Feature is updated
Specify the permission denied return code.

[model] Redwood,Kiran,B3(Wearable)
[binary_type] AP
[customer] Docomo/Orange/ATT/Open
[issue#] N/A
[problem]
[cause]
[solution]
[team] HomeTF
[request]
[horizontal_expansion]

Change-Id: I1f95472078b859b44a8eecec07ea02aad677f462

diff --git a/include/dynamicbox.h b/include/dynamicbox.h
index a2fe240..0b6c793 100644 (file)
--- a/include/dynamicbox.h
+++ b/include/dynamicbox.h
@@ -175,8 +175,9 @@ typedef void (*dynamicbox_flush_cb)(void *snapshot_window, const char *id, int s
  * @param[in] id Dynamic Box Instance Id
  * @param[in] gbar 1 for Glance Bar or 0
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return Handle of desc instance
+ * @retval @c NULL Failed to create a desc instance, dynamicbox_last_status() will returns reason of failure
  * @pre Should be loaded by data-provider-slave.
  * @post Should be destroyed(flushed) using dynamicbox_desc_close() API.
  * @see dynamicbox_desc_close()
@@ -191,10 +192,11 @@ extern dynamicbox_desc_h dynamicbox_desc_open(const char *id, int gbar);
  * @remarks Must be used only by Inhouse Dynamic Box.
  * @param[in] handle Handle which is created by dynamicbox_desc_open() function
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
  * @retval #DBOX_STATUS_ERROR_NONE If the flushing description data is successfully done
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER If the given handle is not valid
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @pre Handle must be created by dynamicbox_desc_open()
  * @post Handle must not be used after return from this function.
  * @see dynamicbox_desc_open()
@@ -298,12 +300,12 @@ extern int dynamicbox_desc_del_block(dynamicbox_desc_h handle, int idx);
  * @param[in] id Instance Id
  * @param[in] gbar 1 if this object is created for Glance Bar or 0 (for Dynamic Box)
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @feature http://developer.samsung.com/tizen/feature/samsung_extension
- * @feature http://tizen.org/feature/shell.appwidget
+ * @feature http://developer.samsung.com/tizen/feature/in_house/shell.appwidget
  * @return void* Object type
  * @retval Address Valid evas object
- * @retval @c NULL failed to create
+ * @retval @c NULL failed to create, dynamicbox_last_status() will returns reason of failure
  */
 extern void *dynamicbox_get_evas_object(const char *id, int gbar);
 
@@ -323,7 +325,7 @@ extern void *dynamicbox_get_evas_object(const char *id, int gbar);
  * @param[in] name Name of a box - alternative text content
  * @return int type
  * @feature http://developer.samsung.com/tizen/feature/samsung_extension
- * @feature http://tizen.org/feature/shell.appwidget
+ * @feature http://developer.samsung.com/tizen/feature/in_house/shell.appwidget
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_FAULT Unrecoverable error
@@ -473,9 +475,9 @@ extern int dynamicbox_content_is_updated(const char *id, int gbar);
  * @param[in] handler Event handling callback
  * @param[in] data User data for event handling callback
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return Buffer handle
- * @retval @c NULL Failed to acquire buffer
+ * @retval @c NULL Failed to acquire buffer, dynamicbox_last_status() will returns reason of failure.
  * @retval handler Handle object
  * @pre Given instance must be specify its type as buffer. or this API will be fail.
  * @post Allocated buffer object must be released via dynamicbox_release_buffer().
@@ -493,11 +495,12 @@ extern dynamicbox_buffer_h dynamicbox_create_buffer(const char *id, int gbar, in
  * @param[in] height Height of a buffer
  * @param[in] pixels Pixel size in byte
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int status
  * @retval #DBOX_STATUS_ERROR_NONE Successfully allocated
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #DBOX_STATUS_ERROR_FAULT Unrecoverable error occurred
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @pre dynamicbox_create_buffer() must be called
  * @see dynamicbox_create_buffer()
  * @see dynamicbox_release_buffer()
@@ -527,10 +530,11 @@ extern unsigned int dynamicbox_resource_id(dynamicbox_buffer_h handle, int idx);
  * @param[in] handle Buffer handle
  * @param[in] idx Index of a buffer, #c DBOX_PRIMARY_BUFFER is used for accessing the primary buffer
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int status
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #DBOX_STATUS_ERROR_NONE Successfully released
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @pre Handle must be created using dynamicbox_acquire_buffer().
  * @see dynamicbox_acquire_buffer()
  */
@@ -542,9 +546,10 @@ extern int dynamicbox_release_buffer(dynamicbox_buffer_h handle, int idx);
  * @since_tizen 2.3
  * @param[in] handle buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int status
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMTER Invalid argument
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_NONE Successfully destroyed
  * @see dynamicbox_create_buffer()
  */
@@ -558,9 +563,9 @@ extern int dynamicbox_destroy_buffer(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return void* address of the render buffer
- * @retval @c NULL If it falis to get buffer address
+ * @retval @c NULL If it falis to get buffer address, dynamicbox_last_status() will returns reason of failure.
  * @retval address If it succeed to get the buffer address
  * @see dynamicbox_unref_buffer()
  */
@@ -572,9 +577,10 @@ extern void *dynamicbox_ref_buffer(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] buffer Address of render buffer
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid handle
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_NONE Successfully unreference
  * @pre dynamicbox_ref_buffer() must be called.
  * @see dynamicbox_ref_buffer()
@@ -589,9 +595,10 @@ extern int dynamicbox_unref_buffer(void *buffer);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
  * @retval #DBOX_STATUS_ERROR_NONE Successfully sync'd
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid argument
  * @see dynamicbox_acquire_buffer()
  */
@@ -603,12 +610,13 @@ extern int dynamicbox_sync_buffer(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] id Instance Id which is passed to you via the first parameter of every dynamicbox_XXXX interface functions
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return If succes returns 0 or return less than 0
  * @retval #DBOX_STATUS_ERROR_NONE Successfully triggered
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Not enough memory
  * @retval #DBOX_STATUS_ERROR_NOT_EXIST Given id instance is not exist
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  */
 extern int dynamicbox_request_update(const char *id);
 
@@ -632,10 +640,11 @@ extern int dynamicbox_support_hw_buffer(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
  * @retval #DBOX_STATUS_ERROR_ALREADY H/W buffer is already created
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid argument
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_NONE Successfully created
  * @pre Must be checked whether the H/W buffer is supported or not.
  * @post Must be destroyed if it is not necessary.
@@ -650,9 +659,10 @@ extern int dynamicbox_create_hw_buffer(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
  * @retval #DBOX_STATUS_ERROR_NONE Successfully destroyed
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid argument
  * @pre Must be created h/w buffer using dynamicbox_create_hw_buffer.
  * @see dynamicbox_create_hw_buffer()
@@ -666,9 +676,9 @@ extern int dynamicbox_destroy_hw_buffer(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return void* type
- * @retval @c NULL Failed to get H/W accelerated buffer address
+ * @retval @c NULL Failed to get H/W accelerated buffer address, dynamicbox_last_status() will returns reason of failure.
  * @retval addr H/W accelerated buffer address
  * @see dynamicbox_create_hw_buffer()
  */
@@ -695,9 +705,10 @@ extern int dynamicbox_buffer_stride(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid handle
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_NONE Successfully done
  * @post dynamicbox_buffer_post_render must be called after the rendering (accessing buffer) is completed.
  * @see dynamicbox_support_hw_buffer()
@@ -711,9 +722,10 @@ extern int dynamicbox_buffer_pre_render(dynamicbox_buffer_h handle);
  * @since_tizen 2.3
  * @param[in] handle Buffer handle
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return If succes returns 0 or return less than 0
  * @retval #DBOX_STATUS_ERROR_NONE If succeed
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid argument
  * @pre dynamicbox_buffer_pre_render must be called.
  * @see dynamicbox_support_hw_buffer()
@@ -730,8 +742,9 @@ extern int dynamicbox_buffer_post_render(dynamicbox_buffer_h handle);
  * @param[in] id Instance Id which is passed to you via the first parameter of every dynamicbox_XXXX interface functions
  * @param[in] reason #DBOX_STATUS_ERROR_NONE(0)
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return int type
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #DBOX_STATUS_ERROR_FAULT Failed to send a request
@@ -749,12 +762,13 @@ extern int dynamicbox_request_close_glance_bar(const char *dboxid, const char *i
  * @param[in] dboxid Dynamic Box Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every dynamicbox_XXXX interface functions
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @feature http://developer.samsung.com/tizen/feature/samsung_extension
- * @feature http://tizen.org/feature/shell.appwidget
+ * @feature http://developer.samsung.com/tizen/feature/in_house/shell.appwidget
  * @return int type
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_FAULT Failed to send requet
  * @retval #DBOX_STATUS_ERROR_NONE Successfully requested
  * @see dynamicbox_release_scroller()
@@ -771,10 +785,11 @@ extern int dynamicbox_freeze_scroller(const char *dboxid, const char *id);
  * @param[in] dboxid Dynamic Box Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every dynamicbox_XXXX interface functions
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @feature http://developer.samsung.com/tizen/feature/samsung_extension
- * @feature http://tizen.org/feature/shell.appwidget
+ * @feature http://developer.samsung.com/tizen/feature/in_house/shell.appwidget
  * @return int type
+ * @retval #DBOX_STATUS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #DBOX_STATUS_ERROR_INVALID_PARAMETER Invalid parameters
  * @retval #DBOX_STATUS_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #DBOX_STATUS_ERROR_FAULT Failed to send requet
@@ -795,9 +810,9 @@ extern int dynamicbox_thaw_scroller(const char *dboxid, const char *id);
  * @param[in] id
  * @param[in] size_type
  * @privlevel public
- * @privilege %http://tizen.org/privilege/core/dynamicbox
+ * @privilege %http://developer.samsung.com/tizen/privilege/widgetbind
  * @return void* window
- * @retval @c NULL failed to create a snapshot window
+ * @retval @c NULL failed to create a snapshot window, dynamicbox_last_status() will returns reason of failure.
  * @retval Object window object (ex, elementary window)
  * @see dynamicbox_snapshot_window_flush()
  */