Remove conditional statements for Moible/Wearable profile 78/306078/1
authorChanggyu Choi <changyu.choi@samsung.com>
Fri, 16 Feb 2024 04:56:31 +0000 (13:56 +0900)
committerChanggyu Choi <changyu.choi@samsung.com>
Fri, 16 Feb 2024 04:56:31 +0000 (13:56 +0900)
Change-Id: I23fdcb60dc6290eba38a4800b18e3f672bbc7c29
Signed-off-by: Changgyu Choi <changyu.choi@samsung.com>
doc/appfw_alarm_doc.h
include/app_alarm.h

index e3a1f18..d2996c0 100755 (executable)
@@ -53,7 +53,7 @@
  * </tr>
  * <tr>
  * <td>alarm_schedule_after_delay()</td>
- * <td>Sets an alarm to be triggered after specific time(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.)</td>
+ * <td>Sets an alarm to be triggered after specific time(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.)</td>
  * </tr>
  * </table>
  * \n
index 05eab66..772e43d 100644 (file)
@@ -38,13 +38,13 @@ extern "C" {
 
 /**
  * @brief Definition to app_control extra data : the ID of the alarm registered.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 #define APP_CONTROL_DATA_ALARM_ID "http://tizen.org/appcontrol/data/alarm_id"
 
 /**
  * @brief Enumeration for Alarm Error.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        ALARM_ERROR_NONE = TIZEN_ERROR_NONE,    /**< Successful */
@@ -52,7 +52,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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
+       ALARM_ERROR_NOT_PERMITTED_APP = TIZEN_ERROR_APPLICATION | 0x08, /**< Application is not permitted. (Since 2.4) */
        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;
@@ -60,7 +60,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for Alarm Week Flag, the days of the week.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum {
        ALARM_WEEK_FLAG_SUNDAY = 0x01,  /**< Sunday */
@@ -87,7 +87,7 @@ typedef enum {
 /**
  * @brief Called once for each scheduled alarm to get the alarm ID.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] alarm_id The alarm ID returned when the alarm is scheduled
  * @param[in] user_data The user data passed from the foreach function
  * @return @c true to continue with the next iteration of the loop,
@@ -101,23 +101,23 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data);
 /**
  * @brief Sets an alarm to be triggered after a specific time.
  * @details The alarm will first go off @a delay seconds later and then will go off every certain amount of time defined using @a period seconds. To cancel the alarm, call alarm_cancel() with @a alarm_id.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @privilege %http://tizen.org/privilege/appmanager.launch
  * @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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this function does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires.
+ *          Since 2.4, this function 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 @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 function is not allowed. In other words, the explicit @a app_control is only allowed.
+ *          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 function is not allowed. In other words, the explicit @a app_control is only allowed.
  *          Since 4.0, %http://tizen.org/privilege/appmanager.launch privilege is additionally required.
  *          Since 6.0, You can use #alarm_standard_interval_e for @a period. If you use it, the period of alarm is guaranteed.
  *
  * @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 @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.
+ * @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.
  *            Since 6.0 this can be one of the values of #alarm_standard_interval_e. If you uses raw integer value, the value will be phase-aligned with other period of alarm.
 
  * @param[out] alarm_id The alarm ID that uniquely identifies an alarm
@@ -139,13 +139,13 @@ int alarm_schedule_after_delay(app_control_h app_control, int delay, int period,
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. [Use alarm_schedule_once_at_date() instead]
+ * @deprecated Deprecated since 2.4. [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.
  *          If @a period is set to @c 0, the alarm will go off just once without repetition.
  *          To cancel the alarm, call alarm_cancel() with @a alarm_id.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @remarks If application is uninstalled after setting an alarm, the alarm is cancelled automatically.
@@ -173,7 +173,7 @@ int alarm_schedule_at_date(app_control_h app_control, struct tm *date, int perio
 /**
  * @brief Sets an alarm to be triggered after a specific time.
  * @details The alarm will go off @a delay seconds later. To cancel the alarm, call alarm_cancel() with @a alarm_id.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @privilege %http://tizen.org/privilege/appmanager.launch
@@ -206,7 +206,7 @@ int alarm_schedule_once_after_delay(app_control_h app_control, int delay, int *a
 /**
  * @brief Sets an alarm to be triggered at a specific time.
  * @details The @a date describes the time of the first occurrence. To cancel the alarm, call alarm_cancel() with @a alarm_id.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @privilege %http://tizen.org/privilege/appmanager.launch
@@ -242,16 +242,16 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int
  *          @a week_flag is the repeat value of the days of the week.
  *          If @a week_flag is #ALARM_WEEK_FLAG_TUESDAY, the alarm will repeat every Tuesday at a specific time.
  *          To cancel the alarm, call alarm_cancel() with @a alarm_id.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @privilege %http://tizen.org/privilege/appmanager.launch
  * @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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, The @a app_control only supports UI application with this function. If @a app_control is not UI application, #ALARM_ERROR_NOT_PERMITTED_APP returned.
+ *          Since 2.4, The @a app_control only supports UI application with this function. 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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed.
+ *          Since 2.4, If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed.
  *          Since 4.0, %http://tizen.org/privilege/appmanager.launch privilege is additionally required.
  *
  * @param[in] app_control The destination app_control to perform specific work when the alarm is triggered
@@ -277,7 +277,7 @@ int alarm_schedule_with_recurrence_week_flag(app_control_h app_control, struct t
 
 /**
  * @brief Gets the recurrence days of the week.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks If the given @a alarm_id is not obtained by using the alarm_schedule_with_recurrence_week_flag() function,
@@ -297,7 +297,7 @@ int alarm_get_scheduled_recurrence_week_flag(int alarm_id, int *week_flag);
 
 /**
  * @brief Cancels the alarm with the specific alarm ID.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @param[in] alarm_id The alarm ID that is cancelled
@@ -317,7 +317,7 @@ int alarm_cancel(int alarm_id);
 
 /**
  * @brief Cancels all scheduled alarms that are registered by the application that calls this function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @return @c 0 on success,
@@ -335,7 +335,7 @@ int alarm_cancel_all(void);
 
 /**
  * @brief Retrieves the IDs of all registered alarms by invoking a callback once for each scheduled alarm.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.get
  * @param[in] callback The callback function to invoke
@@ -354,7 +354,7 @@ int alarm_foreach_registered_alarm(alarm_registered_alarm_cb callback, void *use
 
 /**
  * @brief Gets the scheduled time from the given alarm ID in C standard time struct.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks @a date is not needed by the function after the call.
@@ -375,7 +375,7 @@ int alarm_get_scheduled_date(int alarm_id, struct tm *date);
 
 /**
  * @brief Gets the period of time between the recurrent alarms.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks If the given @a alarm_id is not obtained by using the alarm_schedule_once_at_date() or alarm_schedule_after_delay() function,
@@ -397,7 +397,7 @@ int alarm_get_scheduled_period(int alarm_id, int *period);
 
 /**
  * @brief Gets the current system time using C standard time struct.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[out] date The current system time
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -409,7 +409,7 @@ int alarm_get_current_time(struct tm *date);
 
 /**
  * @brief Gets the app_control to be invoked when the alarm is triggered.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks The @a app_control must be released using app_control_destroy().
@@ -683,7 +683,7 @@ int alarm_update_date(int alarm_id, struct tm *date);
  * @privilege %http://tizen.org/privilege/alarm.set
  * @param[in] alarm_id  The ID which uniquely identifies the scheduled alarm
  * @param[in] period    The amount of time between subsequent alarms (in seconds).
- *                      Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this
+ *                      Since 2.4, this
  *                      value does not guarantee the accuracy. The actual interval
  *                      is calculated by the OS. The minimum value is 600sec.
  * @return @c 0 on success,