summaryrefslogtreecommitdiff
path: root/include/app.h
diff options
context:
space:
mode:
authorMyungKi Lee <mk5004.lee@samsung.com>2019-11-08 00:52:13 +0000
committerGerrit Code Review <gerrit@review.ap-northeast-2.compute.internal>2019-11-08 00:52:13 +0000
commit34f73cee3224af8926f5fe8f24e4958f0640ddd3 (patch)
tree1f333646323e10360e14eeb3dece5b48c761c40e /include/app.h
parente47307a42759099dd0290e23a28d24c3b314268e (diff)
parent8e708ec8ab3f76bc7e549e365400b7d30f2958e8 (diff)
downloadapplication-34f73cee3224af8926f5fe8f24e4958f0640ddd3.tar.gz
application-34f73cee3224af8926f5fe8f24e4958f0640ddd3.tar.bz2
application-34f73cee3224af8926f5fe8f24e4958f0640ddd3.zip
Merge "Update doxygen" into tizen
Diffstat (limited to 'include/app.h')
-rw-r--r--include/app.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/include/app.h b/include/app.h
index 0794ae2..45cd791 100644
--- a/include/app.h
+++ b/include/app.h
@@ -41,7 +41,7 @@ extern "C" {
* After this callback function returns @c true, the main loop starts up and app_control_cb() is subsequently called.
* If this callback function returns @c false, the main loop doesn't start and app_terminate_cb() is subsequently called.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] user_data The user data passed from the callback registration function
+ * @param[in] user_data The user data passed from the callback registration function
* @return @c true on success,
* otherwise @c false
* @pre ui_app_main() will invoke this callback function.
@@ -56,8 +56,8 @@ typedef bool (*app_create_cb) (void *user_data);
* @details The application is not terminated and still running in the paused state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] user_data The user data passed from the callback registration function
- * @see ui_app_main()
- * @see #ui_app_lifecycle_callback_s
+ * @see ui_app_main()
+ * @see #ui_app_lifecycle_callback_s
*/
typedef void (*app_pause_cb) (void *user_data);
@@ -66,7 +66,7 @@ typedef void (*app_pause_cb) (void *user_data);
* @brief Called when the application becomes visible.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] user_data The user data passed from the callback registration function
- * @see ui_app_main()
+ * @see ui_app_main()
* @see #ui_app_lifecycle_callback_s
*/
typedef void (*app_resume_cb) (void *user_data);
@@ -77,7 +77,7 @@ typedef void (*app_resume_cb) (void *user_data);
* @details You should release the application's resources in this function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] user_data The user data passed from the callback registration function
- * @see ui_app_main()
+ * @see ui_app_main()
* @see #ui_app_lifecycle_callback_s
*/
typedef void (*app_terminate_cb) (void *user_data);
@@ -147,7 +147,7 @@ app_device_orientation_e app_get_device_orientation(void);
* @param[in] callback The set of callback functions to handle application lifecycle events
* @param[in] user_data The user data to be passed to the callback functions
* @return @c 0 on success,
- * otherwise a negative error value
+ * otherwise a negative error value
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system
@@ -181,13 +181,13 @@ void ui_app_exit(void);
* @param[in] callback The callback function
* @param[in] user_data The user data to be passed to the callback functions
* @return @c 0 on success,
- * otherwise a negative error value
+ * otherwise a negative error value
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_ERROR_OUT_OF_MEMORY Out of memory
* @see app_event_type_e
* @see app_event_cb
- * @see ui_app_remove_event_handler
+ * @see ui_app_remove_event_handler()
*/
int ui_app_add_event_handler(app_event_handler_h *event_handler, app_event_type_e event_type, app_event_cb callback, void *user_data);
@@ -197,10 +197,10 @@ int ui_app_add_event_handler(app_event_handler_h *event_handler, app_event_type_
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] event_handler The event handler
* @return @c 0 on success,
- * otherwise a negative error value
+ * otherwise a negative error value
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
- * @see ui_app_add_event_handler
+ * @see ui_app_add_event_handler()
*/
int ui_app_remove_event_handler(app_event_handler_h event_handler);