From: Editor Lionbridge Date: Tue, 8 Aug 2017 12:11:09 +0000 (+0530) Subject: Review sensor API cs files X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6efa0bd25a0711f4154eeb5d4b29b98ce57969ec;p=platform%2Fcore%2Fcsapi%2Fsensor.git Review sensor API cs files PS3: Edited AccelerometerDataUpdatedEventArgs and GyroscopeDataUpdatedEventArgs API cs files PS4: Added 'The' to Sensor API files wherever applicable PS5: Further edits Change-Id: I2af57b15952d4e2ed88fd9a8cbec6e53d487042f --- diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs index f87f24e..3f99237 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Accelerometer changed event arguments. Class for storing the data returned by accelerometer + /// The Accelerometer changed event arguments class is used for storing the data returned by a accelerometer. /// public class AccelerometerDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs index b92bb6f..7a534c9 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// FaceDownGestureDetector changed event arguments. Class for storing the data returned by face down gesture detector. + /// The FaceDownGestureDetector changed event arguments class is used for storing the data returned by the face down gesture detector. /// public class FaceDownGestureDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the face down state. /// /// 3 - /// Face down state + /// The face down state. public DetectorState FaceDown { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs index b7812a9..c960e2b 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// GravitySensor changed event arguments. Class for storing the data returned by gravity sensor + /// The GravitySensor changed event arguments class is used for storing the data returned by the gravity sensor. /// public class GravitySensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs index 58724c1..849b570 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Gyroscope changed event arguments. Class for storing the data returned by gyroscope + /// The Gyroscope changed event arguments class is used for storing the data returned by a gyroscope. /// public class GyroscopeDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs index 48c0238..88ded5b 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// GyroscopeRotationVectorSensor changed event arguments. Class for storing the data returned by gyroscope rotation vector sensor + /// The GyroscopeRotationVectorSensor changed event arguments class is used for storing the data returned by the gyroscope rotation vector sensor. /// public class GyroscopeRotationVectorSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs index 68b9fe7..a513227 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// HeartRateMonitor changed event arguments. Class for storing the data returned by heart rate monitor + /// The HeartRateMonitor changed event arguments class is used for storing the data returned by a heart rate monitor. /// public class HeartRateMonitorDataUpdatedEventArgs : EventArgs { @@ -29,10 +29,10 @@ namespace Tizen.Sensor } /// - /// Gets the value of the heartRate. + /// Gets the value of the heart rate. /// /// 3 - /// Heart rate + /// The heart rate. public int HeartRate { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs index c8e7c32..f7687a5 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// HumiditySensor changed event arguments. Class for storing the data returned by humidity sensor + /// The HumiditySensor changed event arguments class is used for storing the data returned by the humidity sensor. /// public class HumiditySensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs index 4e6e8f0..6ecdb85 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// InVehicleActivityDetector changed event arguments. Class for storing the data returned by in-vehicle activity detector + /// The InVehicleActivityDetector changed event arguments class is used for storing the data returned by the in-vehicle activity detector. /// public class InVehicleActivityDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the in-vehicle state. /// /// 3 - /// In-vehicle state + /// The in-vehicle state. public DetectorState InVehicle { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs index dfcc8de..d952e1f 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// LightSensor changed event arguments. Class for storing the data returned by light sensor + /// The LightSensor changed event arguments class is used for storing the data returned by the light sensor. /// public class LightSensorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the level of the light. /// /// 3 - /// Light level + /// The light level. public float Level { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs index 273c0a2..993a88d 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// LinearAccelerationSensor changed event arguments. Class for storing the data returned by linear acceleration sensor + /// The LinearAccelerationSensor changed event arguments class is used for storing the data returned by the linear acceleration sensor. /// public class LinearAccelerationSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs index eb1803d..2ff8aa6 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Magnetometer changed event arguments. Class for storing the data returned by magnetometer sensor + /// The Magnetometer changed event arguments class is used for storing the data returned by the magnetometer sensor. /// public class MagnetometerDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs index 7ac6ba3..2b3a3ca 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// MagnetometerRotationVectorSensor changed event arguments. Class for storing the data returned by magnetometer rotation vector sensor + /// The MagnetometerRotationVectorSensor changed event arguments class is used for storing the data returned by the magnetometer rotation vector sensor. /// public class MagnetometerRotationVectorSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs index 4fc4b6a..269b48a 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// OrientationSensor changed event arguments. Class for storing the data returned by orientation sensor + /// The OrientationSensor changed event arguments class is used for storing the data returned by the orientation sensor. /// public class OrientationSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs index f4865ac..bf7455a 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Pedometer changed event arguments. Class for storing the data returned by pedometer + /// The Pedometer changed event arguments class is used for storing the data returned by the pedometer. /// public class PedometerDataUpdatedEventArgs : EventArgs { @@ -36,59 +36,59 @@ namespace Tizen.Sensor } /// - /// Gets the step count + /// Gets the step count. /// /// 3 - /// Step count + /// The step count. public uint StepCount { get; private set; } /// - /// Gets the walking step count + /// Gets the walking step count. /// /// 3 - /// Walk step count + /// The walk step count. public uint WalkStepCount { get; private set; } /// - /// Gets the running step count + /// Gets the running step count. /// /// 3 - /// Run step count + /// The run step count. public uint RunStepCount { get; private set; } /// - /// Gets the moving distance + /// Gets the moving distance. /// /// 3 - /// Moving distance + /// The moving distance. public float MovingDistance { get; private set; } /// - /// Gets the calorie burned + /// Gets the calorie burned. /// /// 3 - /// Calorie burned + /// The calorie burned. public float CalorieBurned { get; private set; } /// - /// Gets the last speed + /// Gets the last speed. /// /// 3 - /// Last speed + /// The last speed. public float LastSpeed { get; private set; } /// - /// Gets the last stepping frequency + /// Gets the last stepping frequency. /// /// 3 - /// Last stepping frequency + /// The last stepping frequency. public float LastSteppingFrequency { get; private set; } /// - /// Gets the last step status + /// Gets the last step status. /// /// 3 - /// Last stepping status + /// The last stepping status. public PedometerState LastStepStatus { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs index a5fee58..ed5f3e2 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// PickUpGestureDetector changed event arguments. Class for storing the data returned by pick up gesture detector + /// The PickUpGestureDetector changed event arguments class is used for storing the data returned by the pickup gesture detector. /// public class PickUpGestureDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the pick up state. /// /// 3 - /// Pick up state + /// The pick up state. public DetectorState PickUp { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs index 0cf7b73..f5b1604 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// PressureSensor changed event arguments. Class for storing the data returned by pressure sensor + /// The PressureSensor changed event arguments class is used for storing the data returned by the pressure sensor. /// public class PressureSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs index 2dc8847..76391e2 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// ProximitySensor changed event arguments. Class for storing the data returned by proximity sensor + /// The ProximitySensor changed event arguments class is used for storing the data returned by the proximity sensor. /// public class ProximitySensorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the proximity state. /// /// 3 - /// Proximity state + /// The proximity state. public ProximitySensorState Proximity { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs index 29ddccd..0439ef1 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// RotationVectorSensor changed event arguments. Class for storing the data returned by rotation vector sensor + /// The RotationVectorSensor changed event arguments class is used for storing the data returned by the rotation vector sensor. /// public class RotationVectorSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs index 309ad7d..c84b684 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// RunningActivityDetector changed event arguments. Class for storing the data returned by running activity detector + /// The RunningActivityDetector changed event arguments class is used for storing the data returned by the running activity detector. /// public class RunningActivityDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the running state. /// /// 3 - /// Running state + /// The running state. public DetectorState Running { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs index 8479600..3735cc0 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Sensor accuracy changed event arguments Class. Contains the parameters to be returned through accuracy callback + /// The sensor accuracy changed event arguments class contains the parameters to be returned through the accuracy callback. /// public class SensorAccuracyChangedEventArgs : EventArgs { @@ -33,7 +33,7 @@ namespace Tizen.Sensor /// Gets the time stamp. /// /// 3 - /// Time span + /// The time span. public TimeSpan TimeSpan { get; private set; } /// diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs index fe631ed..c6f24fa 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// SleepMonitor changed event arguments. Class for storing the data returned by sleep monitor + /// The SleepMonitor changed event arguments class is used for storing the data returned by the sleep monitor. /// public class SleepMonitorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the value of the sleep state. /// /// 3 - /// Sleep state + /// The sleep state. public SleepMonitorState SleepState { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs index 2ad9a1d..49e10d1 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// StationaryActivityDetector changed event arguments. Class for storing the data returned by stationary activity detector + /// The StationaryActivityDetector changed event arguments class is used for storing the data returned by the stationary activity detector. /// public class StationaryActivityDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the stationary state. /// /// 3 - /// Stationary state + /// The stationary state. public DetectorState Stationary { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs index 127c725..bfed777 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// TemperatureSensor changed event arguments. Class for storing the data returned by temperature sensor + /// The TemperatureSensor changed event arguments class is used for storing the data returned by the temperature sensor. /// public class TemperatureSensorDataUpdatedEventArgs : EventArgs { diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs index 1a025f9..1b80eb5 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// UltravioletSensor changed event arguments. Class for storing the data returned by ultraviolet sensor + /// The UltravioletSensor changed event arguments class is used for storing the data returned by the ultraviolet sensor. /// public class UltravioletSensorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the value of the ultraviolet index. /// /// 3 - /// Ultraviolet index + /// The ultraviolet index. public float UltravioletIndex { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs index 9475bc0..6004451 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// UncalibratedGyroscope changed event arguments. Class for storing the data returned by uncalibrated gyroscope + /// The UncalibratedGyroscope changed event arguments class is used for storing the data returned by the uncalibrated gyroscope. /// public class UncalibratedGyroscopeDataUpdatedEventArgs : EventArgs { @@ -58,21 +58,21 @@ namespace Tizen.Sensor /// Gets the BiasX component of the uncalibrated gyroscope data. /// /// 3 - /// X bias + /// The X bias. public float BiasX { get; private set; } /// /// Gets the BiasY component of the uncalibrated gyroscope data. /// /// 3 - /// Y bias + /// The Y bias. public float BiasY { get; private set; } /// /// Gets the BiasZ component of the uncalibrated gyroscope data. /// /// 3 - /// Z bias + /// The Z bias. public float BiasZ { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs index b9cfc9c..a456834 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// UncalibratedMagnetometer changed event arguments. Class for storing the data returned by uncalibrated magnetometer + /// The UncalibratedMagnetometer changed event arguments class is used for storing the data returned by the uncalibrated magnetometer. /// public class UncalibratedMagnetometerDataUpdatedEventArgs : EventArgs { @@ -58,21 +58,21 @@ namespace Tizen.Sensor /// Gets the BiasX component of the uncalibrated magnetometer data. /// /// 3 - /// X bias + /// The X bias. public float BiasX { get; private set; } /// /// Gets the BiasY component of the uncalibrated magnetometer data. /// /// 3 - /// Y bias + /// The Y bias. public float BiasY { get; private set; } /// /// Gets the BiasZ component of the uncalibrated magnetometer data. /// /// 3 - /// Z bias + /// The Z bias. public float BiasZ { get; private set; } } } \ No newline at end of file diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs index 0de9fc7..1f3b8a0 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// WalkingActivityDetector changed event arguments. Class for storing the data returned by walking activity detector + /// The WalkingActivityDetector changed event arguments class is used for storing the data returned by the walking activity detector. /// public class WalkingActivityDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the walking state. /// /// 3 - /// Walking state + /// The walking state. public DetectorState Walking { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs b/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs index 811862f..551010d 100755 --- a/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs +++ b/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// WristUpGestureDetector changed event arguments. Class for storing the data returned by wrist up gesture detector + /// The WristUpGestureDetector changed event arguments class is used for storing the data returned by the wrist up gesture detector. /// public class WristUpGestureDetectorDataUpdatedEventArgs : EventArgs { @@ -32,7 +32,7 @@ namespace Tizen.Sensor /// Gets the wrist up state. /// /// 3 - /// Wrist up state + /// The wrist up state. public DetectorState WristUp { get; private set; } } } diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs index 1651eb2..3c0867f 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Accelerometer Sensor Class. Used for registering callbacks for accelerometer and getting accelerometer data + /// The Accelerometer Sensor class is used for registering callbacks for the accelerometer and getting the accelerometer data. /// public sealed class Accelerometer : Sensor { @@ -46,10 +46,10 @@ namespace Tizen.Sensor public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether accelerometer sensor is supported by device. + /// Returns true or false based on whether accelerometer sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -63,8 +63,8 @@ namespace Tizen.Sensor /// Returns the number of accelerometer sensors available on the device. /// /// 3 - /// The count of accelerometer sensors - /// Thrown when the operation is invalid for the current state + /// The count of accelerometer sensors. + /// Thrown when the operation is invalid for the current state. public static int Count { get @@ -79,11 +79,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.accelerometer - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors. /// public Accelerometer(uint index = 0) : base(index) { @@ -96,7 +96,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in accelerometer sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the accelerometer sensor data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs index e9eff3b..061557d 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Activity Detector class for storing common activity information + /// The Activity Detector class is used for storing the common activity information. /// public abstract class ActivityDetector : Sensor { @@ -36,10 +36,10 @@ namespace Tizen.Sensor }; /// - /// Gets the activity accuracy of activity detector + /// Gets the activity accuracy of the activity detector. /// /// 3 - /// Activity accuracy + /// The activity accuracy. public SensorDataAccuracy ActivityAccuracy { get; protected set; } internal ActivityDetector(uint index) : base(index) diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs index 40362d2..7340124 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// FaceDownGestureDetector Class. Used for registering callbacks for face down gesture detector and getting the face down state + /// The FaceDownGestureDetector class is used for registering callbacks for the face down gesture detector and getting the face down state. /// public sealed class FaceDownGestureDetector : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the state of the face down gesture. /// /// 3 - /// Face down state + /// The face down state. public DetectorState FaceDown { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether face down gesture detector is supported by device. + /// Returns true or false based on whether the face down gesture detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of face down gesture detectors available on the device. /// /// 3 - /// The count of face down gesture detectors + /// The count of face down gesture detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.gesture_recognition - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors. /// @@ -97,7 +97,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in face down gesture detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in the face down gesture detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs index c2a38c0..746fef8 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// GravitySensor Class. Used for registering callbacks for gravity sensor and getting gravity data + /// The GravitySensor class is used for registering callbacks for the gravity sensor and getting the gravity data. /// public sealed class GravitySensor : Sensor { @@ -48,10 +48,10 @@ namespace Tizen.Sensor public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether gravity sensor is supported by device. + /// Returns true or false based on whether the gravity sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -65,7 +65,7 @@ namespace Tizen.Sensor /// Returns the number of gravity sensors available on the device. /// /// 3 - /// The count of gravity sensors + /// The count of gravity sensors. public static int Count { get @@ -80,11 +80,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.gravity - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors. /// public GravitySensor (uint index = 0) : base(index) { @@ -97,14 +97,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in gravity sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the gravity sensor data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs index 192f076..2045448 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Gyroscope Sensor Class. Used for registering callbacks for gyroscope and getting gyroscope data + /// The Gyroscope Sensor class is used for registering callbacks for the gyroscope and getting the gyroscope data. /// public sealed class Gyroscope : Sensor { @@ -47,10 +47,10 @@ namespace Tizen.Sensor public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether gyroscope sensor is supported by device. + /// Returns true or false based on whether the gyroscope sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -61,10 +61,10 @@ namespace Tizen.Sensor } /// - /// Returns the number of gyroscope sensors available on the device. + /// Returns the number of the gyroscope sensors available on the device. /// /// 3 - /// The count of gyroscope sensors + /// The count of the gyroscope sensors. public static int Count { get @@ -79,11 +79,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.gyroscope - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors. /// public Gyroscope(uint index = 0) : base(index) { @@ -96,7 +96,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in gyroscope sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs index 2f52a1d..0ab13a9 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// GyroscopeRotationVectorSensor Class. Used for registering callbacks for gyroscope rotation vector sensor and getting gyroscope rotation vector data + /// The GyroscopeRotationVectorSensor class is used for registering callbacks for the gyroscope rotation vector sensor and getting the gyroscope rotation vector data. /// public sealed class GyroscopeRotationVectorSensor : Sensor { @@ -54,17 +54,17 @@ namespace Tizen.Sensor public float W { get; private set; } = float.MinValue; /// - /// Gets the Accuracy of the gyroscope rotation vector data. + /// Gets the accuracy of the gyroscope rotation vector data. /// /// 3 /// Accuracy public SensorDataAccuracy Accuracy { get; private set; } /// - /// Returns true or false based on whether gyroscope rotation vector sensor is supported by device. + /// Returns true or false based on whether the gyroscope rotation vector sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -75,10 +75,10 @@ namespace Tizen.Sensor } /// - /// Returns the number of gyroscope rotation vector sensors available on the device. + /// Returns the number of the gyroscope rotation vector sensors available on the device. /// /// 3 - /// The count of accelerometer rotation vector sensors + /// The count of accelerometer rotation vector sensors. public static int Count { get @@ -93,11 +93,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.gyroscope_rotation_vector - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors. /// public GyroscopeRotationVectorSensor(uint index = 0) : base(index) { @@ -110,7 +110,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in gyroscope rotation vector sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope rotation vector sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs index 0e254ea..e6c6f48 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// HeartRateMonitor Class. Used for registering callbacks for heart rate monitor and getting heart rate data + /// The HeartRateMonitor class is used for registering callbacks for the heart rate monitor and getting the heart rate data. /// public sealed class HeartRateMonitor : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the value of the heart rate monitor. /// /// 3 - /// Heart rate + /// The heart rate. public int HeartRate { get; private set; } = int.MinValue; /// - /// Returns true or false based on whether heart rate monitor is supported by device. + /// Returns true or false based on whether the heart rate monitor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of heart rate monitors available on the device. /// /// 3 - /// The count of heart rate monitors + /// The count of heart rate monitors. public static int Count { get @@ -67,12 +67,12 @@ namespace Tizen.Sensor /// http://tizen.org/privilege/healthinfo /// public /// http://tizen.org/feature/sensor.heart_rate_monitor - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the app has no privilege to use the sensor - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the application has no privilege to use the sensor. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors. /// public HeartRateMonitor(uint index = 0) : base(index) { @@ -85,7 +85,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the heart rate monitor data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs index 3ef6def..d2abaf3 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// HumiditySensor Class. Used for registering callbacks for humidity sensor and getting humidity data + /// The HumiditySensor class is used for registering callbacks for the humidity sensor and getting the humidity data. /// public sealed class HumiditySensor : Sensor { @@ -33,10 +33,10 @@ namespace Tizen.Sensor public float Humidity { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether humidity sensor is supported by device. + /// Returns true or false based on whether the humidity sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of humidity sensors available on the device. /// /// 3 - /// The count of humidity sensors + /// The count of humidity sensors. public static int Count { get @@ -65,11 +65,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.humidity - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors. /// public HumiditySensor(uint index = 0) : base(index) { @@ -82,7 +82,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in humidity sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the humidity sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs index 0d6aa55..787d2d6 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs @@ -19,24 +19,24 @@ using System; namespace Tizen.Sensor { /// - /// InVehicleActivityDetector Class. Used for registering callbacks for in vehicle activity detector and getting the in vehicle state + /// The InVehicleActivityDetector class is used for registering callbacks for the in-vehicle activity detector and getting the in-vehicle state. /// public sealed class InVehicleActivityDetector : ActivityDetector { private const string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of in-vehicle activity detector + /// Gets the state of the in-vehicle activity detector. /// /// 3 - /// In-vehicle state + /// The in-vehicle state. public DetectorState InVehicle { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether in-vehicle activity detector is supported by device. + /// Returns true or false based on whether the in-vehicle activity detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of in-vehicle activity detectors available on the device. /// /// 3 - /// The count of in-vehicle activity detectors + /// The count of in-vehicle activity detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular in-vehicle activity detector in case of multiple sensors. /// @@ -93,7 +93,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in in-vehicle activity detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in the in-vehicle activity detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs index 2ec7c43..16d7615 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs @@ -19,24 +19,24 @@ using System; namespace Tizen.Sensor { /// - /// LightSensor Class. Used for registering callbacks for light sensor and getting light data + /// The LightSensor class is used for registering callbacks for the light sensor and getting the light data. /// public sealed class LightSensor : Sensor { private const string LightSensorKey = "http://tizen.org/feature/sensor.photometer"; /// - /// Gets the Level of the light. + /// Gets the level of the light. /// /// 3 - /// Light level + /// The light level. public float Level { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether light sensor is supported by device. + /// Returns true or false based on whether the light sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of light sensors available on the device. /// /// 3 - /// The count of light sensors + /// The count of light sensors. public static int Count { get @@ -65,11 +65,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.photometer - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors. /// public LightSensor(uint index = 0) : base(index) { @@ -82,7 +82,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in light sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the light sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs index 6fbf056..b75a2de 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// LinearAccelerationSensor Class. Used for registering callbacks for linear acceleration sensor and getting linear acceleration data + /// The LinearAccelerationSensor class is used for registering callbacks for the linear acceleration sensor and getting the linear acceleration data. /// public sealed class LinearAccelerationSensor : Sensor { @@ -48,10 +48,10 @@ namespace Tizen.Sensor public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether linear acceleration sensor is supported by device. + /// Returns true or false based on whether the linear acceleration sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -65,7 +65,7 @@ namespace Tizen.Sensor /// Returns the number of linear acceleration sensors available on the device. /// /// 3 - /// The count of linear acceleration sensors + /// The count of linear acceleration sensors. public static int Count { get @@ -80,11 +80,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.linear_acceleration - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors. /// public LinearAccelerationSensor(uint index = 0) : base(index) { @@ -97,14 +97,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in linear acceleration sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the linear acceleration sensor data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs index 83dd226..9845eae 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// Magnetometer Class. Used for registering callbacks for magnetometer and getting magnetometer data + /// The Magnetometer class is used for registering callbacks for the magnetometer and getting the magnetometer data. /// public sealed class Magnetometer : Sensor { @@ -48,10 +48,10 @@ namespace Tizen.Sensor public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether magnetometer is supported by device. + /// Returns true or false based on whether magnetometer is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -65,7 +65,7 @@ namespace Tizen.Sensor /// Returns the number of magnetometers available on the device. /// /// 3 - /// The count of magnetometers + /// The count of magnetometers. public static int Count { get @@ -80,11 +80,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.magnetometer - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors. /// public Magnetometer(uint index = 0) : base(index) { @@ -97,14 +97,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in magnetometer data. + /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs index 02afa13..2a103d3 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// MagnetometerRotationVectorSensor Class. Used for registering callbacks for magnetometer rotation vector sensor and getting magnetometer rotation vector data + /// The MagnetometerRotationVectorSensor class is used for registering callbacks for the magnetometer rotation vector sensor and getting the magnetometer rotation vector data. /// public sealed class MagnetometerRotationVectorSensor : Sensor { @@ -55,17 +55,17 @@ namespace Tizen.Sensor public float W { get; private set; } = float.MinValue; /// - /// Gets the Accuracy of the magnetometer rotation vector data. + /// Gets the accuracy of the magnetometer rotation vector data. /// /// 3 /// Accuracy public SensorDataAccuracy Accuracy { get; private set; } /// - /// Returns true or false based on whether magnetometer rotation vector sensor is supported by device. + /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -79,7 +79,7 @@ namespace Tizen.Sensor /// Returns the number of magnetometer rotation vector sensors available on the device. /// /// 3 - /// The count of magnetometer rotation vector sensors + /// The count of magnetometer rotation vector sensors. public static int Count { get @@ -94,11 +94,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.geomagnetic_rotation_vector - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors. /// public MagnetometerRotationVectorSensor(uint index = 0) : base(index) { @@ -111,14 +111,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in magnetometer rotation vector sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs index 2bba50a..de58ddc 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// OrientationSensor Class. Used for registering callbacks for orientation sensor and getting orientation data + /// The OrientationSensor class is used for registering callbacks for the orientation sensor and getting the orientation data. /// public sealed class OrientationSensor : Sensor { @@ -27,31 +27,31 @@ namespace Tizen.Sensor private event EventHandler _accuracyChanged; /// - /// Gets the Azimuth component of the orientation. + /// Gets the azimuth component of the orientation. /// /// 3 /// Azimuth public float Azimuth { get; private set; } = float.MinValue; /// - /// Gets the Pitch component of the orientation. + /// Gets the pitch component of the orientation. /// /// 3 /// Pitch public float Pitch { get; private set; } = float.MinValue; /// - /// Gets the Roll component of the orientation. + /// Gets the roll component of the orientation. /// /// 3 /// Roll public float Roll { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether orientation sensor is supported by device. + /// Returns true or false based on whether the orientation sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -65,7 +65,7 @@ namespace Tizen.Sensor /// Returns the number of orientation sensors available on the device. /// /// 3 - /// The count of orientation sensors + /// The count of orientation sensors. public static int Count { get @@ -80,11 +80,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.tiltmeter - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors. /// public OrientationSensor(uint index = 0) : base(index) { @@ -97,14 +97,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in orientation sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the orientation sensor data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs index 8f39050..2f778f3 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs @@ -19,73 +19,73 @@ using System; namespace Tizen.Sensor { /// - /// Pedometer Sensor Class. Used for registering callbacks for pedometer and getting pedometer data + /// The Pedometer Sensor class is used for registering callbacks for the pedometer and getting the pedometer data. /// public sealed class Pedometer : Sensor { private static string PedometerKey = "http://tizen.org/feature/sensor.pedometer"; /// - /// Gets the step count + /// Gets the step count. /// /// 3 - /// Step count + /// The step count. public uint StepCount { get; private set; } = 0; /// - /// Gets the walking step count + /// Gets the walking step count. /// /// 3 - /// Walk step count + /// The walk step count. public uint WalkStepCount { get; private set; } = 0; /// - /// Gets the running step count + /// Gets the running step count. /// /// 3 - /// Run step count + /// The run step count. public uint RunStepCount { get; private set; } = 0; /// - /// Gets the moving distance + /// Gets the moving distance. /// /// 3 - /// Moving distance + /// The moving distance. public float MovingDistance { get; private set; } = 0; /// - /// Gets the calorie burned + /// Gets the calorie burned. /// /// 3 - /// Calorie Burned + /// The calorie burned. public float CalorieBurned { get; private set; } = 0; /// - /// Gets the last speed + /// Gets the last speed. /// /// 3 - /// Last speed + /// The last speed. public float LastSpeed { get; private set; } = 0; /// - /// Gets the last stepping frequency + /// Gets the last stepping frequency. /// /// 3 - /// Last stepping frequency + /// The last stepping frequency. public float LastSteppingFrequency { get; private set; } = 0; /// - /// Gets the last step status + /// Gets the last step status. /// /// 3 - /// Last step status + /// The last step status. public PedometerState LastStepStatus { get; private set; } = PedometerState.Unknown; /// - /// Returns true or false based on whether pedometer sensor is supported by device. + /// Returns true or false based on whether the pedometer sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -99,7 +99,7 @@ namespace Tizen.Sensor /// Returns the number of pedometer sensors available on the device. /// /// 3 - /// The count of pedometer sensors + /// The count of pedometer sensors. public static int Count { get @@ -116,12 +116,12 @@ namespace Tizen.Sensor /// http://tizen.org/privilege/healthinfo /// public /// http://tizen.org/feature/sensor.pedometer - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the app has no privilege to use the sensor - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the application has no privilege to use the sensor. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors. /// public Pedometer(uint index = 0) : base(index) { @@ -134,7 +134,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in pedometer sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the pedometer sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs index f0a870b..115afc1 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// PickUpGestureDetector Class. Used for registering callbacks for pick up activity detector and getting the pick up state + /// The PickUpGestureDetector class is used for registering callbacks for the pick up activity detector and getting the pick up state. /// public sealed class PickUpGestureDetector : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the state of the pick up gesture. /// /// 3 - /// Pick up state + /// The pick up state. public DetectorState PickUp { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether pick up gesture detector is supported by device. + /// Returns true or false based on whether the pick up gesture detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of pick up gesture detectors available on the device. /// /// 3 - /// The count of pick up gesture detectors + /// The count of pick up gesture detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.gesture_recognition - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular pick up gesture detector in case of multiple sensors. /// @@ -109,7 +109,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in pick up gesture detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in the pick up gesture detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs index f17c590..e8fc7eb 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// PressureSensor Class. Used for registering callbacks for pressure sensor and getting pressure data + /// The PressureSensor class is used for registering callbacks for the pressure sensor and getting the pressure data. /// public sealed class PressureSensor : Sensor { @@ -33,10 +33,10 @@ namespace Tizen.Sensor public float Pressure { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether pressure sensor is supported by device. + /// Returns true or false based on whether the pressure sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of pressure sensors available on the device. /// /// 3 - /// The count of pressure sensors + /// The count of pressure sensors. public static int Count { get @@ -65,11 +65,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.barometer - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors. /// public PressureSensor(uint index = 0) : base(index) { @@ -82,7 +82,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in pressure sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the pressure sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs index 927087a..9d2d8f8 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// ProximitySensor Class. Used for registering callbacks for proximity sensor and getting proximity data + /// The ProximitySensor class is used for registering callbacks for the proximity sensor and getting the proximity data. /// public sealed class ProximitySensor : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the proximity state. /// /// 3 - /// Proximity state + /// The proximity state. public ProximitySensorState Proximity { get; private set; } = ProximitySensorState.Unknown; /// - /// Returns true or false based on whether proximity sensor is supported by device. + /// Returns true or false based on whether the proximity sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of proximity sensors available on the device. /// /// 3 - /// The count of proximity sensors + /// The count of proximity sensors. public static int Count { get @@ -65,11 +65,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.proximity - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state.exception> /// - /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors. /// public ProximitySensor(uint index = 0) : base(index) { @@ -82,7 +82,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in proximity sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the proximity sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs index 8489d11..a07e058 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// RotationVectorSensor Class. Used for registering callbacks for rotation vector sensor and getting rotation vector data + /// The RotationVectorSensor class is used for registering callbacks for the rotation vector sensor and getting the rotation vector data. /// public sealed class RotationVectorSensor : Sensor { @@ -55,17 +55,17 @@ namespace Tizen.Sensor public float W { get; private set; } = float.MinValue; /// - /// Gets the Accuracy of the rotation vector data. + /// Gets the accuracy of the rotation vector data. /// /// 3 /// Accuracy public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined; /// - /// Returns true or false based on whether rotation vector sensor is supported by device. + /// Returns true or false based on whether the rotation vector sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -79,7 +79,7 @@ namespace Tizen.Sensor /// Returns the number of rotation vector sensors available on the device. /// /// 3 - /// The count of rotation vector sensors + /// The count of rotation vector sensors. public static int Count { get @@ -94,11 +94,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.rotation_vector - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors. /// public RotationVectorSensor(uint index = 0) : base(index) { @@ -111,14 +111,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in rotation vector sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the rotation vector sensor data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs index fc2ec5b..f2a3be7 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs @@ -19,24 +19,24 @@ using System; namespace Tizen.Sensor { /// - /// RunningActivityDetector Class. Used for registering callbacks for running activity detector and getting the running state + /// The RunningActivityDetector class is used for registering callbacks for running the activity detector and getting the running state. /// public sealed class RunningActivityDetector : ActivityDetector { private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of running activity detector + /// Gets the state of the running activity detector. /// /// 3 - /// Running state + /// The running state. public DetectorState Running { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether running activity detector is supported by device. + /// Returns true or false based on whether the running activity detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -47,10 +47,10 @@ namespace Tizen.Sensor } /// - /// Returns the number of running activity detector available on the device. + /// Returns the number of running activity detectors available on the device. /// /// 3 - /// The count of running activity detectors + /// The count of running activity detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular running activity detector in case of multiple sensors. /// @@ -93,7 +93,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in running activity detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in running the activity detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs index 8291cfa..e9c8578 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// SleepMonitor Class. Used for registering callbacks for sleep monitor and getting sleep data + /// The SleepMonitor class is used for registering callbacks for the sleep monitor and getting the sleep data. /// public sealed class SleepMonitor : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the value of the sleep state. /// /// 3 - /// Sleep state + /// The sleep state. public SleepMonitorState SleepState { get; private set; } = SleepMonitorState.Unknown; /// - /// Returns true or false based on whether sleep monitor is supported by device. + /// Returns true or false based on whether the sleep monitor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of sleep monitors available on the device. /// /// 3 - /// The count of sleep monitors + /// The count of sleep monitors. public static int Count { get @@ -67,12 +67,12 @@ namespace Tizen.Sensor /// http://tizen.org/privilege/healthinfo /// public /// http://tizen.org/feature/sensor.sleep_monitor - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the app has no privilege to use the sensor - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the application has no privilege to use the sensor. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors. /// public SleepMonitor(uint index = 0) : base(index) { @@ -85,7 +85,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in sleep monitor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs index c8b0251..74d88c1 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs @@ -19,24 +19,24 @@ using System; namespace Tizen.Sensor { /// - /// StationaryActivityDetector Class. Used for registering callbacks for stationary activity detector and getting the stationary state + /// The StationaryActivityDetector class is used for registering callbacks for the stationary activity detector and getting the stationary state. /// public sealed class StationaryActivityDetector : ActivityDetector { private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of stationary activity detector + /// Gets the state of the stationary activity detector. /// /// 3 - /// Stationary state + /// The stationary state. public DetectorState Stationary { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether stationary activity detector is supported by device. + /// Returns true or false based on whether the stationary activity detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of stationary activity detectors available on the device. /// /// 3 - /// The count of stationary activity detectors + /// The count of stationary activity detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular stationary activity detector in case of multiple sensors. /// @@ -93,7 +93,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in stationary activity detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in the stationary activity detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs index b90b1bc..b7dcfb8 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// TemperatureSensor Class. Used for registering callbacks for temperature sensor and getting temperature data + /// The TemperatureSensor class is used for registering callbacks for the temperature sensor and getting the temperature data. /// public sealed class TemperatureSensor : Sensor { @@ -33,10 +33,10 @@ namespace Tizen.Sensor public float Temperature { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether temperature sensor is supported by device. + /// Returns true or false based on whether the temperature sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of temperature sensors available on the device. /// /// 3 - /// The count of temperature sensors + /// The count of temperature sensors. public static int Count { get @@ -65,11 +65,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.temperature - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors. /// public TemperatureSensor(uint index = 0) : base(index) { @@ -82,7 +82,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in temperature sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the temperature sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs index 07c3d2e..491716a 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// UltravioletSensor Class. Used for registering callbacks for ultraviolet sensor and getting ultraviolet data + /// The UltravioletSensor class is used for registering callbacks for the ultraviolet sensor and getting the ultraviolet data. /// public sealed class UltravioletSensor : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the value of the ultraviolet sensor. /// /// 3 - /// Ultraviolet index + /// The ultraviolet index. public float UltravioletIndex { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether ultraviolet sensor is supported by device. + /// Returns true or false based on whether the ultraviolet sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of ultraviolet sensors available on the device. /// /// 3 - /// The count of ultraviolet sensors + /// The count of ultraviolet sensors. public static int Count { get @@ -65,11 +65,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.ultraviolet - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors. /// public UltravioletSensor(uint index = 0) : base(index) { @@ -82,7 +82,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in ultraviolet sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the ultraviolet sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs index 18900d5..58d90ae 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// UncalibratedGyroscope Sensor Class. Used for registering callbacks for uncalibrated gyroscope and getting uncalibrated gyroscope data + /// The UncalibratedGyroscope sensor class is used for registering callbacks for the uncalibrated gyroscope and getting the uncalibrated gyroscope data. /// public sealed class UncalibratedGyroscope : Sensor { @@ -50,28 +50,28 @@ namespace Tizen.Sensor /// Gets the BiasX component of the uncalibrated gyroscope data. /// /// 3 - /// X bias + /// The X bias. public float BiasX { get; private set; } = 0; /// /// Gets the BiasY component of the uncalibrated gyroscope data. /// /// 3 - /// Y bias + /// The Y bias. public float BiasY { get; private set; } = 0; /// /// Gets the BiasZ component of the uncalibrated gyroscope data. /// /// 3 - /// Z bias + /// The Z bias. public float BiasZ { get; private set; } = 0; /// - /// Returns true or false based on whether uncalibrated gyroscope sensor is supported by device. + /// Returns true or false based on whether the uncalibrated gyroscope sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -82,10 +82,10 @@ namespace Tizen.Sensor } /// - /// Returns the number of uncalibrated gyroscope sensors available on the device. + /// Returns the number of the uncalibrated gyroscope sensors available on the device. /// /// 3 - /// The count of uncalibrated gyroscope sensors + /// The count of the uncalibrated gyroscope sensors. public static int Count { get @@ -100,11 +100,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.gyroscope.uncalibrated - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors. /// public UncalibratedGyroscope(uint index = 0) : base(index) { @@ -117,7 +117,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in uncalibrated gyroscope sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated gyroscope sensor data. /// /// 3 diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs index 04709e7..8eb53e9 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// UncalibratedMagnetometer Sensor Class. Used for registering callbacks for uncalibrated magnetometer and getting uncalibrated magnetometer data + /// The UncalibratedMagnetometer sensor class is used for registering callbacks for the uncalibrated magnetometer and getting the uncalibrated magnetometer data. /// public sealed class UncalibratedMagnetometer : Sensor { @@ -51,28 +51,28 @@ namespace Tizen.Sensor /// Gets the BiasX component of the uncalibrated magnetometer data. /// /// 3 - /// X bias + /// The X bias. public float BiasX { get; private set; } = 0; /// /// Gets the BiasY component of the uncalibrated magnetometer data. /// /// 3 - /// Y bias + /// The Y bias. public float BiasY { get; private set; } = 0; /// /// Gets the BiasZ component of the uncalibrated magnetometer data. /// /// 3 - /// Z bias + /// The Z bias. public float BiasZ { get; private set; } = 0; /// - /// Returns true or false based on whether uncalibrated magnetometer sensor is supported by device. + /// Returns true or false based on whether the uncalibrated magnetometer sensor is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -86,7 +86,7 @@ namespace Tizen.Sensor /// Returns the number of uncalibrated magnetometer sensors available on the device. /// /// 3 - /// The count of uncalibrated magnetometer sensors + /// The count of uncalibrated magnetometer sensors. public static int Count { get @@ -101,11 +101,11 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.magnetometer.uncalibrated - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// - /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors + /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors. /// public UncalibratedMagnetometer(uint index = 0) : base(index) { @@ -118,14 +118,14 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in uncalibrated magnetometer sensor data. + /// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated magnetometer sensor data. /// /// 3 public event EventHandler DataUpdated; /// - /// Event handler for accuracy changed events. + /// An event handler for accuracy changed events. /// /// 3 public event EventHandler AccuracyChanged diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs index 8fd5960..6e5c162 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs @@ -19,24 +19,24 @@ using System; namespace Tizen.Sensor { /// - /// WalkingActivityDetector Class. Used for registering callbacks for walking activity detector and getting the walking state + /// The WalkingActivityDetector class is used for registering callbacks for the walking activity detector and getting the walking state. /// public sealed class WalkingActivityDetector : ActivityDetector { private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of walking activity detector + /// Gets the state of the walking activity detector. /// /// 3 - /// Walking state + /// The walking state. public DetectorState Walking { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether walking activity detector is supported by device. + /// Returns true or false based on whether the walking activity detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of walking activity detectors available on the device. /// /// 3 - /// The count of walking activity detectors + /// The count of walking activity detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular walking activity detector in case of multiple sensors. /// @@ -93,7 +93,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in walking activity gesture detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in the walking activity gesture detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs index 761e374..b4a3636 100755 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Sensor { /// - /// WristUpGestureDetector Class. Used for registering callbacks for wrist up gesture detector and getting the wrist up state + /// The WristUpGestureDetector class is used for registering callbacks for the wrist up gesture detector and getting the wrist up state. /// public sealed class WristUpGestureDetector : Sensor { @@ -29,14 +29,14 @@ namespace Tizen.Sensor /// Gets the state of the wrist up gesture. /// /// 3 - /// Wrist up state + /// The wrist up state. public DetectorState WristUp { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether wrist up gesture detector is supported by device. + /// Returns true or false based on whether the wrist up gesture detector is supported by the device. /// /// 3 - /// true if supported; otherwise, false. + /// true if supported; otherwise false. public static bool IsSupported { get @@ -50,7 +50,7 @@ namespace Tizen.Sensor /// Returns the number of wrist up gesture detectors available on the device. /// /// 3 - /// The count of wrist up gesture detectors + /// The count of wrist up gesture detectors. public static int Count { get @@ -65,9 +65,9 @@ namespace Tizen.Sensor /// /// 3 /// http://tizen.org/feature/sensor.wrist_up - /// Thrown when an invalid argument is used - /// Thrown when the sensor is not supported - /// Thrown when the operation is invalid for the current state + /// Thrown when an invalid argument is used. + /// Thrown when the sensor is not supported. + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular wrist up gesture detector in case of multiple sensors. /// @@ -97,7 +97,7 @@ namespace Tizen.Sensor } /// - /// Event Handler for storing the callback functions for event corresponding to change in wrist up gesture detector data. + /// An event handler for storing the callback functions for the event corresponding to the change in the wrist up gesture detector data. /// /// 3 public event EventHandler DataUpdated; diff --git a/Tizen.Sensor/Tizen.Sensor/Sensor.cs b/Tizen.Sensor/Tizen.Sensor/Sensor.cs index fa512c2..9b48dee 100755 --- a/Tizen.Sensor/Tizen.Sensor/Sensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Sensor.cs @@ -25,7 +25,7 @@ namespace Tizen.Sensor } /// - /// Sensor class for storing hardware information about a particular sensor + /// The Sensor class is used for storing the hardware information about a particular sensor. /// public abstract class Sensor : IDisposable { @@ -67,10 +67,10 @@ namespace Tizen.Sensor } /// - /// Property: For getting the name of the sensor + /// Property: Gets the name of the sensor. /// /// 3 - /// The name of sensor + /// The name of the sensor. public string Name { get @@ -84,7 +84,7 @@ namespace Tizen.Sensor /// Property: Gets the vendor. /// /// 3 - /// The vendor name of sensor + /// The vendor name of the sensor. public string Vendor { get @@ -95,10 +95,10 @@ namespace Tizen.Sensor } /// - /// Property: Gets the minimum value of range of sensor data. + /// Property: Gets the minimum value of the range of the sensor data. /// /// 3 - /// The lower bound of range of sensor reading + /// The lower bound of the range of the sensor reading. public float MinValue { get @@ -109,10 +109,10 @@ namespace Tizen.Sensor } /// - /// Property: Gets the maximum value of range of sensor data. + /// Property: Gets the maximum value of the range of the sensor data. /// /// 3 - /// The upper bound of range of sensor reading + /// The upper bound of the range of the sensor reading. public float MaxValue { get @@ -126,7 +126,7 @@ namespace Tizen.Sensor /// Property: Gets the resolution. /// /// 3 - /// The resolution + /// The resolution. public float Resolution { get @@ -140,7 +140,7 @@ namespace Tizen.Sensor /// Property: Gets the minimum interval. /// /// 3 - /// The minimum update interval + /// The minimum update interval. public int MinInterval { get @@ -151,10 +151,10 @@ namespace Tizen.Sensor } /// - /// Property: Gets the fifo count. + /// Property: Gets the FIFO count. /// /// 3 - /// The size of the hardware FIFO + /// The size of the hardware FIFO. public int FifoCount { get @@ -168,7 +168,7 @@ namespace Tizen.Sensor /// Property: Gets the maximum batch count. /// /// 3 - /// The maximum batch count + /// The maximum batch count. public int MaxBatchCount { get @@ -179,12 +179,12 @@ namespace Tizen.Sensor } /// - /// Sets the interval of the sensor for sensor data event - /// Callbacks will be called at frequency of this interval + /// Sets the interval of the sensor for the sensor data event. + /// Callbacks will be called at the frequency of this interval. /// /// 3 - /// Thrown when the operation is invalid for the current state - /// The interval of the sensor + /// Thrown when the operation is invalid for the current state. + /// The interval of the sensor. public uint Interval { set @@ -201,11 +201,11 @@ namespace Tizen.Sensor } /// - /// Sets the max batch latency for the sensor corresponding to the sensor data event. + /// Sets the maximum batch latency for the sensor corresponding to the sensor data event. /// /// 3 - /// Thrown when the operation is invalid for the current state - /// The max batch latency + /// Thrown when the operation is invalid for the current state. + /// The maximum batch latency. public uint MaxBatchLatency { set @@ -225,9 +225,9 @@ namespace Tizen.Sensor /// Sets the pause policy of the sensor. /// /// 3 - /// The pause policy - /// Thrown when the operation is invalid for the current state - /// The pause policy + /// The pause policy. + /// Thrown when the operation is invalid for the current state. + /// The pause policy. public SensorPausePolicy PausePolicy { set @@ -247,7 +247,7 @@ namespace Tizen.Sensor /// Gets or sets the time span. /// /// 3 - /// The time span + /// The time span. public TimeSpan TimeSpan { set @@ -266,7 +266,7 @@ namespace Tizen.Sensor /// Indicates whether this sensor is sensing. /// /// 3 - /// true if this sensor is sensing; otherwise, false. + /// true if this sensor is sensing; otherwise false. public bool IsSensing { get @@ -307,10 +307,10 @@ namespace Tizen.Sensor /// /// Starts the sensor. - /// After this the event handlers will start receiving events. + /// After this, event handlers will start receiving events. /// /// 3 - /// Thrown when the operation is invalid for the current state + /// Thrown when the operation is invalid for the current state. public void Start() { Log.Info(Globals.LogTag, "Starting the sensor"); @@ -329,11 +329,11 @@ namespace Tizen.Sensor } /// - /// Stop the sensor. - /// After this the event handlers will stop receiving the events + /// Stops the sensor. + /// After this, event handlers will stop receiving events. /// /// 3 - /// Thrown when the operation is invalid for the current state + /// Thrown when the operation is invalid for the current state. public void Stop() { Log.Info(Globals.LogTag, "Stopping the sensor"); diff --git a/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs b/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs index 84e2571..dc1c7d1 100755 --- a/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs +++ b/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs @@ -24,7 +24,7 @@ namespace Tizen.Sensor internal enum SensorType { /// - /// All sensors. This can be used to retrieve Sensor class object for all available sensors. + /// All sensors. This can be used to retrieve the Sensor class object for all available sensors. /// All = -1, /// @@ -52,7 +52,7 @@ namespace Tizen.Sensor /// OrientationSensor = 5, /// - /// Gyroscope sensor. + /// The Gyroscope sensor. /// Gyroscope = 6, /// @@ -84,7 +84,7 @@ namespace Tizen.Sensor /// HeartRateMonitor = 13, /// - /// Uncalibrated Gyroscope sensor. + /// The Uncalibrated Gyroscope sensor. /// UncalibratedGyroscope = 17, /// @@ -92,7 +92,7 @@ namespace Tizen.Sensor /// UncalibratedMagnetometer = 18, /// - /// Gyroscope-based rotation vector sensor. + /// The Gyroscope-based rotation vector sensor. /// GyroscopeRotationVectorSensor = 19, /// @@ -138,7 +138,7 @@ namespace Tizen.Sensor } /// - /// Sensor attribute. + /// The sensor attribute. /// internal enum SensorAttribute { @@ -154,7 +154,7 @@ namespace Tizen.Sensor } /// - /// SensorDataAccuracy Enum definition for all possible sensor data accuracy Values. + /// The SensorDataAccuracy Enum definition for all possible sensor data accuracy values. /// /// 3 public enum SensorDataAccuracy @@ -187,7 +187,7 @@ namespace Tizen.Sensor } /// - /// Sensor Option Enum definition for sensor option Values + /// The Sensor Option Enum definition for sensor option values. /// /// 3 public enum SensorPausePolicy @@ -215,7 +215,7 @@ namespace Tizen.Sensor } /// - /// Pedometer state. + /// The pedometer state. /// /// 3 public enum PedometerState @@ -246,7 +246,7 @@ namespace Tizen.Sensor } /// - /// Sleep monitor state. + /// The sleep monitor state. /// /// 3 public enum SleepMonitorState @@ -271,7 +271,7 @@ namespace Tizen.Sensor } /// - /// Proximity sensor state. + /// The proximity sensor state. /// /// 3 public enum ProximitySensorState @@ -296,7 +296,7 @@ namespace Tizen.Sensor } /// - /// Detector sensor state. + /// The detector sensor state. /// /// 3 public enum DetectorState