Fix API description

[platform/core/api/application.git] / include / app_control.h

diff --git a/include/app_control.h b/include/app_control.h
index 31be55d..5b6443b 100644 (file)
--- a/include/app_control.h
+++ b/include/app_control.h
@@ -66,8 +66,8 @@ typedef enum {
 
 /**
  * @brief Enumeration for App Control Result.
- * @see app_control_enable_app_started_result_event()
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @see app_control_enable_app_started_result_event()
  */
 typedef enum {
        APP_CONTROL_RESULT_APP_STARTED = 1, /**< Callee application launched actually (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
@@ -76,6 +76,7 @@ typedef enum {
        APP_CONTROL_RESULT_CANCELED = -2, /**< Operation canceled by the platform */
 } app_control_result_e;
 
+
 /**
  * @brief Enumeration for App Control Launch Mode.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -85,6 +86,7 @@ typedef enum {
        APP_CONTROL_LAUNCH_MODE_GROUP, /**< Prefer to launch an application as group mode */
 } app_control_launch_mode_e;
 
+
 /**
  * @brief Definition for the app_control operation: An explicit launch for a homescreen application.
  * @details Input: Nothing\n
@@ -106,7 +108,7 @@ typedef enum {
 /**
  * @brief Definition for the app_control operation: Provides an editable access to the given data.
  * @details Input: It depends on application scenario/configuration.\n
- *         Output: It depends on application scenario/configuration.\n
+ *             Output: It depends on application scenario/configuration.\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_OPERATION_EDIT "http://tizen.org/appcontrol/operation/edit"
@@ -115,16 +117,16 @@ typedef enum {
 /**
  * @brief Definition for the app_control operation: Displays the data.
  * @details Input: URI is usually used to inform the path to show. In some cases, some other data in Extra can be used (e.g., VIEW operation for viewing Contact, Calendar data).\n
- *         Output: Nothing\n
+ *             Output: Nothing\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_OPERATION_VIEW "http://tizen.org/appcontrol/operation/view"
 
 
 /**
- * @brief Definition for the app_control operation: Picks items.
+ * @brief Definition for the app_control operation: Picks item.
  * @details Input: It depends on application scenario/configuration.\n
- *         Output: APP_CONTROL_DATA_SELECTED in Extra\n
+ *                     Output: APP_CONTROL_DATA_SELECTED in Extra\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_OPERATION_PICK "http://tizen.org/appcontrol/operation/pick"
@@ -133,7 +135,7 @@ typedef enum {
 /**
  * @brief Definition for the app_control operation: Creates contents.
  * @details Input: It depends on application scenario/configuration.\n
- *         Output: APP_CONTROL_DATA_SELECTED in Extra\n
+ *             Output: APP_CONTROL_DATA_SELECTED in Extra\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_OPERATION_CREATE_CONTENT "http://tizen.org/appcontrol/operation/create_content"
@@ -141,7 +143,7 @@ typedef enum {
 
 /**
  * @brief Definition for the app_control operation: Performs a call to someone.
- * @details Input: URI is the number to be dialed. This is mandatory field.\n
+ * @details Input: URI is the number to be dialed. This is a mandatory field.\n
  *          Output: Nothing\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
@@ -213,9 +215,9 @@ typedef enum {
 
 
 /**
- * @brief Definition for the app_control operation: Downloads items.
+ * @brief Definition for the app_control operation: Downloads item.
  * @details Input: It depends on application scenario/configuration.\n
- *         Output: It depends on application scenario/configuration.\n
+ *             Output: It depends on application scenario/configuration.\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/download (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
@@ -225,13 +227,14 @@ typedef enum {
 
 
 /**
- * @brief Definition for the app_control operation: Prints contents.
+ * @brief Definition for the app_control operation: Prints content.
  * @details Input: It depends on application scenario/configuration.\n
- *         Output: It depends on application scenario/configuration.\n
+ *             Output: It depends on application scenario/configuration.\n
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_OPERATION_PRINT "http://tizen.org/appcontrol/operation/print"
 
+
 /**
  * @brief Definition for the app_control operation: Composes a message.
  * @details Input: It depends on application scenario/configuration.\n
@@ -240,16 +243,18 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_COMPOSE "http://tizen.org/appcontrol/operation/compose"
 
+
 /**
  * @brief Definition for the app_control operation: Can be launched by interested System-Event.
  * @details Input : URI and extras data defined in Event module.\n
  *          Output: Nothing\n
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks This operation is for handling event from the platform. This operation can not be requested via app_control_send_launch_request().
+ * @remarks This operation is for handling event from the platform. This operation cannot be requested through app_control_send_launch_request().
  * @remarks Refer to Launch-On-Event section of Event module.
  */
 #define APP_CONTROL_OPERATION_LAUNCH_ON_EVENT "http://tizen.org/appcontrol/operation/launch_on_event"
 
