summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormk5004.lee <mk5004.lee@samsung.com>2019-09-27 07:23:18 (GMT)
committermk5004.lee <mk5004.lee@samsung.com>2019-09-27 07:27:15 (GMT)
commit8e708ec8ab3f76bc7e549e365400b7d30f2958e8 (patch)
tree1a0d13c0768c85f9bd00f644e22b85a10369f382
parentd741b381f9eabd0057e277361a85990fa7ec425a (diff)
downloadapplication-8e708ec8ab3f76bc7e549e365400b7d30f2958e8.zip
application-8e708ec8ab3f76bc7e549e365400b7d30f2958e8.tar.gz
application-8e708ec8ab3f76bc7e549e365400b7d30f2958e8.tar.bz2
Change-Id: Ifd166d4faa0a943c1d9350798b41a75e7f7d4d12 Signed-off-by: mk5004.lee <mk5004.lee@samsung.com>
-rw-r--r--include/app.h20
-rwxr-xr-xinclude/app_extension.h24
-rw-r--r--include/app_internal.h14
3 files changed, 29 insertions, 29 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);
diff --git a/include/app_extension.h b/include/app_extension.h
index a66852f..b5b6455 100755
--- a/include/app_extension.h
+++ b/include/app_extension.h
@@ -23,37 +23,37 @@ extern "C" {
#endif
/**
- * @brief Gets the preinitialized window object.
+ * @brief Gets the preinitialized window object.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks This API only supports BASIC type window.
+ * @remarks This function only supports BASIC type window.
*
* @param[in] win_name The name to be set for the preinitialized window
*
- * @return A @a window object on success,
- * otherwise @c NULL
+ * @return A @a window object on success,
+ * otherwise @c NULL
*/
void *app_get_preinitialized_window(const char *win_name);
/**
- * @brief Gets the preinitialized background object added to the preinitialized window.
+ * @brief Gets the preinitialized background object added to the preinitialized window.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks This API should be called after calling app_get_preinitizlized_window().
+ * @remarks This function should be called after calling app_get_preinitizlized_window().
*
- * @return A @a background object on success,
- * otherwise @c NULL
+ * @return A @a background object on success,
+ * otherwise @c NULL
*/
void *app_get_preinitialized_background(void);
/**
- * @brief Gets the preinitialized conformant widget added to the preinitialized window.
+ * @brief Gets the preinitialized conformant widget added to the preinitialized window.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks This API should be called after calling app_get_preinitizlized_window().
+ * @remarks This function should be called after calling app_get_preinitizlized_window().
*
- * @return A conformant object on success,
- * otherwise @c NULL
+ * @return A conformant object on success,
+ * otherwise @c NULL
*/
void *app_get_preinitialized_conformant(void);
diff --git a/include/app_internal.h b/include/app_internal.h
index f947788..3a71441 100644
--- a/include/app_internal.h
+++ b/include/app_internal.h
@@ -39,8 +39,8 @@ typedef void *appcore_context_h;
* If enough memory is not reclaimed during low memory conditions, the system will terminate some of the applications to reclaim the memory.
*
* @since_tizen 2.3
- * @param[in] user_data The user data passed from the callback registration function
- * @see app_main()
+ * @param[in] user_data The user data passed from the callback registration function
+ * @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_low_memory_cb) (void *user_data);
@@ -52,7 +52,7 @@ typedef void (*app_low_memory_cb) (void *user_data);
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
- * @see app_main()
+ * @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_low_battery_cb) (void *user_data);
@@ -64,7 +64,7 @@ typedef void (*app_low_battery_cb) (void *user_data);
* @since_tizen 2.3
* @param[in] orientation The orientation of the device
* @param[in] user_data The user data passed from the callback registration function
- * @see app_main()
+ * @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_device_orientation_cb) (app_device_orientation_e orientation, void *user_data);
@@ -75,7 +75,7 @@ typedef void (*app_device_orientation_cb) (app_device_orientation_e orientation,
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
- * @see app_main()
+ * @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_language_changed_cb) (void *user_data);
@@ -86,7 +86,7 @@ typedef void (*app_language_changed_cb) (void *user_data);
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
- * @see app_main()
+ * @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_region_format_changed_cb) (void *user_data);
@@ -220,7 +220,7 @@ void app_efl_exit(void);
/**
* @brief Initialize the application main loop.
*
- * @details After calling this API, the application main loop doesn't run.
+ * @details After calling this function, the application main loop doesn't run.
* @since_tizen 3.0
* @param[in] argc The argument count
* @param[in] argv The argument vector