[Tizen.Applications.Alarm] Enhance API descriptions (#6443)

Signed-off-by: inkyun.kil <inkyun.kil@samsung.com>

diff --git a/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs b/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs
index 5110a58e63bd79a6006389964e0267a24654a4ce..a5e5428ca5d8d2e0ba6d9738010872560b14f3f2 100755 (executable)
--- a/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs
+++ b/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs
@@ -61,14 +61,17 @@ namespace Tizen.Applications
         /// <privilege>http://tizen.org/privilege/alarm.get</privilege>
         /// <remarks>
         /// The setter for <c>WeekFlag</c> 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.
         /// </remarks>
+        /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied due to insufficient privileges.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
         /// <since_tizen> 3 </since_tizen>
         public AlarmWeekFlag WeekFlag
         {
@@ -103,6 +106,9 @@ namespace Tizen.Applications
         /// <remarks>
         /// The <c>SchduleDate</c> property setter is available since API Level 6.
         /// </remarks>
+        /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied due to insufficient privileges.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
         /// <since_tizen> 3 </since_tizen>
         public DateTime ScheduledDate
         {
@@ -141,19 +147,22 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Gets the period of time between the recurrent alarms.
+        /// Gets or sets the period of time between the recurrent alarms.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/alarm.set</privilege>
         /// <privilege>http://tizen.org/privilege/alarm.get</privilege>
         /// <remarks>
         /// The <c>Period</c> 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.
         /// </remarks>
+        /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied due to insufficient privileges.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
         /// <since_tizen> 3 </since_tizen>
         public int Period
         {

diff --git a/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs b/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs
index 0aaf4279051015c4cce45835150d724bc94c3433..cf856ec8f46c73256ea862d8b2d78fbbd79b5fd1 100755 (executable)
--- a/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs
+++ b/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs
@@ -102,7 +102,7 @@ namespace Tizen.Applications
     }
 
     /// <summary>
-    /// 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 @@ namespace Tizen.Applications
         /// 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.
         /// </summary>
-        /// <param name="delay">The amount of time before the first execution (in seconds).</param>
+        /// <param name="delay">The amount of time before the first execution (in seconds). Although this is inexact, the alarm will not fire before this time</param>
         /// <param name="period"> 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.</param>
         /// <param name="appControl"> The destination AppControl is used to perform a specific task when the alarm is triggered. </param>
@@ -185,6 +185,7 @@ namespace Tizen.Applications
         /// <param name="delay"> The amount of time before the execution (in seconds). </param>
         /// <param name="appControl"> The destination AppControl to perform a specific task when the alarm is triggered. </param>
         /// <returns> An alarm instance is created with the set param values.</returns>
+        /// <remarks>This operation is permitted with the UI application appcontrol only.</remarks>
         /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
         /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception>
         /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
@@ -330,7 +331,7 @@ namespace Tizen.Applications
         /// 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.
         /// </summary>
-        /// <param name="delay">The amount of time before the first execution (in seconds). </param>
+        /// <param name="delay">The amount of time before the first execution (in seconds). Although this is inexact, the alarm will not fire before this time</param>
         /// <param name="period"> The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. </param>
         /// <param name="notification"> The notification to be posted when the alarm is triggered. </param>
         /// <returns> An alarm instance is created with the set param values.</returns>