Fix API description

- modify API description and add appfw_alarm_doc.h

Change-Id: I12a1ab53ae5cdfb9d36737276d718760a332fce6
Signed-off-by: Jiwoong Im <jiwoong.im@samsung.com>

diff --git a/doc/appfw_alarm_doc.h b/doc/appfw_alarm_doc.h
new file mode 100755 (executable)
index 0000000..e3a1f18
--- /dev/null
+++ b/doc/appfw_alarm_doc.h
@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2011 - 2016 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+#ifndef __TIZEN_APPFW_ALARM_DOC_H__
+#define __TIZEN_APPFW_ALARM_DOC_H__
+
+ /**
+ * @ingroup CAPI_APPLICATION_MODULE
+ * @defgroup CAPI_ALARM_MODULE Alarm
+ * @brief The @ref CAPI_ALARM_MODULE API allows setting an "alarm clock" for the delivery of a notification at some point in the future.
+ * @section CAPI_ALARM_MODULE_HEADER Required Header
+ *   \#include <app_alarm.h>
+ *
+ * @section CAPI_ALARM_MODULE_OVERVIEW Overview
+ * Mobile devices typically give constant access to information from various sources. Some of this information is best delivered
+ * through alarms - the most obvious case is a calendar scheduling application which lets you know when a meeting is about to start.
+ * Alarms are certainly better than actively waiting in a loop. They are also better than putting an interface to sleep because they do not
+ * block your main UI thread. Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks.
+ * If an application is installed after setting the alarm, your alarm is canceled automatically.\n
+ * When the alarm is expired, Alarm Manager will turn on the LCD to prohibit background jobs.
+ * If you want to use alarm API without turning on the LCD, you can use alarm_schedule_after_delay().
+ * There are 3 ways to set an alarm.
+ * <table>
+ * <tr>
+ * <th>FUNCTION</th>
+ * <th>DESCRIPTION</th>
+ * </tr>
+ * <tr>
+ * <td>alarm_schedule_once_after_delay()</td>
+ * <td>Sets an alarm to be triggered at specific time once</td>
+ * </tr>
+ * <tr>
+ * <td>alarm_schedule_once_at_date()</td>
+ * <td>Sets an alarm to be triggered after specific delay once</td>
+ * </tr>
+ * <tr>
+ * <td>alarm_schedule_with_recurrence_week_flag()</td>
+ * <td>Sets an alarm to be triggered at specific time with recurrent days of the week(can repeat on days of the week)</td>
+ * </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>
+ * </tr>
+ * </table>
+ * \n
+ */
+
+#endif /* __TIZEN_APPFW_ALARM_DOC_H__ */
+

diff --git a/include/app_alarm.h b/include/app_alarm.h
index 7b81a05..ff79f62 100644 (file)
--- a/include/app_alarm.h
+++ b/include/app_alarm.h
@@ -72,26 +72,27 @@ typedef enum {
        ALARM_WEEK_FLAG_SATURDAY = 0x40 /**< Saturday */
 } alarm_week_flag_e;
 
+
 /**
  * @brief Called once for each scheduled alarm to get the alarm ID.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @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
+ * @param[in] user_data The user data passed from the foreach function
  * @return @c true to continue with the next iteration of the loop,
  *         otherwise @c false to break out of the loop
- * @pre        alarm_foreach_registered_alarm() will invoke this callback to get all the registered alarm IDs.
- * @see        alarm_foreach_registered_alarm()
+ * @pre   alarm_foreach_registered_alarm() will invoke this callback to get all the registered alarm IDs.
+ * @see   alarm_foreach_registered_alarm()
  */
 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.
+ * @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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
  * @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.
@@ -101,17 +102,17 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data);
  *          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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, Although this is inexact, the alarm will not fire before this time
+ * @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
- * @retval  #ALARM_ERROR_NONE Successful
- * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval  #ALARM_ERROR_INVALID_TIME Triggered time is invalid
- * @retval  #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
- * @retval  #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted
+ * @param[out] alarm_id The alarm ID that uniquely identifies an alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #ALARM_ERROR_NONE Successful
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid
+ * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted
  * @see alarm_cancel()
  * @see alarm_cancel_all()
  * @see alarm_get_scheduled_date()
