summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHwankyu Jhun <h.jhun@samsung.com>2016-12-16 13:31:10 +0900
committerHwankyu Jhun <h.jhun@samsung.com>2016-12-16 15:12:50 +0900
commita1f571e6c872cca3f57cd69c8bc93dcb826c5955 (patch)
tree945044f6f9de82de061b5a8e783f33c7075b48e9
parentbd152e3db5814f76ceb0d873be2fc44d8137f79e (diff)
downloadappcore-agent-tizen_3.0_tv.tar.gz
appcore-agent-tizen_3.0_tv.tar.bz2
appcore-agent-tizen_3.0_tv.zip
Change-Id: I63d7314f7d189fd3120bf88283d47e31dd871411 Signed-off-by: Hwankyu Jhun <h.jhun@samsung.com>
-rw-r--r--doc/appcore-agent_doc.h12
-rw-r--r--include/service_app.h36
2 files changed, 11 insertions, 37 deletions
diff --git a/doc/appcore-agent_doc.h b/doc/appcore-agent_doc.h
index ff0d957..44875eb 100644
--- a/doc/appcore-agent_doc.h
+++ b/doc/appcore-agent_doc.h
@@ -19,19 +19,15 @@
*/
/**
- *
* @ingroup CAPI_APPLICATION_FRAMEWORK
* @defgroup CAPI_SERVICE_APP_MODULE Service Application
* @brief Launches or exits serviceApp.
- *
* @section CAPI_SERVICE_APP_MODULE_HEADER Required Header
- * \#include <service_app.h>
+ * \#include <service_app.h>
* @section CAPI_SERVICE_APP_MODULE_OVERVIEW Overview
* The @ref CAPI_SERVICE_APP_MODULE API provides functions for handling Tizen service application state changes or system events.
- *
* This API provides interfaces for the following three categories:
- * - Starting or exiting the main event loop
- * - Registering callbacks for application state change events
- * - Registering callbacks for basic system events
- *
+ * - Starting or exiting the main event loop.
+ * - Registering callbacks for application state change events.
+ * - Registering callbacks for basic system events.
*/
diff --git a/include/service_app.h b/include/service_app.h
index 55ed3d7..2cea3ee 100644
--- a/include/service_app.h
+++ b/include/service_app.h
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-
#ifndef __TIZEN_APPFW_SERVICE_APP_H__
#define __TIZEN_APPFW_SERVICE_APP_H__
@@ -31,12 +30,9 @@ extern "C" {
* @{
*/
-
/**
* @brief Called at the start of the agent application.
- *
* @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
* @return @c true on success,
* otherwise @c false
@@ -49,9 +45,7 @@ typedef bool (*service_app_create_cb) (void *user_data);
/**
* @brief Called once after the main loop of the agent application exits.
- *
* @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 service_app_main()
* @see #service_app_lifecycle_callback_s
@@ -61,9 +55,7 @@ typedef void (*service_app_terminate_cb) (void *user_data);
/**
* @brief Called when another application sends the launch request to the agent application.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] app_control The handle to the app_control
* @param[in] user_data The user data passed from the callback registration function
* @see service_app_main()
@@ -76,9 +68,7 @@ typedef void (*service_app_control_cb) (app_control_h app_control, void *user_da
/**
* @brief The structure type containing the set of callback functions for handling application events.
* @details It is one of the input parameters of the service_app_efl_main() function.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @see service_app_main()
* @see service_app_create_cb()
* @see service_app_terminate_cb()
@@ -93,19 +83,17 @@ typedef struct {
/**
* @brief Adds the system event handler
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The service application can handle low memory event, low battery event, language setting changed event and region format changed event.
* @param[out] handler The event handler
* @param[in] event_type The system event type
* @param[in] callback The callback function
* @param[in] user_data The user data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
- * @retval #APP_ERROR_NONE Successfull
+ * @return @c 0 on success,
+ * 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 service_app_remove_event_handler
@@ -115,14 +103,12 @@ int service_app_add_event_handler(app_event_handler_h *handler, app_event_type_e
/**
* @brief Removes registered event handler
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] event_handler The event handler
- *
- * @return 0 on success, otherwise a negative error value
- * @retval #APP_ERROR_NONE Successfull
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
- *
* @see service_app_add_event_handler
*/
int service_app_remove_event_handler(app_event_handler_h event_handler);
@@ -130,24 +116,19 @@ int service_app_remove_event_handler(app_event_handler_h event_handler);
/**
* @brief Runs the main loop of the application until service_app_exit() is called.
- *
* @details This function is the main entry point of the Tizen service application.
* This main loop supports event handling for the GMainLoop and the Ecore Main Loop.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] argc The argument count
* @param[in] argv The argument vector
* @param[in] callback The set of callback functions to handle application 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.
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system.
+ * @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system.
* @retval #APP_ERROR_ALREADY_RUNNING The main loop has already started
- *
* @see service_app_create_cb()
* @see service_app_terminate_cb()
* @see service_app_control_cb()
@@ -159,11 +140,8 @@ int service_app_main(int argc, char **argv, service_app_lifecycle_callback_s *ca
/**
* @brief Exits the main loop of the application.
- *
* @details The main loop of the application stops and service_app_terminate_cb() is invoked.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @see service_app_main()
* @see service_app_terminate_cb()
*/