From add41e18493065e5960c5d11c5c58c4fcfcff200 Mon Sep 17 00:00:00 2001 From: "inkyun.kil" Date: Wed, 25 Sep 2024 16:01:30 +0900 Subject: [PATCH] [Tizen.Applications.Alarm] Enhance API descriptions Signed-off-by: inkyun.kil --- .../Tizen.Applications/Alarm.cs | 27 ++++++++++++------- .../Tizen.Applications/AlarmManager.cs | 6 ++--- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs b/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs index 5110a58e63b..a5e5428ca5d 100755 --- a/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs +++ b/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs @@ -61,14 +61,17 @@ public int AlarmId /// http://tizen.org/privilege/alarm.get /// /// The setter for WeekFlag property is available since API Level 6. - /// Weekflag can be a combination of the days of the week, for example Tuesday | Friday. - /// If the period is already set, it will be removed and the week repetition flag will be set. - /// If the week repetition flag is already set, it will be overwritten. If not, it will be set. + /// Weekflag can represent a combination of days of the week, such as Tuesday | Friday. + /// If the period is already set, it will be removed and the week repetition flag will be set instead. + /// If the week repetition flag is already set, it will be overwritten. Otherwise, it will be set. /// If the Weekflag argument is 0 and the flag is already set, - /// the flag will be cleared and the alarm will be changed to set once. - /// If the Weekflag argument is 0, and the flag is not set or the period is set, - /// the alarm won't be changed. + /// the flag will be cleared and the alarm will be changed to a single occurrence. + /// If the Weekflag argument is 0 and no flag is set or if the period is set, + /// the alarm will remain unchanged. /// + /// Thrown in case of an invalid parmaeter. + /// Thrown in case of a permission denied due to insufficient privileges. + /// Thrown in case of any internal error. /// 3 public AlarmWeekFlag WeekFlag { @@ -103,6 +106,9 @@ public AlarmWeekFlag WeekFlag /// /// The SchduleDate property setter is available since API Level 6. /// + /// Thrown in case of an invalid parmaeter. + /// Thrown in case of a permission denied due to insufficient privileges. + /// Thrown in case of any internal error. /// 3 public DateTime ScheduledDate { @@ -141,19 +147,22 @@ public DateTime ScheduledDate } /// - /// Gets the period of time between the recurrent alarms. + /// Gets or sets the period of time between the recurrent alarms. /// /// http://tizen.org/privilege/alarm.set /// http://tizen.org/privilege/alarm.get /// /// The Period property setter is available since API Level 6. /// If the week recurrence flag was set before, it will be removed and the period will be set - /// If the period was set before, it will be overwritten.If it was not, it will be set. + /// If the period was set before, it will be overwritten. If it was not, it will be set. /// If the @a period argument is 0 and the period was previously set, /// the period attribute will be cleared and the alarm will be changed to one-time. /// If the @a period argument is 0 and the period was not set, - /// or the week recurrence flag was set, the alarm will be unchanged. + /// or the week recurrence flag was set, the alarm will remain unchanged. /// + /// Thrown in case of an invalid parmaeter. + /// Thrown in case of a permission denied due to insufficient privileges. + /// Thrown in case of any internal error. /// 3 public int Period { diff --git a/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs b/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs index 0aaf4279051..83205a73a32 100755 --- a/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs +++ b/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs @@ -102,7 +102,7 @@ public enum AlarmStandardPeriod } /// - /// Mobile devices typically give constant access to information from various sources. Some of this information is best delivered through alarms. + /// 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. @@ -149,7 +149,7 @@ internal static DateTime ConvertIntPtrToDateTime(Interop.Alarm.DateTime time) /// Sets an alarm to be triggered after a specific time. /// The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds. /// - /// The amount of time before the first execution (in seconds). + /// The amount of time before the first execution (in seconds). Although this is inexact, the alarm will not fire before this time /// The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. /// The actual interval is calculated by the OS. The minimum value is 600sec. /// The destination AppControl is used to perform a specific task when the alarm is triggered. @@ -330,7 +330,7 @@ public static Alarm CreateAlarm(DateTime dateTime, Notification notification) /// Sets a notification alarm to be triggered after a specific time. /// The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds. /// - /// The amount of time before the first execution (in seconds). + /// The amount of time before the first execution (in seconds). Although this is inexact, the alarm will not fire before this time /// The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. /// The notification to be posted when the alarm is triggered. /// An alarm instance is created with the set param values.