From: Editor Lionbridge <TizenEditor.SEL@lionbridge.com>
Date: Wed, 26 Jul 2017 06:01:17 +0000 (+0530)
Subject: Review Badge cs API files
X-Git-Tag: submit/trunk/20170823.075128~119^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=242a6517e3f8b697c92badcaf9ec18069e78eb46;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

Review Badge cs API files

Change-Id: I8060f983f079ff4b99fc0926e63b69128a754ce7
---

diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs b/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs
index d5e6fff..89b317a 100755
--- a/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs
+++ b/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs
@@ -35,7 +35,7 @@ namespace Tizen.Applications
         /// <summary>
         /// Property for the count value of the badge.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
+        /// <since_tizen> 3 </since_tizen>
         public int Count
         {
             get
@@ -47,7 +47,7 @@ namespace Tizen.Applications
         /// <summary>
         /// Property for the application ID of the badge.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
+        /// <since_tizen> 3 </since_tizen>
         public string AppId
         {
             get
@@ -59,7 +59,7 @@ namespace Tizen.Applications
         /// <summary>
         /// Property for the flag of 'display'.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
+        /// <since_tizen> 3 </since_tizen>
         public bool IsDisplay
         {
             get
diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs
index 4956efc..85e72a7 100755
--- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs
+++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs
@@ -19,7 +19,7 @@ namespace Tizen.Applications
     using System;
     using System.Collections.Generic;
     /// <summary>
-    /// Class for badge operation.
+    /// The class for badge operation.
     /// </summary>
     public static class BadgeControl
     {
@@ -30,9 +30,9 @@ namespace Tizen.Applications
         /// <summary>
         /// Event handler for receiving badge events.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static event EventHandler<BadgeEventArgs> Changed
         {
@@ -74,13 +74,13 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Gets the badge information from application ID.
+        /// Gets the badge information from the application ID.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <param name="appId">Application ID</param>
-        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="appId">Application ID.</param>
+        /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static Badge Find(string appId)
         {
@@ -105,11 +105,11 @@ namespace Tizen.Applications
         /// <summary>
         /// Removes the badge information.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <param name="appId">Application ID</param>
-        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="appId">Application ID.</param>
+        /// <exception cref="ArgumentException">Thrown when failed because of a an invalid argument.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static void Remove(string appId)
         {
@@ -123,13 +123,13 @@ namespace Tizen.Applications
         /// <summary>
         /// Adds the badge information.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <param name="appId">Application ID</param>
-        /// <param name="count">Count value</param>
-        /// <param name="isDisplay">True if it should be displayed</param>
-        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="appId">Application ID.</param>
+        /// <param name="count">Count value.</param>
+        /// <param name="isDisplay">True if it should be displayed.</param>
+        /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static void Add(string appId, int count = 1, bool isDisplay = true)
         {
@@ -153,12 +153,12 @@ namespace Tizen.Applications
         /// <summary>
         /// Updates the badge information.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <param name="appId">Application ID</param>
-        /// <param name="count">Count value</param>
-        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="appId">Application ID.</param>
+        /// <param name="count">Count value.</param>
+        /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static void Update(string appId, int count)
         {
@@ -172,12 +172,12 @@ namespace Tizen.Applications
         /// <summary>
         /// Updates the badge information.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <param name="appId">Application ID</param>
-        /// <param name="isDisplay">True if it should be displayed</param>
-        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="appId">Application ID.</param>
+        /// <param name="isDisplay">True if it should be displayed.</param>
+        /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static void Update(string appId, bool isDisplay)
         {
@@ -191,13 +191,13 @@ namespace Tizen.Applications
         /// <summary>
         /// Updates the badge information.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <param name="appId">Application ID</param>
-        /// <param name="count">Count value</param>
-        /// <param name="isDisplay">True if it should be displayed</param>
-        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="appId">Application ID.</param>
+        /// <param name="count">Count value.</param>
+        /// <param name="isDisplay">True if it should be displayed.</param>
+        /// <exception cref="ArgumentException">Thrown when failed because of invalid argument.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static void Update(string appId, int count, bool isDisplay)
         {
@@ -206,11 +206,11 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Gets all badge information.
+        /// Gets all the badge information.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
-        /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception>
-        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception>
+        /// <since_tizen> 3 </since_tizen>
+        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
+        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
         /// <privilege>http://tizen.org/privilege/notification</privilege>
         public static IEnumerable<Badge> GetBadges()
         {
diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeErrorFactory.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeErrorFactory.cs
index 9443298..ff0d909 100755
--- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeErrorFactory.cs
+++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeErrorFactory.cs
@@ -35,7 +35,7 @@ namespace Tizen.Applications
     }
 
     /// <summary>
-    /// Immutable class for getting information of the badge.
+    /// Immutable class for getting the badge information.
     /// </summary>
     internal static class BadgeErrorFactory
     {
diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs
index 2977289..bfcc85f 100755
--- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs
+++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs
@@ -19,7 +19,7 @@ namespace Tizen.Applications
     using System;
 
     /// <summary>
-    /// Class for event arguments of the badge event
+    /// The class for event arguments of the badge event.
     /// </summary>
     public class BadgeEventArgs : EventArgs
     {
@@ -28,37 +28,37 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Enumeration for badge action.
+        /// Enumeration for the badge action.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
+        /// <since_tizen> 3 </since_tizen>
         public enum Action : int
         {
             /// <summary>
-            /// Badge was added.
+            /// The badge was added.
             /// </summary>
             Add = 0,
 
             /// <summary>
-            /// Badge was removed.
+            /// The badge was removed.
             /// </summary>
             Remove,
 
             /// <summary>
-            /// Badge was updated.
+            /// The badge was updated.
             /// </summary>
             Update,
         }
 
         /// <summary>
-        /// Property for Badge object.
+        /// The property for the badge object.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
+        /// <since_tizen> 3 </since_tizen>
         public Badge Badge { get; internal set; }
 
         /// <summary>
-        /// Property for Action value.
+        /// The property for the action value.
         /// </summary>
-        /// <since_tizen>3</since_tizen>
+        /// <since_tizen> 3 </since_tizen>
         public Action Reason { get; internal set; }
     }
 }