@@ -129,23 +130,23 @@ int alarm_schedule_after_delay(app_control_h app_control, int delay, int period,
  *          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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
  * @remarks If 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.
  *
- * @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
- * @param[in]  period  The amount of time between subsequent alarms(in second)
- * @param[out] alarm_id        The alarm ID that uniquely identifies an alarm
- * @return     @c 0 on success,
- *          otherwise a negative error value
- * @retval  #ALARM_ERROR_NONE   Successful
- * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval  #ALARM_ERROR_INVALID_DATE Triggered date is invalid
- * @retval  #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @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
+ * @param[in] period The amount of time between subsequent alarms(in second)
+ * @param[out] alarm_id The alarm ID that uniquely identifies an alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #ALARM_ERROR_NONE Successful
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid
+ * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  * @see alarm_cancel()
  * @see alarm_cancel_all()
  * @see alarm_get_scheduled_date()
@@ -155,11 +156,10 @@ 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.
+ * @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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
  * @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.
@@ -168,16 +168,16 @@ int alarm_schedule_at_date(app_control_h app_control, struct tm *date, int perio
  *          When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs.
  *
  * @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 execution (in seconds)
- * @param[out] alarm_id        The alarm ID that uniquely identifies an alarm
- * @return     @c 0 on success,
- *          otherwise a negative error value
- * @retval  #ALARM_ERROR_NONE Successful
- * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval  #ALARM_ERROR_INVALID_TIME Triggered time is invalid
- * @retval  #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
- * @retval  #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted.
+ * @param[in] delay The amount of time before the execution (in seconds)
+ * @param[out] alarm_id The alarm ID that uniquely identifies an alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #ALARM_ERROR_NONE Successful
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid
+ * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted.
  * @see alarm_cancel()
  * @see alarm_cancel_all()
  * @see alarm_get_scheduled_date()
@@ -187,11 +187,10 @@ 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.
+ * @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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
  * @remarks If 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.
@@ -199,17 +198,17 @@ int alarm_schedule_once_after_delay(app_control_h app_control, int delay, int *a
  *          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.
  *
- * @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
- * @param[out] alarm_id        The alarm ID that uniquely identifies an alarm
- * @return     @c 0 on success,
- *          otherwise a negative error value
- * @retval  #ALARM_ERROR_NONE   Successful
- * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval  #ALARM_ERROR_INVALID_DATE Triggered date is invalid
- * @retval  #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
- * @retval  #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted.
+ * @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
+ * @param[out] alarm_id The alarm ID that uniquely identifies an alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #ALARM_ERROR_NONE   Successful
+ * @retval #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
+ * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid
+ * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted.
  * @see alarm_cancel()
  * @see alarm_cancel_all()
  * @see alarm_get_scheduled_date()
@@ -220,12 +219,12 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int
 /**
  * @brief Sets an alarm to be triggered periodically, starting at a specific time.
  * @details The @a date describes the time of the first occurrence.
- *              @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.
+ *          @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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
  * @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.
@@ -234,9 +233,9 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int
  *          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
- * @param[in] week_flag        The day of the week, @a week_flag may be a combination of days, like #ALARM_WEEK_FLAG_TUESDAY | #ALARM_WEEK_FLAG_FRIDAY
- * @param[out] alarm_id        The alarm ID that uniquely identifies an alarm
+ * @param[in] date The first active alarm time
+ * @param[in] week_flag The day of the week, @a week_flag may be a combination of days, like #ALARM_WEEK_FLAG_TUESDAY | #ALARM_WEEK_FLAG_FRIDAY
+ * @param[out] alarm_id The alarm ID that uniquely identifies an alarm
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #ALARM_ERROR_NONE Successful
@@ -249,7 +248,7 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int
  * @see alarm_cancel_all()
  * @see alarm_get_scheduled_recurrence_week_flag()
  * @see alarm_get_scheduled_date()
- * @see        #alarm_week_flag_e
+ * @see #alarm_week_flag_e
  */
 int alarm_schedule_with_recurrence_week_flag(app_control_h app_control, struct tm *date, int week_flag, int *alarm_id);
 
@@ -257,8 +256,8 @@ 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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.get
+ * @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,
  *          an error (error code #ALARM_ERROR_INVALID_PARAMETER) will occur because this alarm is scheduled with no recurrence.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
@@ -271,7 +270,7 @@ int alarm_schedule_with_recurrence_week_flag(app_control_h app_control, struct t
  * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  * @see alarm_schedule_with_recurrence_week_flag()
- * @see        #alarm_week_flag_e
+ * @see #alarm_week_flag_e
  */
 int alarm_get_scheduled_recurrence_week_flag(int alarm_id, int *week_flag);
 
@@ -279,15 +278,15 @@ 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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
- * @param[in] alarm_id  The alarm ID that is cancelled
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
+ * @param[in] alarm_id The alarm ID that is cancelled
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #ALARM_ERROR_NONE Successful
- * @retval #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  * @see alarm_schedule_at_date()
  * @see alarm_schedule_after_delay()
  * @see alarm_schedule_with_recurrence_week_flag()
@@ -299,13 +298,13 @@ int alarm_cancel(int alarm_id);
 /**
  * @brief Cancels all scheduled alarms that are registered by the application that calls this API.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @privlevel   public
- * @privilege   %http://tizen.org/privilege/alarm.set
- * @return  @c 0 on success,
- *          otherwise a negative error value
- * @retval  #ALARM_ERROR_NONE Successful
- * @retval  #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #ALARM_ERROR_NONE Successful
+ * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  * @see alarm_schedule_at_date()
  * @see alarm_schedule_after_delay()
  * @see alarm_schedule_with_recurrence_week_flag()
@@ -317,17 +316,17 @@ 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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.get
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.get
  * @param[in] callback The callback function to invoke
- * @param[in] user_data        The user data to be passed to the callback function
+ * @param[in] user_data The user data to be passed to the callback function
  * @return @c 0 on success,
  *         otherwise a negative error value
- * @retval #ALARM_ERROR_NONE   Successful
- * @retval #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
+ * @retval #ALARM_ERROR_NONE Successful
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
- * @post   This function invokes alarm_registered_alarm_cb() repeatedly for each registered alarm.
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @post This function invokes alarm_registered_alarm_cb() repeatedly for each registered alarm.
  * @see alarm_registered_alarm_cb()
  */
 int alarm_foreach_registered_alarm(alarm_registered_alarm_cb callback, void *user_data);
@@ -336,18 +335,18 @@ 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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.get
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.get
  * @param[in] alarm_id The alarm ID returned when the alarm is scheduled
- * @param[out] date    The time value of the next alarm event
+ * @param[out] date The time value of the next alarm event
  * @return @c 0 on success,
  *         otherwise a negative error value
- * @retval #ALARM_ERROR_NONE   Successful
- * @retval #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
+ * @retval #ALARM_ERROR_NONE Successful
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  * @see alarm_schedule_at_date()
- * @see        alarm_schedule_after_delay()
+ * @see alarm_schedule_after_delay()
  * @see alarm_schedule_with_recurrence_week_flag()
  */
 int alarm_get_scheduled_date(int alarm_id, struct tm *date);
@@ -356,20 +355,20 @@ 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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.get
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks If the given @a alarm_id is not obtained by using the alarm_schedule_at_date() or alarm_schedule_after_delay() function,
  *          an error (error code #ALARM_ERROR_INVALID_PARAMETER) will occur.
  * @param[in] alarm_id The alarm ID returned when the alarm is scheduled
  * @param[out] period The period of time between recurrent alarms in seconds
  * @return @c 0 on success,
  *         otherwise a negative error value
- * @retval #ALARM_ERROR_NONE   Successful
+ * @retval #ALARM_ERROR_NONE Successful
  * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  * @see alarm_schedule_at_date()
- * @see        alarm_schedule_after_delay()
+ * @see alarm_schedule_after_delay()
  * @see alarm_schedule_with_recurrence_week_flag()
  */
 int alarm_get_scheduled_period(int alarm_id, int *period);
@@ -382,17 +381,17 @@ int alarm_get_scheduled_period(int alarm_id, int *period);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #ALARM_ERROR_NONE Successful
- * @retval #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval  #ALARM_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied
  */
 int alarm_get_current_time(struct tm *date);
 
 
 /**
- * @brief Gets the app_control to be invoked when the the alarm is triggered.
+ * @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
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.get
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks The @a app_control must be released using app_control_destroy().
  * @param[in] alarm_id The alarm ID uniquely identifies an alarm
  * @param[out] app_control The app_control handle to launch when the alarm is triggered
@@ -416,12 +415,12 @@ int alarm_get_app_control(int alarm_id, app_control_h *app_control);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
  * @remarks The @a alarm_id must be id of alarm which will launch global application.
- *             The function returns an error (error code #ALARM_ERROR_NOT_PERMITTED_APP) if it is not.
- *             Note that the application which is launched by global alarm runs in the user session that is logined currently.
- *             It doesn't run in the session for the user who registers the global alarm.
- *             So, If the application uses application's private data for each user to handling the app_control for the alarm, it might not show proper data to the user.
- *             Therefore, We recommend to contain all the data for the alarm to the app_control handle for the global alarm.
- *             Then, the launched application would be able to use the data to show proper alarm UX to the user.
+ *          The function returns an error (error code #ALARM_ERROR_NOT_PERMITTED_APP) if it is not.
+ *          Note that the application which is launched by global alarm runs in the user session that is logged in currently.
+ *          It doesn't run in the session for the user who registers the global alarm.
+ *          So, if the application uses application's private data for each user to handling the app_control for the alarm, it might not show proper data to the user.
+ *          Therefore, We recommend to contain all the data for the alarm to the app_control handle for the global alarm.
+ *          Then, the launched application would be able to use the data to show proper alarm UX to the user.
  * @param[in] alarm_id The alarm ID uniquely identifies an alarm
  * @param[in] global The global flag to set/unset alarm globally
  * @return @c 0 on success,
@@ -459,17 +458,17 @@ int alarm_get_global(int alarm_id, bool *global);
  * @details The @a date describes the time of the alarm occurrence.
  *          To cancel the alarm, call alarm_cancel() with @a alarm_id.
  * @since_tizen 3.0
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
- * @privilege  %http://tizen.org/privilege/notification
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/notification
  * @remarks If application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          When the alarm goes off, Alarm Manager will turn on LCD to prohibit background jobs.
  *
- * @param[in]  noti The notification to be posted when the alarm is triggered
- * @param[in]  date    The active alarm time
- * @param[out] alarm_id        The ID which uniquely identifies the scheduled alarm
- * @return     @c 0 on success,
- *          otherwise a negative error value
+ * @param[in] noti The notification to be posted when the alarm is triggered
+ * @param[in] date The active alarm time
+ * @param[out] alarm_id The ID which uniquely identifies the scheduled alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
  * @retval  #ALARM_ERROR_NONE   Successful
  * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
  * @retval  #ALARM_ERROR_INVALID_DATE Triggered date is invalid
@@ -487,9 +486,9 @@ int alarm_schedule_noti_once_at_date(notification_h noti, struct tm *date, int *
  *          The alarm will then go off every period seconds until canceled.
  *          To cancel the alarm, call alarm_cancel() with @a alarm_id.
  * @since_tizen 3.0
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
- * @privilege  %http://tizen.org/privilege/notification
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/notification
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          This function is a minimally intrusive way to trigger alarms when precision is not important.
  *          The system will adjust the @a delay and @a period requests to suit internal needs; the requests
@@ -498,11 +497,11 @@ int alarm_schedule_noti_once_at_date(notification_h noti, struct tm *date, int *
  *          When the alarm goes off, Alarm Manager will turn on LCD to prohibit background jobs.
  *
  * @param[in] noti The notification to be posted when the alarm is triggered
- * @param[in] delay    The amount of time before the first execution (in seconds).
+ * @param[in] delay The amount of time before the first execution (in seconds).
  * @param[in] period The amount of time between subsequent alarms (in seconds).
- * @param[out] alarm_id        The ID which uniquely identifies the scheduled alarm
- * @return     @c 0 on success,
- *          otherwise a negative error value
+ * @param[out] alarm_id The ID which uniquely identifies the scheduled alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
  * @retval  #ALARM_ERROR_NONE Successful
  * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
  * @retval  #ALARM_ERROR_INVALID_TIME Triggered time is invalid
@@ -521,17 +520,17 @@ int alarm_schedule_noti_after_delay(notification_h noti, int delay, int period,
  * @details The alarm will go off @a delay seconds later.
  *          To cancel the alarm, call alarm_cancel() with @a alarm_id.
  * @since_tizen 3.0
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
- * @privilege  %http://tizen.org/privilege/notification
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/notification
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          When the alarm goes off, Alarm Manager will turn on LCD to prohibit background jobs.
  *
  * @param[in] noti The notification to be posted when the alarm is triggered
- * @param[in] delay    The amount of time before the execution (in seconds)
- * @param[out] alarm_id        The ID which uniquely identifies the scheduled alarm
- * @return     @c 0 on success,
- *          otherwise a negative error value
+ * @param[in] delay The amount of time before the execution (in seconds)
+ * @param[out] alarm_id The ID which uniquely identifies the scheduled alarm
+ * @return @c 0 on success,
+ *         otherwise a negative error value
  * @retval  #ALARM_ERROR_NONE Successful
  * @retval  #ALARM_ERROR_INVALID_PARAMETER  Invalid parameter
  * @retval  #ALARM_ERROR_INVALID_TIME Triggered time is invalid
@@ -551,15 +550,15 @@ int alarm_schedule_noti_once_after_delay(notification_h noti, int delay, int *al
  *              If @a week_flag is less than or equal to zero, the alarm is not repeated.
  *              To cancel the alarm, call alarm_cancel() with @a alarm_id.
  * @since_tizen 3.0
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.set
- * @privilege  %http://tizen.org/privilege/notification
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/notification
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *
  * @param[in] noti The notification to be posted when the alarm is triggered
- * @param[in] date     The first active alarm time
- * @param[in] week_flag        The day of the week the notification recurs. @a week_flag may be a combination of days, like #ALARM_WEEK_FLAG_TUESDAY | #ALARM_WEEK_FLAG_FRIDAY
- * @param[out] alarm_id        The ID which uniquely identifies the scheduled alarm
+ * @param[in] date The first active alarm time
+ * @param[in] week_flag The day of the week the notification recurs. @a week_flag may be a combination of days, like #ALARM_WEEK_FLAG_TUESDAY | #ALARM_WEEK_FLAG_FRIDAY
+ * @param[out] alarm_id The ID which uniquely identifies the scheduled alarm
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #ALARM_ERROR_NONE Successful
@@ -571,15 +570,15 @@ int alarm_schedule_noti_once_after_delay(notification_h noti, int delay, int *al
  * @see alarm_cancel_all()
  * @see alarm_get_scheduled_recurrence_week_flag()
  * @see alarm_get_scheduled_date()
- * @see        #alarm_week_flag_e
+ * @see #alarm_week_flag_e
  */
 int alarm_schedule_noti_with_recurrence_week_flag(notification_h noti, struct tm *date, int week_flag, int *alarm_id);
 
 /**
  * @brief Gets the notification to be posted when an alarm is triggered.
  * @since_tizen 3.0
- * @privlevel  public
- * @privilege  %http://tizen.org/privilege/alarm.get
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/alarm.get
  * @remarks @a noti must be released using notification_free().
  *
  * @param[in] alarm_id The ID which uniquely identifies a scheduled alarm