+
 /**
  * @brief Definition for the app_control operation: Adds an item.
  * @details Input: It depends on application scenario/configuration.\n
@@ -258,6 +263,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_ADD "http://tizen.org/appcontrol/operation/add"
 
+
 /**
  * @brief Definition for the app_control operation: Captures images by camera applications.
  * @details Input: Nothing\n
@@ -266,14 +272,16 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_IMAGE_CAPTURE "http://tizen.org/appcontrol/operation/image_capture"
 
+
 /**
  * @brief Definition for the app_control operation: Captures videos by camera applications.
  * @details Input: Nothing\n
- *         Output: APP_CONTROL_DATA_SELECTED in Extra\n
+ *             Output: APP_CONTROL_DATA_SELECTED in Extra\n
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 #define APP_CONTROL_OPERATION_VIDEO_CAPTURE "http://tizen.org/appcontrol/operation/video_capture"
 
+
 /**
  * @brief Definition for the app_control operation: Shows settings to enable Bluetooth.
  * @details Input: Nothing\n
@@ -282,6 +290,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING_BT_ENABLE "http://tizen.org/appcontrol/operation/setting/bt_enable"
 
+
 /**
  * @brief Definition for the app_control operation: Shows settings to configure Bluetooth visibility.
  * @details Input: Nothing\n
@@ -290,6 +299,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING_BT_VISIBILITY "http://tizen.org/appcontrol/operation/setting/bt_visibility"
 
+
 /**
  * @brief Definition for the app_control operation: Shows settings to allow configuration of current location sources.
  * @details Input: Nothing\n
@@ -298,6 +308,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING_LOCATION "http://tizen.org/appcontrol/operation/setting/location"
 
+
 /**
  * @brief Definition for the app_control operation: Shows NFC settings.
  * @details Input: APP_CONTROL_DATA_TYPE in Extra (Since 3.0).\n
@@ -307,6 +318,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING_NFC "http://tizen.org/appcontrol/operation/setting/nfc"
 
+
 /**
  * @brief Definition for the app_control operation: Shows system settings.
  * @details Input: Nothing\n
@@ -315,6 +327,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING "http://tizen.org/appcontrol/operation/setting"
 
+
 /**
  * @brief Definition for the app_control operation: Shows settings to allow configuration of Wi-Fi.
  * @details Input: Nothing\n
@@ -323,6 +336,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING_WIFI "http://tizen.org/appcontrol/operation/setting/wifi"
 
+
 /**
  * @brief Definition for the app control operation: Shows VPN service settings.
  * @details Input: Nothing\n
@@ -331,6 +345,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_SETTING_VPN "http://tizen.org/appcontrol/operation/setting/vpn"
 
+
 /**
  * @brief Definition for the app control operation: Select the type of input method to receive input from user.
  * @details Input: It depends on application scenario/configuration.\n
@@ -339,6 +354,7 @@ typedef enum {
  */
 #define APP_CONTROL_OPERATION_GET_INPUT "http://tizen.org/appcontrol/operation/get_input"
 
+
 /**
  * @brief Definition for app_control data: Subject
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -354,14 +370,14 @@ typedef enum {
 
 
 /**
- * @brief Definition for app_control data: E-mail addresses that should be carbon copied
+ * @brief Definition for app_control data: E-mail addresses that should be carbon copied.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_DATA_CC "http://tizen.org/appcontrol/data/cc"
 
 
 /**
- * @brief Definition for app_control data: E-mail addresses that should be blind carbon copied
+ * @brief Definition for app_control data: E-mail addresses that should be blind carbon copied.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_DATA_BCC "http://tizen.org/appcontrol/data/bcc"
@@ -398,7 +414,7 @@ typedef enum {
 
 
 /**
- * @brief Definition for app_control data: Selection mode. ("single" or "multiple")
+ * @brief Definition for app_control data: Selection mode ("single" or "multiple")
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 #define APP_CONTROL_DATA_SELECTION_MODE "http://tizen.org/appcontrol/data/selection_mode"
@@ -473,20 +489,23 @@ typedef enum {
  */
 #define APP_CONTROL_DATA_TOTAL_SIZE "http://tizen.org/appcontrol/data/total_size"
 
