summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormk5004.lee <mk5004.lee@samsung.com>2019-10-18 13:00:10 +0900
committerSukHyung Kang <shine.kang@samsung.com>2019-11-14 08:47:12 +0000
commit90a3a1cc18d4cf86e37d447c305de616c76b506b (patch)
tree184a0ab29c3149dceae8e698d2eb51e41553fe13
parent09d8fd2c794809d15347edac0ece3b6ee7312f6d (diff)
downloadappcore-widget-90a3a1cc18d4cf86e37d447c305de616c76b506b.tar.gz
appcore-widget-90a3a1cc18d4cf86e37d447c305de616c76b506b.tar.bz2
appcore-widget-90a3a1cc18d4cf86e37d447c305de616c76b506b.zip
Update doxygen
Change-Id: I9b1d04a6f4e98005e4954662d797139302b516bd Signed-off-by: mk5004.lee <mk5004.lee@samsung.com> (cherry picked from commit 251db92c77c0494774d5de43cb3d983cf2199ef7)
-rwxr-xr-xinclude/widget_app.h44
-rw-r--r--include/widget_app_efl.h4
2 files changed, 26 insertions, 22 deletions
diff --git a/include/widget_app.h b/include/widget_app.h
index 6b4d1d9..f387349 100755
--- a/include/widget_app.h
+++ b/include/widget_app.h
@@ -66,7 +66,7 @@ typedef struct _widget_context *widget_context_h;
* @param[in] content The data set for the previous status
* @param[in] w The pixel value for widget width
* @param[in] h The pixel value for widget height
- * @param[in] user_data The user data passed from widget_app_class_create function
+ * @param[in] user_data The user data passed from widget_app_class_create() function
*
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
@@ -84,12 +84,12 @@ typedef int (*widget_instance_create_cb)(widget_context_h context, bundle *conte
* As a input parameter, content contains the saved status of the widget instance.
* You can fill the content parameter with the current status in this callback,
* then the framework will save the content by receiving it as a output parameter.
- * Consequently, you should not use widget_app_context_set_content_info() api in this callback.
+ * Consequently, you should not use widget_app_context_set_content_info() function in this callback.
* The content will be overwritten after this callback returns with the 'content' parameter.
* @param[in] context The context of widget instance
* @param[in] reason The reason for destruction
* @param[in,out] content The data set to save
- * @param[in] user_data The user data passed from widget_app_class_create function
+ * @param[in] user_data The user data passed from widget_app_class_create() function
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
*/
@@ -102,7 +102,7 @@ typedef int (*widget_instance_destroy_cb)(widget_context_h context, widget_app_d
* The paused instance may be destroyed by framework.
* @since_tizen 2.3.1
* @param[in] context The context of widget instance
- * @param[in] user_data The user data passed from widget_app_class_create function
+ * @param[in] user_data The user data passed from widget_app_class_create() function
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
*/
@@ -114,7 +114,7 @@ typedef int (*widget_instance_pause_cb)(widget_context_h context, void *user_dat
* @details The callback function is called when the widget is visible.
* @since_tizen 2.3.1
* @param[in] context The context of widget instance
- * @param[in] user_data The user data passed from widget_app_class_create function
+ * @param[in] user_data The user data passed from widget_app_class_create() function
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
*/
@@ -128,7 +128,7 @@ typedef int (*widget_instance_resume_cb)(widget_context_h context, void *user_da
* @param[in] context The context of widget instance
* @param[in] w The pixel value for widget width
* @param[in] h The pixel value for widget height
- * @param[in] user_data The user data passed from widget_app_class_create function
+ * @param[in] user_data The user data passed from widget_app_class_create() function
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
*/
@@ -143,7 +143,7 @@ typedef int (*widget_instance_resize_cb)(widget_context_h context, int w, int h,
* @param[in] content The data set for updating this widget. It will be provided by requester.
* Requester can use widget_service_trigger_update()
* @param[in] force Although the widget is paused, if it is TRUE, the widget can be updated
- * @param[in] user_data The user data passed from widget_app_class_create function
+ * @param[in] user_data The user data passed from widget_app_class_create() function
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @see widget_service_trigger_update()
@@ -211,15 +211,15 @@ typedef struct {
/**
* @brief Called for each widget context.
- * @details This function will be called in the function of widget_app_foreach_context repeatedly.
+ * @details This function will be called in the function of widget_app_foreach_context() repeatedly.
* @since_tizen 2.3.1
* @param[in] context The context for widget instance
- * @param[in] data The data for caller
+ * @param[in] user_data The data for caller
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @see widget_app_foreach_context()
*/
-typedef bool (*widget_context_cb)(widget_context_h context, void *data);
+typedef bool (*widget_context_cb)(widget_context_h context, void *user_data);
/**
@@ -232,8 +232,8 @@ typedef bool (*widget_context_cb)(widget_context_h context, void *data);
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successful
- * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
* @see widget_app_exit()
*/
@@ -262,8 +262,8 @@ int widget_app_exit(void);
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successful
- * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
*/
int widget_app_terminate_context(widget_context_h context);
@@ -277,11 +277,11 @@ int widget_app_terminate_context(widget_context_h context);
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successful
+ * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_CANCELED The iteration is canceled
- * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
- * @see widget_app_foreach_context()
+ * @see widget_context_cb()
*/
int widget_app_foreach_context(widget_context_cb callback, void *data);
@@ -296,9 +296,9 @@ int widget_app_foreach_context(widget_context_cb callback, void *data);
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successful
+ * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
* @see app_event_type_e
* @see app_event_cb()
@@ -314,8 +314,8 @@ int widget_app_add_event_handler(app_event_handler_h *event_handler, app_event_t
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successful
- * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
* @see widget_app_add_event_handler()
*/
@@ -334,7 +334,9 @@ int widget_app_remove_event_handler(app_event_handler_h event_handler);
* @param[in] context The context for widget instance
* @return widget instance id on success,
* otherwise NULL
+ * @exception #WIDGET_ERROR_NONE Successful
* @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @exception #WIDGET_ERROR_FAULT Unrecoverable error
* @see get_last_result()
* @see widget_service_trigger_update()
@@ -353,8 +355,8 @@ const char *widget_app_get_id(widget_context_h context);
* @return The new widget class object,
* NULL on error
* @exception #WIDGET_ERROR_NONE Successfully added
- * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @exception #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
* @see get_last_result()
*/
@@ -368,6 +370,7 @@ widget_class_h widget_app_class_create(widget_instance_lifecycle_callback_s call
* @param[in] tag The value to save
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
+ * @retval #WIDGET_ERROR_NONE Successful
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
@@ -382,6 +385,7 @@ int widget_app_context_set_tag(widget_context_h context, void *tag);
* @param[out] tag The value to get
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
+ * @retval #WIDGET_ERROR_NONE Successful
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
@@ -397,8 +401,8 @@ int widget_app_context_get_tag(widget_context_h context, void **tag);
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successfully sent
- * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
* @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
*/
@@ -413,8 +417,8 @@ int widget_app_context_set_content_info(widget_context_h context, bundle *conten
* @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successfully sent
- * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
* @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
* @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
* @retval #WIDGET_ERROR_FAULT Unrecoverable error
*/
@@ -432,8 +436,8 @@ int widget_app_context_set_title(widget_context_h context, const char *title);
* @return The new widget class object,
* NULL on error
* @exception #WIDGET_ERROR_NONE Successfully added
- * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
+ * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @exception #WIDGET_ERROR_OUT_OF_MEMORY Out of memory
* @see get_last_result()
*/
diff --git a/include/widget_app_efl.h b/include/widget_app_efl.h
index 7d65cf3..8817395 100644
--- a/include/widget_app_efl.h
+++ b/include/widget_app_efl.h
@@ -37,11 +37,11 @@ extern "C" {
* @param[in] context The context for widget instance
* @param[out] win evas object for window
* @return 0 on success,
- * otherwise a negative error value
+ * otherwise a negative error value
* @retval #WIDGET_ERROR_NONE Successful
+ * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIDGET_ERROR_FAULT Failed to make evas object
- * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported
*/
int widget_app_get_elm_win(widget_context_h context, Evas_Object **win);