Review Tizen.Context.AppHistory API cs files

PS1: Edited files as per comments

Change-Id: Icb02c697f3262fcc921a49c7d799fdfca4cc8aac

diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/AppStatistics.cs b/src/Tizen.Context/Tizen.Context.AppHistory/AppStatistics.cs
index 8a3939263ecbaabd7a6f1b6c0c27988cdb246e51..7bcefd3f212d1d128a43a6eb71e182b34e9e6819 100644 (file)
--- a/src/Tizen.Context/Tizen.Context.AppHistory/AppStatistics.cs
+++ b/src/Tizen.Context/Tizen.Context.AppHistory/AppStatistics.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Context.AppHistory
 {
     /// <summary>
-    /// Base class for application statistics.
+    /// The Base class for application statistics.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public abstract class AppStatistics

diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/AppStatisticsData.cs b/src/Tizen.Context/Tizen.Context.AppHistory/AppStatisticsData.cs
index 6499de1b164fa6187296926471e0739a53801591..20488644bf5760c35c776c8f8ae4d547cff4e1cd 100644 (file)
--- a/src/Tizen.Context/Tizen.Context.AppHistory/AppStatisticsData.cs
+++ b/src/Tizen.Context/Tizen.Context.AppHistory/AppStatisticsData.cs
@@ -17,7 +17,7 @@
 namespace Tizen.Context.AppHistory
 {
     /// <summary>
-    /// Base class which contains application statistics query result.
+    /// The Base class which contains the application statistics query result.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public abstract class AppStatisticsData
@@ -27,10 +27,10 @@ namespace Tizen.Context.AppHistory
         }
 
         /// <summary>
-        /// Gets the application id.
+        /// Gets the application ID.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
-        /// <value>The application id.</value>
+        /// <value>The application ID.</value>
         public string AppId { get; protected set; }
     }
 }

diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs b/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs
index bd346b77a15f9fb53018efe2a8c16c7bf2ed3f21..3f9c11b011e153b258d17101489c52be358007ae 100644 (file)
--- a/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs
+++ b/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs
@@ -20,7 +20,7 @@ using System.Collections.Generic;
 namespace Tizen.Context.AppHistory
 {
     /// <summary>
-    /// This class provides APIs to query battery consumption per application.
+    /// This class provides APIs to query the battery consumption per application.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public class BatteryStatistics : AppStatistics
@@ -28,12 +28,12 @@ namespace Tizen.Context.AppHistory
         private const string AppStatsConsumption = "TotalAmount";
 
         /// <summary>
-        ///  The default constructor of BatteryStatistics class.
+        /// The default constructor of BatteryStatistics class.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <feature>http://tizen.org/feature/battery</feature>
-        /// <exception cref="InvalidOperationException">Thrown when method fail due to internal error.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when the method failed due to an internal error.</exception>
         /// <exception cref="NotSupportedException">Thrown when the features are not supported.</exception>
         public BatteryStatistics()
         {
@@ -61,7 +61,7 @@ namespace Tizen.Context.AppHistory
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <feature>http://tizen.org/feature/battery</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
-        /// <exception cref="InvalidOperationException">Thrown when method fail due to internal error.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when the method failed due to an internal error.</exception>
         /// <exception cref="NotSupportedException">Thrown when the features are not supported.</exception>
         public BatteryStatistics(SortOrderType order)
         {
@@ -99,7 +99,7 @@ namespace Tizen.Context.AppHistory
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
         /// <exception cref="InvalidOperationException">Thrown when invalid operation occurs.</exception>
         /// <exception cref="NotSupportedException">Thrown when the features are not supported.</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to retrieve the application history.</exception>
         public IReadOnlyList<BatteryStatisticsData> Query(DateTime startTime, DateTime endTime)
         {
             CheckTimeSpan(startTime, endTime);
@@ -119,9 +119,9 @@ namespace Tizen.Context.AppHistory
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <feature>http://tizen.org/feature/battery</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
-        /// <exception cref="InvalidOperationException">Thrown when invalid operation occurs.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when an invalid operation occurs.</exception>
         /// <exception cref="NotSupportedException">Thrown when the features are not supported.</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to retrieve the application history.</exception>
         public IReadOnlyList<BatteryStatisticsData> Query(DateTime startTime, DateTime endTime, uint resultSize)
         {
             CheckTimeSpan(startTime, endTime);
@@ -206,13 +206,13 @@ namespace Tizen.Context.AppHistory
         public SortOrderType SortOrder { get; private set; }
 
         /// <summary>
-        /// Sort order type of battery statistics.
+        /// Sorts the order type of battery statistics.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public enum SortOrderType
         {
             /// <summary>
-            /// Sorts apps by consumption, the most battery consuming apps appear first. (Default)
+            /// Sorts the apps by consumption, the most battery consuming apps appear first (default).
             /// </summary>
             ConsumptionMost = 0
         }

diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatisticsData.cs b/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatisticsData.cs
index 7b7842d5413378f05f84d9470f2f4109382b742b..3771b8ebe4c7ddf8777b47d86caef2da65849af6 100644 (file)
--- a/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatisticsData.cs
+++ b/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatisticsData.cs
@@ -17,7 +17,7 @@
 namespace Tizen.Context.AppHistory
 {
     /// <summary>
-    /// The class contains battery statistics information retrieved by BatteryStatistics.
+    /// This class contains the battery statistics information retrieved by BatteryStatistics.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public class BatteryStatisticsData : AppStatisticsData
@@ -29,7 +29,7 @@ namespace Tizen.Context.AppHistory
         }
 
         /// <summary>
-        /// Gets how many percentage of battery capacity was used by the application.
+        /// Gets how much percentage of battery capacity was used by the application.
         /// </summary>
         /// <value>Battery consumption used by the application.</value>
         /// <since_tizen> 4 </since_tizen>

diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs b/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs
index 121808dbbadd3f76bd5a49031b15bb6f6de84e3e..f818df3258e373a48e9785cefe0ef16515df50e4 100644 (file)
--- a/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs
+++ b/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs
@@ -20,7 +20,7 @@ using System.Collections.Generic;
 namespace Tizen.Context.AppHistory
 {
     /// <summary>
-    /// This class provides APIs to query application launch history.
+    /// This class provides APIs to query the application launch history.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public class UsageStatistics : AppStatistics
@@ -34,7 +34,7 @@ namespace Tizen.Context.AppHistory
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <feature>http://tizen.org/feature/app_history</feature>
-        /// <exception cref="InvalidOperationException">Thrown when method fail due to internal error.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when the method failed due to an internal error.</exception>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
         public UsageStatistics()
         {
@@ -61,7 +61,7 @@ namespace Tizen.Context.AppHistory
         /// <param name="order">The criteria of the usage statistics sorted by.</param>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
-        /// <exception cref="InvalidOperationException">Thrown when method fail due to internal error.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when the method failed due to an internal error.</exception>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
         public UsageStatistics(SortOrderType order)
         {
@@ -96,9 +96,9 @@ namespace Tizen.Context.AppHistory
         /// <privilege>http://tizen.org/privilege/apphistory.read</privilege>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
-        /// <exception cref="InvalidOperationException">Thrown when invalid operation occurs.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when an invalid operation occurs.</exception>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to retrieve the application history.</exception>
         public IReadOnlyList<UsageStatisticsData> Query(DateTime startTime, DateTime endTime)
         {
             CheckTimeSpan(startTime, endTime);
@@ -117,9 +117,9 @@ namespace Tizen.Context.AppHistory
         /// <privilege>http://tizen.org/privilege/apphistory.read</privilege>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
-        /// <exception cref="InvalidOperationException">Thrown when invalid operation occurs.</exception>
+        /// <exception cref="InvalidOperationException">Thrown when an invalid operation occurs.</exception>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to retrieve the application history.</exception>
         public IReadOnlyList<UsageStatisticsData> Query(DateTime startTime, DateTime endTime, uint resultSize)
         {
             CheckTimeSpan(startTime, endTime);
@@ -188,17 +188,17 @@ namespace Tizen.Context.AppHistory
         public SortOrderType SortOrder { get; private set; }
 
         /// <summary>
-        /// Sort order type of usage statistics
+        /// Sorts the order type of usage statistics.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public enum SortOrderType
         {
             /// <summary>
-            /// Sorts apps by the last launch time, the most recently launched apps appear first. (Default)
+            /// Sorts the apps by the last launch time, the most recently launched apps appear first (default).
             /// </summary>
             LastLaunchTimeNewest = 0,
             /// <summary>
-            /// Sorts apps by the launch count of being launched, the most frequently launched apps appear first.
+            /// Sorts the apps by the launch count of being launched, the most frequently launched apps appear first.
             /// </summary>
             LaunchCountMost
         }

diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatisticsData.cs b/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatisticsData.cs
index a1aa0d198fefc4d946238fde356536ced4fa976c..8d3f0c9efb9c1804a164e646238d85fbf33f641b 100644 (file)
--- a/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatisticsData.cs
+++ b/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatisticsData.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Context.AppHistory
 {
     /// <summary>
-    /// The class contains application usage statistics information retrieved by UsageStatistics.
+    /// This class contains the application usage statistics information retrieved by UsageStatistics.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public class UsageStatisticsData : AppStatisticsData
@@ -33,14 +33,14 @@ namespace Tizen.Context.AppHistory
         }
 
         /// <summary>
-        ///  Gets the time which the application is being displayed in the foreground in seconds.
+        /// Gets the time when the application is being displayed in the foreground in seconds.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
-        /// <value>Duration which the application is used in the foreground in seconds.</value>
+        /// <value>Duration when the application is used in the foreground in seconds.</value>
         public int Duration { get; private set; }
 
         /// <summary>
-        ///  Gets how many times the application is used in the foreground.
+        /// Gets how many times the application is used in the foreground.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <value>How many times the application is used in the foreground.</value>