+
 /**
  * @brief Definition for app_control data: Name
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 #define APP_CONTROL_DATA_NAME "http://tizen.org/appcontrol/data/name"
 
+
 /**
  * @brief Definition for app_control data: Location
  * @since_tizen 3.0
  */
 #define APP_CONTROL_DATA_LOCATION "http://tizen.org/appcontrol/data/location"
 
+
 /**
- * @brief Definition for app_control data: Select the type of input method
+ * @brief Definition for app_control data: Select the type of input method.
  * @details Type: "input_voice"       Launch input method with voice type.
  *                "input_emoticon"    Launch input method with emoticon type.
  *                "input_keyboard"    Launch input method with keyboard type.
@@ -494,38 +513,40 @@ typedef enum {
  */
 #define APP_CONTROL_DATA_INPUT_TYPE "http://tizen.org/appcontrol/data/input_type"
 
+
 /**
- * @brief Definition for app_control data: Send the pre inputted text such as "http://" in web
+ * @brief Definition for app_control data: Send the pre input text such as "http://" in web.
  * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
  */
 #define APP_CONTROL_DATA_INPUT_DEFAULT_TEXT "http://tizen.org/appcontrol/data/input_default_text"
 
+
 /**
- * @brief Definition for app_control data: Send guide text to show to user such as "Input user name"
+ * @brief Definition for app_control data: Send guide text to show the user such as "Input user name".
  * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
  */
 #define APP_CONTROL_DATA_INPUT_GUIDE_TEXT "http://tizen.org/appcontrol/data/input_guide_text"
 
+
 /**
- * @brief Definition for app_control data: Send text to receive answer result from smart reply
+ * @brief Definition for app_control data: Send text to receive the result from smart reply.
  * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
  */
 #define APP_CONTROL_DATA_INPUT_PREDICTION_HINT "http://tizen.org/appcontrol/data/input_prediction_hint"
 
+
 /**
  * @brief Called when the reply of the launch request is delivered.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
  * @remarks The @a request and @a reply must not be deallocated by the application.
- *
  * @param[in] request The app_control handle of the launch request that has been sent
  * @param[in] reply The app_control handle in which the results of the callee are contained
  * @param[in] result The result code of the launch request
  * @param[in] user_data        The user data passed from the callback registration function
  * @pre When the callee replies to the launch request, this callback will be invoked.
  * @pre Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if #APP_CONTROL_RESULT_APP_STARTED event is enabled,
- *      this callback also will be invoked when the callee app actually launched.
+ *            this callback will also be invoked when the callee app actually launched.
  * @see app_control_send_launch_request()
  * @see app_control_reply_to_launch_request()
  * @see app_control_enable_app_started_result_event()
@@ -538,9 +559,7 @@ typedef void (*app_control_reply_cb) (app_control_h request, app_control_h reply
  * @brief Called to retrieve the extra data contained in the app_control.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
  * @remarks The @a key must not be deallocated by the application.
- *
  * @param[in] app_control  The app_control handle
  * @param[in] key The key of the value contained in the app_control
  * @param[in] user_data The user data passed from the foreach function
@@ -1080,7 +1099,6 @@ int app_control_is_reply_requested(app_control_h app_control, bool *requested);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] app_control The app_control handle
  * @param[in] mode The launch mode of app
- *
  * @return 0 on success, otherwise a negative error value
  * @retval #APP_CONTROL_ERROR_NONE Successful
  * @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
@@ -1098,7 +1116,6 @@ int app_control_set_launch_mode(app_control_h app_control,
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] app_control The app_control handle
  * @param[out] mode The launch mode of app
- *
  * @return 0 on success, otherwise a negative error value
  * @retval #APP_CONTROL_ERROR_NONE Successful
  * @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter