fix doxygen comments 56/63256/1 accepted/tizen/common/20160325.134920 submit/tizen/20160323.065638
authorJiwoong Im <jiwoong.im@samsung.com>
Wed, 23 Mar 2016 02:43:29 +0000 (11:43 +0900)
committerJiwoong Im <jiwoong.im@samsung.com>
Wed, 23 Mar 2016 02:44:30 +0000 (11:44 +0900)
- add modification which is misssing from last commit

Change-Id: Ic9ccf2711669c43377f94d9f48569d21c10cf152
Signed-off-by: Jiwoong Im <jiwoong.im@samsung.com>
include/app_alarm.h
include/app_common.h
include/app_control.h

index 555377b..c8e736d 100644 (file)
@@ -51,7 +51,7 @@ typedef enum {
        ALARM_ERROR_INVALID_TIME = TIZEN_ERROR_APPLICATION | 0x05,      /**< Invalid time */
        ALARM_ERROR_INVALID_DATE = TIZEN_ERROR_APPLICATION | 0x06,      /**< Invalid date */
        ALARM_ERROR_CONNECTION_FAIL = TIZEN_ERROR_APPLICATION | 0x07,   /**< The alarm service connection failed */
-       ALARM_ERROR_NOT_PERMITTED_APP = TIZEN_ERROR_APPLICATION | 0x08, /**< Application is not permitted. (Since 2.4) */
+       ALARM_ERROR_NOT_PERMITTED_APP = TIZEN_ERROR_APPLICATION | 0x08, /**< Application is not permitted. (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
        ALARM_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY,  /**< Out of memory */
        ALARM_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED   /**< Permission denied */
 } alarm_error_e;
@@ -94,14 +94,14 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data);
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
  *          If the operation of @a app_control is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
- *          Since 2.4, this api does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires.
+ *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this api does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires.
  *          If you want to trigger an alarm exactly, see @see alarm_schedule_once_after_delay()
- *          Since 2.4 If @a app_control is specified with service-application, the application is only allowed to run on which has Background Category.
- *          Since 2.4 If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
+ *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif If @a app_control is specified with service-application, the application is only allowed to run on which has Background Category.
+ *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
  *
  * @param[in] app_control The destination app_control to perform a specific task when the alarm is triggered
- * @param[in] delay    The amount of time before the first execution (in seconds). Since 2.4, Although this is inexact, the alarm will not fire before this time
- * @param[in] period The amount of time between subsequent alarms (in seconds). Since 2.4, This value does not guarantee the accuracy. The actual interval is calculated by the OS. The minimum value is 600sec
+ * @param[in] delay    The amount of time before the first execution (in seconds). Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, Although this is inexact, the alarm will not fire before this time
+ * @param[in] period The amount of time between subsequent alarms (in seconds). Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, This value does not guarantee the accuracy. The actual interval is calculated by the OS. The minimum value is 600sec
  * @param[out] alarm_id        The alarm ID that uniquely identifies an alarm
  * @return     @c 0 on success,
  *          otherwise a negative error value
@@ -121,7 +121,7 @@ int alarm_schedule_after_delay(app_control_h app_control, int delay, int period,
 
 
 /**
- * @deprecated Deprecated since 2.4. [Use alarm_schedule_once_at_date() instead]
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. [Use alarm_schedule_once_at_date() instead]
  * @brief Sets an alarm to be triggered at a specific time.
  * @details The @a date describes the time of the first occurrence.
  *          If @a period is bigger than @c 0, the alarm will be scheduled after the @a period time.
@@ -228,9 +228,9 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
  *          If the operation of @a app_control is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
- *          Since 2.4, The @a app_control only supports UI application with this api. If @a app_control is not UI application, #ALARM_ERROR_NOT_PERMITTED_APP returned.
+ *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, The @a app_control only supports UI application with this api. If @a app_control is not UI application, #ALARM_ERROR_NOT_PERMITTED_APP returned.
  *          When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs.
- *          Since 2.4, If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
+ *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
  *
  * @param[in] app_control The destination app_control to perform specific work when the alarm is triggered
  * @param[in] date     The first active alarm time
index 08f1bc7..c990e82 100644 (file)
@@ -44,7 +44,7 @@ typedef enum {
        APP_EVENT_LANGUAGE_CHANGED, /**< The system language changed event */
        APP_EVENT_DEVICE_ORIENTATION_CHANGED, /**< The device orientation changed event */
        APP_EVENT_REGION_FORMAT_CHANGED, /**< The region format changed event */
-       APP_EVENT_SUSPENDED_STATE_CHANGED, /**< The suspended state changed event of the application (since 2.4)
+       APP_EVENT_SUSPENDED_STATE_CHANGED, /**< The suspended state changed event of the application (since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
                                             @see app_event_get_suspended_state */
 } app_event_type_e;
 
@@ -126,7 +126,7 @@ typedef struct app_event_info* app_event_info_h;
  * @remarks If the given @a event_info has #APP_SUSPENDED_STATE_WILL_ENTER value,
  * the application should not call any asynchronous operations in this callback.
  * After the callback returns, process of the application will be changed to suspended
- * state immediately. Thus, asynchronous operations may work incorrectly. (since 2.4)
+ * state immediately. Thus, asynchronous operations may work incorrectly. (since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
  *
  */
 typedef void (*app_event_cb)(app_event_info_h event_info, void *user_data);
index 7402367..84d955e 100644 (file)
@@ -70,7 +70,7 @@ typedef enum {
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 typedef enum {
-       APP_CONTROL_RESULT_APP_STARTED = 1, /**< Callee application launched actually (Since 2.4) */
+       APP_CONTROL_RESULT_APP_STARTED = 1, /**< Callee application launched actually (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
        APP_CONTROL_RESULT_SUCCEEDED = 0, /**< Operation succeeded */
        APP_CONTROL_RESULT_FAILED = -1, /**< Operation failed by the callee */
        APP_CONTROL_RESULT_CANCELED = -2, /**< Operation canceled by the platform */
@@ -154,7 +154,7 @@ typedef enum {
 /**
  * @brief Definition for the app_control operation: Delivers some data to someone else.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @deprecated Deprecated since 2.4. Use #APP_CONTROL_OPERATION_SHARE instead.
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #APP_CONTROL_OPERATION_SHARE instead.
  */
 #define APP_CONTROL_OPERATION_SEND "http://tizen.org/appcontrol/operation/send"
 
@@ -162,7 +162,7 @@ typedef enum {
 /**
  * @brief Definition for the app_control operation: Delivers text data to someone else.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @deprecated Deprecated since 2.4. Use #APP_CONTROL_OPERATION_SHARE_TEXT instead.
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #APP_CONTROL_OPERATION_SHARE_TEXT instead.
  */
 #define APP_CONTROL_OPERATION_SEND_TEXT "http://tizen.org/appcontrol/operation/send_text"
 
@@ -218,8 +218,8 @@ typedef enum {
  *         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 2.4)
- * @remarks When you request this operation, you must declare this privilege. (Since 2.4)
+ * @privilege %http://tizen.org/privilege/download (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
+ * @remarks When you request this operation, you must declare this privilege. (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
  */
 #define APP_CONTROL_OPERATION_DOWNLOAD "http://tizen.org/appcontrol/operation/download"
 
@@ -382,7 +382,7 @@ typedef enum {
 /**
  * @brief Definition for app_control data: Paths of items
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since Tizen 2.4, if all added paths with this key are under the caller application's data path which can be obtained by calling app_get_data_path() function, those will be shared to the callee application. Framework will grant a temporary permission to the callee application for those files and revoke it when the callee application is terminated. Paths should be regular files. The callee application can just read them.
+ * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if all added paths with this key are under the caller application's data path which can be obtained by calling app_get_data_path() function, those will be shared to the callee application. Framework will grant a temporary permission to the callee application for those files and revoke it when the callee application is terminated. Paths should be regular files. The callee application can just read them.
  */
 #define APP_CONTROL_DATA_PATH "http://tizen.org/appcontrol/data/path"
 
@@ -481,7 +481,7 @@ typedef enum {
  * @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 2.4, if #APP_CONTROL_RESULT_APP_STARTED event is enabled,
+ * @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.
  * @see app_control_send_launch_request()
  * @see app_control_reply_to_launch_request()
@@ -606,7 +606,7 @@ int app_control_get_operation(app_control_h app_control, char **operation);
  * @brief Sets the URI of the data.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since Tizen 2.4, if the parameter 'uri' is started with 'file://' and it is a regular file in this application's data path which can be obtained by calling app_get_data_path() function, it will be shared to the callee application. Framework will grant a temporary permission to the callee application for this file and revoke it when the callee application is terminated. The callee application can just read it.
+ * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if the parameter 'uri' is started with 'file://' and it is a regular file in this application's data path which can be obtained by calling app_get_data_path() function, it will be shared to the callee application. Framework will grant a temporary permission to the callee application for this file and revoke it when the callee application is terminated. The callee application can just read it.
  * @param[in] app_control The app_control handle
  * @param[in] uri The URI of the data this app_control is operating on (if the @a uri is @c NULL, it clears the previous value)
  * @return @c 0 on success,
@@ -913,7 +913,7 @@ int app_control_foreach_app_matched(app_control_h app_control, app_control_app_m
  * @privlevel  public
  * @privilege  %http://tizen.org/privilege/appmanager.launch
  * @remarks The function returns #APP_CONTROL_ERROR_LAUNCH_REJECTED if the operation value is #APP_CONTROL_OPERATION_LAUNCH_ON_EVENT which is only for handling the event from the platform or other application, refer to @a Event module.
- * @remarks Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. Also, implicit launch requests are NOT delivered to service applications since 2.4. To launch a service application, an explicit launch request with application ID given by app_control_set_app_id() MUST be sent.
+ * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, the launch request of the service application over out of packages is restricted by the platform. Also, implicit launch requests are NOT delivered to service applications since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. To launch a service application, an explicit launch request with application ID given by app_control_set_app_id() MUST be sent.
  * @param[in] app_control The app_control handle
  * @param[in] callback The callback function to be called when the reply is delivered
  * @param[in] user_data The user data to be passed to the callback function
@@ -938,7 +938,7 @@ int app_control_send_launch_request(app_control_h app_control, app_control_reply
 /**
  * @brief Sends the terminate request to the application that is launched by app_control. This API is only effective for some applications that are provided by default for handling platform default app_controls. You are not allowed to terminate other general applications using this API.
  *
- * @remarks Since Tizen 2.4, this API can be used to terminate sub-applications which were launched as group mode by caller application.
+ * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this API can be used to terminate sub-applications which were launched as group mode by caller application.
  *          Once callee application is being terminated by this API, other applications which were launched by callee application as group mode will be terminated as well.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif