Merge "Fix build warning" preview1-00286
authorSemun Lee <semun.lee@samsung.com>
Wed, 11 Oct 2017 10:27:26 +0000 (10:27 +0000)
committerGerrit Code Review <gerrit@review.ap-northeast-2.compute.internal>
Wed, 11 Oct 2017 10:27:26 +0000 (10:27 +0000)
src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs
src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs
src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationSafeHandle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs

index 4f0a97a..8c12f40 100755 (executable)
@@ -60,14 +60,14 @@ namespace Tizen.Applications.Notifications
 
         /// <summary>
         /// Gets or sets the icon of notification.
-       /// You should set an absolute path for an image file.
+        /// You should set an absolute path for an image file.
         /// </summary>
         public string Icon { get; set; } = string.Empty;
 
         /// <summary>
         /// Gets or sets the sub icon of notification.
         /// This SubIcon is displayed in Icon you set.
-       /// You should set an absolute path for an image file.
+        /// You should set an absolute path for an image file.
         /// </summary>
         public string SubIcon { get; set; } = string.Empty;
 
@@ -128,6 +128,10 @@ namespace Tizen.Applications.Notifications
             }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the notification is Onging or not.
+        /// Default value is false.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public bool IsOngoing { get; set; } = false;
 
index 84758f2..59e5711 100755 (executable)
@@ -451,6 +451,12 @@ namespace Tizen.Applications.Notifications
             return state;
         }
 
+        /// <summary>
+        /// Make a NotificationSafeHandle from Notification.
+        /// </summary>
+        /// <param name="notification">The Notification class.</param>
+        /// <returns>The NotificationSafeHandle class.</returns>
+        /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static NotificationSafeHandle MakeNotificationSafeHandle(Notification notification)
         {
@@ -464,6 +470,12 @@ namespace Tizen.Applications.Notifications
             return notification.Handle;
         }
 
+        /// <summary>
+        /// Make a Notification from NotificationSafeHandle.
+        /// </summary>
+        /// <param name="handle">The NotificationSafeHandle class.</param>
+        /// <returns>The Notification class.</returns>
+        /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static Notification MakeNotification(NotificationSafeHandle handle)
         {
index 28ce60a..deb503d 100755 (executable)
@@ -20,9 +20,15 @@ namespace Tizen.Applications.Notifications
     using System.ComponentModel;
     using System.Runtime.InteropServices;
 
+    /// <summary>
+    /// This class manages the notification handle resources.
+    /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public sealed class NotificationSafeHandle : SafeHandle
     {
+        /// <summary>
+        /// Initializes a new instance of the NotificationSafeHandle class.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public NotificationSafeHandle()
             : base(IntPtr.Zero, true)
@@ -43,6 +49,10 @@ namespace Tizen.Applications.Notifications
             get { return this.DangerousGetHandle() == IntPtr.Zero; }
         }
 
+        /// <summary>
+        /// Executes the code required to free the NotificationSafeHandle.
+        /// </summary>
+        /// <returns></returns>
         protected override bool ReleaseHandle()
         {
             Interop.Notification.Destroy(this.handle);
index 140ab96..88221b3 100755 (executable)
@@ -93,6 +93,9 @@ namespace Tizen.Applications.NotificationEventListener
         /// </summary>
         public string Tag { get; internal set; }
 
+        /// <summary>
+        /// Gets a value indicating whether the notification is Onging or not.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public bool IsOngoing { get; internal set; } = false;
 
@@ -102,6 +105,10 @@ namespace Tizen.Applications.NotificationEventListener
         /// </summary>
         public bool IsVisible { get; internal set; } = true;
 
+        /// <summary>
+        /// Gets the event flag.
+        /// If this flag is true, you can do SendEvent.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public bool HasEventFlag { get; internal set; } = false;
 
index 69af7d2..9438f81 100755 (executable)
@@ -21,6 +21,9 @@ namespace Tizen.Applications.NotificationEventListener
     /// </summary>
     public partial class NotificationEventArgs
     {
+        /// <summary>
+        /// An object can get a rich notification style to a notification object.
+        /// </summary>
         public abstract class StyleArgs
         {
             internal abstract string Key { get; }
index 4d6f582..dd86791 100755 (executable)
@@ -402,6 +402,15 @@ namespace Tizen.Applications.NotificationEventListener
             return list;
         }
 
+        /// <summary>
+        /// Sends occured event from viewer application to the notification owner.
+        /// </summary>
+        /// <param name="uniqueNumber">The unique number of the notification.</param>
+        /// <param name="type">Event type on notification.</param>
+        /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception>
+        /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
+        /// <privilege>http://tizen.org/privilege/notification</privilege>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static void SendEvent(int uniqueNumber, UserEventType type)
         {