[Sensor] Remove document warning. (#2080)

* Add comment to BatchSensor

Co-authored-by: WonYoung Choi <wy80.choi@samsung.com>

diff --git a/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs
index cb27092..aafc00f 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs
@@ -19,11 +19,24 @@ using System.Collections.Generic;
 
 namespace Tizen.Sensor
 {
+    /// <summary>
+    /// Abstract sensor for series of sensor data
+    /// </summary>
+    /// <since_tizen> 8 </since_tizen>
     public abstract class BatchSensor<TData> : Sensor where TData : Tizen.Sensor.BatchData
     {
+        /// <summary>
+        /// Create BatchSensor
+        /// </summary>
+        /// <since_tizen> 8 </since_tizen>
         public BatchSensor(uint index = 0) : base(index) {
             UpdateBatchData((IntPtr)null, 0);
         }
+
+        /// <summary>
+        /// Get general batch data
+        /// </summary>
+        /// <since_tizen> 8 </since_tizen>
         public IReadOnlyList<TData> Data { get; protected set; }
 
         /// <summary>

diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
index cc12971..a0cb24a 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
@@ -30,6 +30,10 @@ namespace Tizen.Sensor
 
         private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
 
+        /// <summary>
+        /// List of converted HeartRateMonitorBatchData.
+        /// </summary>
+        /// <since_tizen> 8 </since_tizen>
         protected override IReadOnlyList<HeartRateMonitorBatchData> ConvertBatchData()
         {
             List<HeartRateMonitorBatchData> list = new List<HeartRateMonitorBatchData>();

diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
index bab0c52..ad0e6d8 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
@@ -30,6 +30,10 @@ namespace Tizen.Sensor
 
         private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
 
+        /// <summary>
+        /// List of converted HeartRateMonitorLEDGreenBatchData.
+        /// </summary>
+        /// <since_tizen> 8 </since_tizen>
         protected override IReadOnlyList<HeartRateMonitorLEDGreenBatchData> ConvertBatchData()
         {
             List<HeartRateMonitorLEDGreenBatchData> list = new List<HeartRateMonitorLEDGreenBatchData>();