[Sensor] Update sensor description regarding batch sensor. (#1730)

Signed-off-by: MuHong Byun <mh.byun@samsung.com>

diff --git a/src/Tizen.Sensor/Tizen.Sensor/BatchData/BatchData.cs b/src/Tizen.Sensor/Tizen.Sensor/BatchData/BatchData.cs
index d66e614..2f0746d 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/BatchData/BatchData.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/BatchData/BatchData.cs
@@ -5,7 +5,7 @@ using System.Text;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The BatchData class is used for storing value of particular batch type sensor.
+    /// The BatchData class stores the value of a particular batch type sensor.
     /// </summary>
     /// <since_tizen> 8 </since_tizen>
     public abstract class BatchData

diff --git a/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorBatchData.cs b/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorBatchData.cs
index 02f11e2..75a9d31 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorBatchData.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorBatchData.cs
@@ -5,7 +5,7 @@ using System.Text;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The HeartRateMonitorBatchData class is used for storing value of HeartRateMonitorBatch sensor.
+    /// The HeartRateMonitorBatchData class stores the value of HeartRateMonitorBatch sensor.
     /// </summary>
     /// <since_tizen> 8 </since_tizen>
     public class HeartRateMonitorBatchData : BatchData
@@ -41,7 +41,7 @@ namespace Tizen.Sensor
         public int HeartRate { get; }
 
         /// <summary>
-        /// Gets the value R wave-to-R wave interval(RRI) from ECG sensor(Unit is millisecond).
+        /// Gets the value of R wave-to-R wave interval(RRI) from ECG sensor. The unit of the interval is millisecond.
         /// </summary>
         /// <since_tizen> 8 </since_tizen>
         /// <value> RRInterval </value>

diff --git a/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorLEDGreenBatchData.cs b/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorLEDGreenBatchData.cs
index 3efa1cf..63aea2e 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorLEDGreenBatchData.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/BatchData/HeartRateMonitorLEDGreenBatchData.cs
@@ -5,7 +5,7 @@ using System.Text;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The HeartRateMonitorLEDGreenBatchData class is used for storing value of HeartRateMonitorLEDGreenBatch sensor.
+    /// The HeartRateMonitorLEDGreenBatchData class stores the value of HeartRateMonitorLEDGreenBatch sensor.
     /// </summary>
     /// <since_tizen> 8 </since_tizen>
     public class HeartRateMonitorLEDGreenBatchData : BatchData
@@ -31,7 +31,7 @@ namespace Tizen.Sensor
         }
 
         /// <summary>
-        /// Gets the value of the Green LED ADC Value. (0 ~ 4194304)
+        /// Gets the value of the Green LED ADC Value, between 0 and 4194304.
         /// </summary>
         /// <since_tizen> 8 </since_tizen>
         /// <value> Green </value>

diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
index 5e4500c..cc12971 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
@@ -21,7 +21,7 @@ using System.ComponentModel;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The HeartRateMonitorBatch class is used for registering callbacks for the heart rate monitor batch and getting the heart rate batch data.
+    /// The HeartRateMonitorBatch class registers callbacks of batch jobs for heart rate monitoring and provides batch data of the heart rate.
     /// </summary>
     /// <since_tizen> 8 </since_tizen>
     public sealed class HeartRateMonitorBatch : BatchSensor<HeartRateMonitorBatchData>
@@ -149,7 +149,7 @@ namespace Tizen.Sensor
         }
 
         /// <summary>
-        /// Read HeartRateMonitorBatch data synchronously.
+        /// Reads HeartRateMonitorBatch data synchronously.
         /// </summary>
         internal override void ReadData()
         {

diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
index f5a3a28..bab0c52 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
@@ -21,7 +21,7 @@ using System.ComponentModel;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The HeartRateMonitorLEDGreenBatch class is used for registering callbacks for the HRMLEDGreen batch and getting the HRMLEDGreen batch data.
+    /// The HeartRateMonitorLEDGreenBatch class registers callbacks for the HRMLEDGreen batch and provides batch data of HRMLEDGreen batch.
     /// </summary>
     /// <since_tizen> 8 </since_tizen>
     public sealed class HeartRateMonitorLEDGreenBatch : BatchSensor<HeartRateMonitorLEDGreenBatchData>
@@ -149,7 +149,7 @@ namespace Tizen.Sensor
         }
 
         /// <summary>
-        /// Read HeartRateMonitorLEDGreenBatch data synchronously.
+        /// Reads HeartRateMonitorLEDGreenBatch data synchronously.
         /// </summary>
         internal override void ReadData()
         {

diff --git a/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs b/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs
index 73fa152..3b99e1f 100755 (executable)
--- a/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs
@@ -371,7 +371,7 @@ namespace Tizen.Sensor
     public enum HeartRateMonitorBatchState
     {
         /// <summary>
-        /// Flush but there was no batched data
+        /// Flush but there is no batched data
         /// </summary>
         SENSOR_HRM_BATCH_STATE_NODATA_FLUSH = -99,
 
@@ -386,22 +386,22 @@ namespace Tizen.Sensor
         SENSOR_HRM_BATCH_STATE_LOW_RELIABILITY = -8,
 
         /// <summary>
-        /// Device detachment was detected during auto measurement
+        /// Device detachment is detected during auto measurement
         /// </summary>
         SENSOR_HRM_BATCH_STATE_DETACHED_AUTO = -5,
 
         /// <summary>
-        /// Device detachment was detected
+        /// Device detachment is detected
         /// </summary>
         SENSOR_HRM_BATCH_STATE_DETACHED = -3,
 
         /// <summary>
-        /// The Movement was detected during on-demand measurement
+        /// The Movement is detected during on-demand measurement
         /// </summary>
         SENSOR_HRM_BATCH_STATE_DETECT_MOVE = -2,
 
         /// <summary>
-        /// Device attachment was detected
+        /// Device attachment is detected
         /// </summary>
         SENSOR_HRM_BATCH_STATE_ATTACHED = -1,