[Sensor] Update sensor description for better understanding. (#1622)

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

diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AutoRotationSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AutoRotationSensorDataUpdatedEventArgs.cs
index bd4cc10..926876c 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AutoRotationSensorDataUpdatedEventArgs.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AutoRotationSensorDataUpdatedEventArgs.cs
@@ -20,7 +20,7 @@ using System.ComponentModel;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The AutoRotationSensor changed event arguments class is used for storing the data returned by the auto rotation sensor.
+    /// The AutoRotationSensorDataUpdatedEventArgs is used for storing the data returned by the auto-rotation sensor.
     /// </summary>
     /// <since_tizen> 7 </since_tizen>
     public class AutoRotationSensorDataUpdatedEventArgs : EventArgs
@@ -39,7 +39,7 @@ namespace Tizen.Sensor
         public AutoRotationState Rotation { get; private set; } = AutoRotationState.Degree_0;
 
         /// <summary>
-        /// Gets the accuracy of the auto rotation data.
+        /// Gets the accuracy of the auto-rotation data.
         /// </summary>
         /// <since_tizen> 7 </since_tizen>
         /// <value> Accuracy </value>

diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs
index c2e2221..8e5d1d7 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs
@@ -20,7 +20,7 @@ using System.ComponentModel;
 namespace Tizen.Sensor
 {
     /// <summary>
-    /// The AutoRotationSensor class is used for registering callbacks for the auto rotation sensor and getting the auto rotation data.
+    /// The AutoRotationSensor class is used for registering callbacks for the auto-rotation sensor and getting the auto-rotation data.
     /// </summary>
     /// <since_tizen> 7 </since_tizen>
     public sealed class AutoRotationSensor : Sensor
@@ -38,14 +38,14 @@ namespace Tizen.Sensor
 
 
         /// <summary>
-        /// Gets the accuracy of the auto rotation data.
+        /// Gets the accuracy of the auto-rotation data.
         /// </summary>
         /// <since_tizen> 7 </since_tizen>
         /// <value> Accuracy </value>
         public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
 
         /// <summary>
-        /// Returns true or false based on whether the auto rotation sensor is supported by the device.
+        /// Returns true or false based on whether the auto-rotation sensor is supported by the device.
         /// </summary>
         /// <since_tizen> 7 </since_tizen>
         /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
@@ -67,7 +67,7 @@ namespace Tizen.Sensor
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
         /// <param name='index'>
-        /// Index. Default value for this is 0. Index refers to a particular auto rotation sensor in case of multiple sensors.
+        /// Index. The default value of this is 0. Index refers to a specific auto-rotation sensor in case of multiple sensors.
         /// </param>
         public AutoRotationSensor(uint index = 0) : base(index)
         {
@@ -80,7 +80,7 @@ namespace Tizen.Sensor
         }
 
         /// <summary>
-        /// An event handler for storing the callback functions for the event corresponding to the change in the auto rotation sensor data.
+        /// An event handler for storing the callback functions for the event corresponding to the change in the auto-rotation sensor data.
         /// </summary>
         /// <since_tizen> 7 </since_tizen>
 
@@ -117,7 +117,7 @@ namespace Tizen.Sensor
             int error = Interop.SensorManager.GetSensorList(SensorType.AutoRotation, out list, out count);
             if (error != (int)SensorError.None)
             {
-                Log.Error(Globals.LogTag, "Error getting sensor list for auto rotation");
+                Log.Error(Globals.LogTag, "Error getting sensor list for auto-rotation");
                 count = 0;
             }
             else
@@ -126,7 +126,7 @@ namespace Tizen.Sensor
         }
 
         /// <summary>
-        /// Read auto rotation data synchronously.
+        /// Read auto-rotation data synchronously.
         /// </summary>
         internal override void ReadData()
         {
@@ -134,8 +134,8 @@ namespace Tizen.Sensor
             int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
             if (error != (int)SensorError.None)
             {
-                Log.Error(Globals.LogTag, "Error reading auto rotation data");
-                throw SensorErrorFactory.CheckAndThrowException(error, "Reading auto rotation data failed");
+                Log.Error(Globals.LogTag, "Error reading auto-rotation data");
+                throw SensorErrorFactory.CheckAndThrowException(error, "Reading auto-rotation data failed");
             }
 
             Timestamp = sensorData.timestamp;
@@ -169,8 +169,8 @@ namespace Tizen.Sensor
             int error = Interop.SensorListener.SetEventsCallback(ListenerHandle, _callback, IntPtr.Zero);
             if (error != (int)SensorError.None)
             {
-                Log.Error(Globals.LogTag, "Error setting event callback for auto rotation sensor");
-                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for auto rotation");
+                Log.Error(Globals.LogTag, "Error setting event callback for auto-rotation sensor");
+                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for auto-rotation");
             }
         }
 
@@ -179,8 +179,8 @@ namespace Tizen.Sensor
             int error = Interop.SensorListener.UnsetEventsCallback(ListenerHandle);
             if (error != (int)SensorError.None)
             {
-                Log.Error(Globals.LogTag, "Error unsetting event callback for auto rotation sensor");
-                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for auto rotation");
+                Log.Error(Globals.LogTag, "Error unsetting event callback for auto-rotation sensor");
+                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for auto-rotation");
             }
         }
 
@@ -197,8 +197,8 @@ namespace Tizen.Sensor
             int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
             if (error != (int)SensorError.None)
             {
-                Log.Error(Globals.LogTag, "Error setting accuracy event callback for auto rotation sensor");
-                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for auto rotation");
+                Log.Error(Globals.LogTag, "Error setting accuracy event callback for auto-rotation sensor");
+                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for auto-rotation");
             }
         }
 
@@ -207,8 +207,8 @@ namespace Tizen.Sensor
             int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
             if (error != (int)SensorError.None)
             {
-                Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for auto rotation sensor");
-                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for auto rotation");
+                Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for auto-rotation sensor");
+                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for auto-rotation");
             }
         }
     }

diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
index 8568874..5e4500c 100644 (file)
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
@@ -221,7 +221,7 @@ namespace Tizen.Sensor
             if (error != (int)SensorError.None)
             {
                 Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for HeartRateMonitorBatch sensor");
-                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for auto rotation");
+                throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for HeartRateMonitorBatch");
             }
         }
     }

diff --git a/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs b/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs
index b9cca5c..73fa152 100755 (executable)
--- a/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs
@@ -116,7 +116,7 @@ namespace Tizen.Sensor
         /// </summary>
         SleepMonitor = 0x301,
         /// <summary>
-        /// Auto Rotation sensor.
+        /// Auto-rotation sensor.
         /// </summary>
         AutoRotation = 0x901,
         /// <summary>
@@ -333,7 +333,7 @@ namespace Tizen.Sensor
     }
     
     /// <summary>
-    /// The auto rotation state.
+    /// The auto-rotation state.
     /// </summary>
     /// <since_tizen> 7 </since_tizen>
     public enum AutoRotationState