From 840a91a8158441979a996f9d7448aa6ad25677fb Mon Sep 17 00:00:00 2001 From: SangYoun Kwak Date: Wed, 25 Sep 2024 19:23:10 +0900 Subject: [PATCH] Tizen.Sensor: Update description of sensor class/methods The description of the classes and methods of Tizen.Sensor are updated for these tags: summary, remarks, see, seealso Signed-off-by: SangYoun Kwak --- src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs | 19 ++- .../Tizen.Sensor/Plugins/Accelerometer.cs | 10 +- .../Tizen.Sensor/Plugins/ActivityDetector.cs | 2 +- .../Plugins/AutoRotationSensor.cs | 15 ++- .../Plugins/FaceDownGestureDetector.cs | 13 +- .../Tizen.Sensor/Plugins/GravitySensor.cs | 21 +-- .../Tizen.Sensor/Plugins/Gyroscope.cs | 18 +-- .../Plugins/GyroscopeRotationVectorSensor.cs | 20 +-- .../Tizen.Sensor/Plugins/HeartRateMonitor.cs | 11 +- .../Plugins/HeartRateMonitorBatch.cs | 16 ++- .../Plugins/HeartRateMonitorLEDGreenBatch.cs | 16 ++- .../Tizen.Sensor/Plugins/HumiditySensor.cs | 12 +- .../Plugins/InVehicleActivityDetector.cs | 13 +- .../Tizen.Sensor/Plugins/LightSensor.cs | 12 +- .../Plugins/LinearAccelerationSensor.cs | 19 +-- .../Tizen.Sensor/Plugins/Magnetometer.cs | 19 +-- .../MagnetometerRotationVectorSensor.cs | 25 ++-- .../Tizen.Sensor/Plugins/OrientationSensor.cs | 19 +-- .../Tizen.Sensor/Plugins/Pedometer.cs | 28 ++-- .../Plugins/PickUpGestureDetector.cs | 13 +- .../Tizen.Sensor/Plugins/PressureSensor.cs | 12 +- .../Tizen.Sensor/Plugins/ProximitySensor.cs | 14 +- .../Plugins/RotationVectorSensor.cs | 25 ++-- .../Plugins/RunningActivityDetector.cs | 13 +- .../Tizen.Sensor/Plugins/SleepMonitor.cs | 14 +- .../Plugins/StationaryActivityDetector.cs | 13 +- .../Tizen.Sensor/Plugins/TemperatureSensor.cs | 12 +- .../Tizen.Sensor/Plugins/UltravioletSensor.cs | 12 +- .../Plugins/UncalibratedGyroscope.cs | 22 +-- .../Plugins/UncalibratedMagnetometer.cs | 25 ++-- .../Plugins/WalkingActivityDetector.cs | 13 +- .../Plugins/WristUpGestureDetector.cs | 13 +- src/Tizen.Sensor/Tizen.Sensor/Sensor.cs | 126 ++++++++++++++++-- 33 files changed, 392 insertions(+), 243 deletions(-) diff --git a/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs index aafc00f15..a0a5260c9 100644 --- a/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs @@ -20,8 +20,13 @@ using System.Collections.Generic; namespace Tizen.Sensor { /// - /// Abstract sensor for series of sensor data + /// Abstract class for sensor for series of sensor data. + /// Inherit the class 'Sensor' which is an abstract class. /// + /// + /// A class which inherits this abstract class should provide TData as an + /// class that inherits BatchData class. + /// /// 8 public abstract class BatchSensor : Sensor where TData : Tizen.Sensor.BatchData { @@ -40,15 +45,23 @@ namespace Tizen.Sensor public IReadOnlyList Data { get; protected set; } /// - /// Convert general batch data to specific batch data + /// Convert general batch data to specific batch data type "TData". /// /// 8 /// List of converted specific batch data protected abstract IReadOnlyList ConvertBatchData(); /// - /// Update the internal batch data using the latest events + /// Update the internal batch data using the latest events. + /// Call updateBatchEvents() which inherited from the Sensor class to + /// update batch data list which is managed by the Sensor class. + /// Then convert the updated batch data to the specific type by using + /// the method "ConvertBatchData" and assign it to the Data property. /// + /// + /// To use this method, you must override the ConvertBatchData method. + /// + /// /// /// General batch data's raw pointer /// diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs index d60f83ce0..13b66a04e 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs @@ -26,28 +26,28 @@ namespace Tizen.Sensor { private static string AccelerometerKey = "http://tizen.org/feature/sensor.accelerometer"; /// - /// Gets the X component of the acceleration. + /// Get the X component value of acceleration from the accelerometer sensor. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the acceleration. + /// Get the Y component value of acceleration from the accelerometer sensor. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the acceleration. + /// Get the Z component value of acceleration from the accelerometer sensor. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether accelerometer sensor is supported by the device. + /// Return true or false based on whether accelerometer sensor is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -61,7 +61,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of accelerometer sensors available on the device. + /// Return the number of accelerometer sensors available by the system. /// /// 3 /// The count of accelerometer sensors. diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs index a7e297d84..9de206fa2 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs @@ -62,7 +62,7 @@ namespace Tizen.Sensor }; /// - /// Gets the activity accuracy of the activity detector. + /// Get the activity accuracy of the activity detector sensor. /// /// 3 /// The activity accuracy. diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs index c1d567eb1..3e20b74a6 100644 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs @@ -30,22 +30,22 @@ namespace Tizen.Sensor private event EventHandler _accuracyChanged; /// - /// Gets the value of the rotation state. + /// Get the degree of the rotation state of the sensor as enum type. /// /// 7 - /// The rotation state. + /// The rotation state, . public AutoRotationState Rotation { get; private set; } = AutoRotationState.Degree_0; /// - /// Gets the accuracy of the auto-rotation data. + /// Get the accuracy of the auto-rotation data as enum type. /// /// 7 - /// Accuracy + /// Accuracy, public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined; /// - /// Returns true or false based on whether the auto-rotation sensor is supported by the device. + /// Return true or false based on whether the auto-rotation sensor is supported by the system. /// /// 7 /// true if supported; otherwise false. @@ -87,11 +87,12 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the auto-rotation sensor data. /// /// 7 - public event EventHandler DataUpdated; /// - /// An event handler for accuracy changed events. + /// An event handler for the event of accuracy change. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 7 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs index 8cdf94061..837ff2476 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition"; /// - /// Gets the state of the face down gesture. + /// Get the state of the face down gesture as enum type. /// /// 3 - /// The face down state. + /// The face down state, . public DetectorState FaceDown { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the face down gesture detector is supported by the device. + /// Return true or false based on whether the face down gesture detector is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of face down gesture detectors available on the device. + /// Return the number of face down gesture detectors available on the system. /// /// 3 /// The count of face down gesture detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.gesture_recognition @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular face down gesture detector in case of multiple sensors. + /// Default value is 0. /// public FaceDownGestureDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs index f3e4f233b..8682aa928 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs @@ -27,29 +27,30 @@ namespace Tizen.Sensor private const string GravitySensorKey = "http://tizen.org/feature/sensor.gravity"; private event EventHandler _accuracyChanged; + /// - /// Gets the X component of the gravity. + /// Get the X component value of the gravity sensor as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the gravity. + /// Get the Y component value of the gravity sensor as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the gravity. + /// Get the Z component value of the gravity sensor as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the gravity sensor is supported by the device. + /// Return true or false based on whether the gravity sensor is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -63,7 +64,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of gravity sensors available on the device. + /// Return the number of gravity sensors available on the system. /// /// 3 /// The count of gravity sensors. @@ -77,7 +78,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.gravity @@ -85,7 +86,8 @@ namespace Tizen.Sensor /// 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 refers to a particular gravity sensor in case of multiple sensors. + /// Default value is 0. /// public GravitySensor (uint index = 0) : base(index) { @@ -101,11 +103,12 @@ namespace Tizen.Sensor /// 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; /// - /// An event handler for accuracy changed events. + /// An event handler for the event of accuracy change. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs index 4730feb9c..414d23e39 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs @@ -27,28 +27,28 @@ namespace Tizen.Sensor private const string GyroscopeKey = "http://tizen.org/feature/sensor.gyroscope"; /// - /// Gets the X component of the acceleration. + /// Get the X component value of the acceleration as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the acceleration. + /// Get the Y component value of the acceleration as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the acceleration. + /// Get the Z component value of the acceleration as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the gyroscope sensor is supported by the device. + /// Return true or false based on whether the gyroscope sensor is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of the gyroscope sensors available on the device. + /// Return the number of the gyroscope sensors available on the system. /// /// 3 /// The count of the gyroscope sensors. @@ -76,7 +76,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.gyroscope @@ -84,7 +84,8 @@ namespace Tizen.Sensor /// 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 refers to a particular gyroscope sensor in case of multiple sensors. + /// Default value is 0. /// public Gyroscope(uint index = 0) : base(index) { @@ -98,9 +99,10 @@ namespace Tizen.Sensor /// /// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope sensor data. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs index 21738e26d..5b9e5b0cd 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs @@ -27,42 +27,42 @@ namespace Tizen.Sensor private const string GyroscopeRVKey = "http://tizen.org/feature/sensor.gyroscope_rotation_vector"; /// - /// Gets the X component of the gyroscope rotation vector. + /// Get the X component of the gyroscope rotation vector. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the gyroscope rotation vector. + /// Get the Y component of the gyroscope rotation vector. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the gyroscope rotation vector. + /// Get the Z component of the gyroscope rotation vector. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Gets the W component of the gyroscope rotation vector. + /// Get the W component of the gyroscope rotation vector. /// /// 3 /// W public float W { get; private set; } = float.MinValue; /// - /// Gets the accuracy of the gyroscope rotation vector data. + /// Get the accuracy of the gyroscope rotation vector data. /// /// 3 /// Accuracy public SensorDataAccuracy Accuracy { get; private set; } /// - /// Returns true or false based on whether the gyroscope rotation vector sensor is supported by the device. + /// Return true or false based on whether the gyroscope rotation vector sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -76,7 +76,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of the gyroscope rotation vector sensors available on the device. + /// Return the number of the gyroscope rotation vector sensors available on the system. /// /// 3 /// The count of accelerometer rotation vector sensors. @@ -90,7 +90,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.gyroscope_rotation_vector @@ -98,7 +98,8 @@ namespace Tizen.Sensor /// 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 refers to a particular gyroscope rotation vector sensor in case of multiple sensors. + /// Default value is 0. /// public GyroscopeRotationVectorSensor(uint index = 0) : base(index) { @@ -114,7 +115,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope rotation vector sensor data. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs index b26ea9c99..e312b7732 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private const string HRMKey = "http://tizen.org/feature/sensor.heart_rate_monitor"; /// - /// Gets the value of the heart rate monitor. + /// Get the value of the heart rate monitor as int type. /// /// 3 /// The heart rate. public int HeartRate { get; private set; } = int.MinValue; /// - /// Returns true or false based on whether the heart rate monitor is supported by the device. + /// Return true or false based on whether the heart rate monitor is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of heart rate monitors available on the device. + /// Return the number of heart rate monitors available on the system. /// /// 3 /// The count of heart rate monitors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/privilege/healthinfo @@ -73,7 +73,8 @@ namespace Tizen.Sensor /// 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 refers to a particular heart rate monitor in case of multiple sensors. + /// Default value is 0. /// public HeartRateMonitor(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs index a0cb24a61..76882b89c 100644 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs @@ -47,14 +47,14 @@ namespace Tizen.Sensor } /// - /// Gets the accuracy of the HeartRateMonitorBatch data. + /// Get the accuracy of the HeartRateMonitorBatch data as enum type. /// /// 8 - /// Accuracy + /// Accuracy, . public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined; /// - /// Returns true or false based on whether the HeartRateMonitorBatch sensor is supported by the device. + /// Return true or false based on whether the HeartRateMonitorBatch sensor is supported by the device. /// /// 8 /// true if supported; otherwise false. @@ -68,7 +68,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of HeartRateMonitorBatch sensors available on the device. + /// Return the number of HeartRateMonitorBatch sensors available on the system. /// /// 8 /// The count of HeartRateMonitorBatch sensors. @@ -83,7 +83,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 8 /// http://tizen.org/privilege/healthinfo @@ -94,7 +94,8 @@ namespace Tizen.Sensor /// 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 HeartRateMonitorBatch in case of multiple sensors. + /// Index refers to a particular HeartRateMonitorBatch in case of multiple sensors. + /// Default value is 0. /// public HeartRateMonitorBatch(uint index = 0) : base(index) { @@ -110,11 +111,12 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the HeartRateMonitorBatch data. /// /// 8 - public event EventHandler DataUpdated; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 8 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs index ad0e6d839..fcf78e2f6 100644 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs @@ -47,14 +47,14 @@ namespace Tizen.Sensor } /// - /// Gets the accuracy of the auto HeartRateMonitorLEDGreenBatch data. + /// Get the accuracy of the auto HeartRateMonitorLEDGreenBatch data as enum type. /// /// 8 - /// Accuracy + /// Accuracy, . public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined; /// - /// Returns true or false based on whether the HeartRateMonitorLEDGreenBatch sensor is supported by the device. + /// Return true or false based on whether the HeartRateMonitorLEDGreenBatch sensor is supported by the system. /// /// 8 /// true if supported; otherwise false. @@ -68,7 +68,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of HeartRateMonitorLEDGreenBatch sensors available on the device. + /// Return the number of HeartRateMonitorLEDGreenBatch sensors available on the system. /// /// 8 /// The count of HeartRateMonitorLEDGreenBatch sensors. @@ -83,7 +83,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 8 /// http://tizen.org/privilege/healthinfo @@ -94,7 +94,8 @@ namespace Tizen.Sensor /// 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 HeartRateMonitorLEDGreenBatch sensor in case of multiple sensors. + /// Index refers to a particular HeartRateMonitorLEDGreenBatch sensor in case of multiple sensors. + /// Default value is 0. /// public HeartRateMonitorLEDGreenBatch(uint index = 0) : base(index) { @@ -110,11 +111,12 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the HeartRateMonitorLEDGreenBatch sensor data. /// /// 8 - public event EventHandler DataUpdated; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 8 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs index b18c7bbc7..aec54085c 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private const string HumiditySensorKey = "http://tizen.org/feature/sensor.humidity"; /// - /// Gets the value of the humidity sensor. + /// Get the value of the humidity sensor as float type. /// /// 3 /// Humidity public float Humidity { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the humidity sensor is supported by the device. + /// Return true or false based on whether the humidity sensor is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of humidity sensors available on the device. + /// Return the number of humidity sensors available on the system. /// /// 3 /// The count of humidity sensors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.humidity @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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 refers to a particular humidity sensor in case of multiple sensors. + /// Default value is 0. /// public HumiditySensor(uint index = 0) : base(index) { @@ -86,7 +87,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the humidity sensor data. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs index 389c47d5e..3cec328a8 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private const string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of the in-vehicle activity detector. + /// Get the state of the in-vehicle activity detector as enum type. /// /// 3 - /// The in-vehicle state. + /// The in-vehicle state, . public DetectorState InVehicle { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the in-vehicle activity detector is supported by the device. + /// Return true or false based on whether the in-vehicle activity detector is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of in-vehicle activity detectors available on the device. + /// Return the number of in-vehicle activity detectors available on the system. /// /// 3 /// The count of in-vehicle activity detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular in-vehicle activity detector in case of multiple sensors. + /// Default value is 0. /// public InVehicleActivityDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs index 9a11d2adc..5177176f3 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private const string LightSensorKey = "http://tizen.org/feature/sensor.photometer"; /// - /// Gets the level of the light. + /// Get the light level of light sensor as float type. /// /// 3 /// The light level. public float Level { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the light sensor is supported by the device. + /// Return true or false based on whether the light sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of light sensors available on the device. + /// Return the number of light sensors available on the system. /// /// 3 /// The count of light sensors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.photometer @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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 refers to a particular light sensor in case of multiple sensors. + /// Default value is 0. /// public LightSensor(uint index = 0) : base(index) { @@ -86,7 +87,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the light sensor data. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs index 2a2d80cc0..ec2f658fb 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs @@ -27,29 +27,30 @@ namespace Tizen.Sensor private const string LinearAccelerationSensorKey = "http://tizen.org/feature/sensor.linear_acceleration"; private event EventHandler _accuracyChanged; + /// - /// Gets the X component of the linear acceleration. + /// Get the X component value of the linear acceleration. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the linear acceleration. + /// Get the Y component value of the linear acceleration. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the linear acceleration. + /// Get the Z component value of the linear acceleration. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the linear acceleration sensor is supported by the device. + /// Return true or false based on whether the linear acceleration sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -63,7 +64,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of linear acceleration sensors available on the device. + /// Return the number of linear acceleration sensors available on the system. /// /// 3 /// The count of linear acceleration sensors. @@ -77,7 +78,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.linear_acceleration @@ -85,7 +86,8 @@ namespace Tizen.Sensor /// 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 refers to a particular linear acceleration sensor in case of multiple sensors. + /// Default value is 0. /// public LinearAccelerationSensor(uint index = 0) : base(index) { @@ -101,11 +103,12 @@ namespace Tizen.Sensor /// 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; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs index 0e47cec02..e23c09282 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs @@ -27,29 +27,30 @@ namespace Tizen.Sensor private static string MagnetometerKey = "http://tizen.org/feature/sensor.magnetometer"; private event EventHandler _accuracyChanged; + /// - /// Gets the X component of the magnetometer. + /// Get the X component value of the magnetometer as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the magnetometer. + /// Get the Y component value of the magnetometer as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the magnetometer. + /// Get the Z component value of the magnetometer as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether magnetometer is supported by the device. + /// Return true or false based on whether magnetometer is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -63,7 +64,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of magnetometers available on the device. + /// Return the number of magnetometers available on the system. /// /// 3 /// The count of magnetometers. @@ -77,7 +78,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.magnetometer @@ -85,7 +86,8 @@ namespace Tizen.Sensor /// 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 refers to a particular magnetometer in case of multiple sensors. + /// Default value is 0. /// public Magnetometer(uint index = 0) : base(index) { @@ -101,11 +103,12 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data. /// /// 3 - public event EventHandler DataUpdated; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs index 8813bd21f..3e9c70fec 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs @@ -27,43 +27,44 @@ namespace Tizen.Sensor private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector"; private event EventHandler _accuracyChanged; + /// - /// Gets the X component of the magnetometer rotation vector. + /// Get the X component value of the magnetometer rotation vector as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the magnetometer rotation vector. + /// Get the Y component value of the magnetometer rotation vector as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the magnetometer rotation vector. + /// Get the Z component value of the magnetometer rotation vector as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Gets the W component of the magnetometer rotation vector. + /// Get the W component value of the magnetometer rotation vector as float type. /// /// 3 /// W public float W { get; private set; } = float.MinValue; /// - /// Gets the accuracy of the magnetometer rotation vector data. + /// Get the accuracy of the magnetometer rotation vector data as enum type. /// /// 3 - /// Accuracy + /// Accuracy, . public SensorDataAccuracy Accuracy { get; private set; } /// - /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device. + /// Return true or false based on whether the magnetometer rotation vector sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -77,7 +78,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of magnetometer rotation vector sensors available on the device. + /// Return the number of magnetometer rotation vector sensors available on the system. /// /// 3 /// The count of magnetometer rotation vector sensors. @@ -91,7 +92,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.geomagnetic_rotation_vector @@ -99,7 +100,8 @@ namespace Tizen.Sensor /// 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 refers to a particular magnetometer rotation vector sensor in case of multiple sensors. + /// Default value is 0. /// public MagnetometerRotationVectorSensor(uint index = 0) : base(index) { @@ -115,11 +117,12 @@ namespace Tizen.Sensor /// 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; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs index 0a221a05a..988e6ebc0 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs @@ -27,29 +27,30 @@ namespace Tizen.Sensor private static string OrientationSensorKey = "http://tizen.org/feature/sensor.tiltmeter"; private event EventHandler _accuracyChanged; + /// - /// Gets the azimuth component of the orientation. + /// Get the azimuth component value of the orientation as float type. /// /// 3 /// Azimuth public float Azimuth { get; private set; } = float.MinValue; /// - /// Gets the pitch component of the orientation. + /// Get the pitch component value of the orientation as float type. /// /// 3 /// Pitch public float Pitch { get; private set; } = float.MinValue; /// - /// Gets the roll component of the orientation. + /// Get the roll component value of the orientation as float type. /// /// 3 /// Roll public float Roll { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the orientation sensor is supported by the device. + /// Return true or false based on whether the orientation sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -63,7 +64,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of orientation sensors available on the device. + /// Return the number of orientation sensors available on the system. /// /// 3 /// The count of orientation sensors. @@ -77,7 +78,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.tiltmeter @@ -85,7 +86,8 @@ namespace Tizen.Sensor /// 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 refers to a particular orientation sensor in case of multiple sensors. + /// Default value is 0. /// public OrientationSensor(uint index = 0) : base(index) { @@ -101,11 +103,12 @@ namespace Tizen.Sensor /// 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; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs index a6e819056..0cc2764ee 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs @@ -27,63 +27,63 @@ namespace Tizen.Sensor private static string PedometerKey = "http://tizen.org/feature/sensor.pedometer"; /// - /// Gets the step count. + /// Get the step count from pedometer as unsigned integer type. /// /// 3 /// The step count. public uint StepCount { get; private set; } = 0; /// - /// Gets the walking step count. + /// Get the walking step count from pedometer as unsigned integer type. /// /// 3 /// The walk step count. public uint WalkStepCount { get; private set; } = 0; /// - /// Gets the running step count. + /// Get the running step count from pedometer as unsigned integer type. /// /// 3 /// The run step count. public uint RunStepCount { get; private set; } = 0; /// - /// Gets the moving distance. + /// Get the moving distance from pedometer as float type. /// /// 3 /// The moving distance. public float MovingDistance { get; private set; } = 0; /// - /// Gets the calorie burned. + /// Get the calorie burned from pedometer as float type. /// /// 3 /// The calorie burned. public float CalorieBurned { get; private set; } = 0; /// - /// Gets the last speed. + /// Get the last speed from pedometer as float type. /// /// 3 /// The last speed. public float LastSpeed { get; private set; } = 0; /// - /// Gets the last stepping frequency. + /// Get the last stepping frequency from pedometer as float type. /// /// 3 /// The last stepping frequency. public float LastSteppingFrequency { get; private set; } = 0; /// - /// Gets the last step status. + /// Get the last step status from pedometer as enum type. /// /// 3 - /// The last step status. + /// The last step status, . public PedometerState LastStepStatus { get; private set; } = PedometerState.Unknown; /// - /// Returns true or false based on whether the pedometer sensor is supported by the device. + /// Return true or false based on whether the pedometer sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -97,7 +97,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of pedometer sensors available on the device. + /// Return the number of pedometer sensors available on the system. /// /// 3 /// The count of pedometer sensors. @@ -111,7 +111,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/privilege/healthinfo @@ -122,7 +122,8 @@ namespace Tizen.Sensor /// 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 refers to a particular pedometer sensor in case of multiple sensors. + /// Default value is 0. /// public Pedometer(uint index = 0) : base(index) { @@ -138,7 +139,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the pedometer sensor data. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs index e6c9b736f..20681dea0 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition"; /// - /// Gets the state of the pick up gesture. + /// Get the state of the pick up gesture as enum type. /// /// 3 - /// The pick up state. + /// The pick up state, . public DetectorState PickUp { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the pick up gesture detector is supported by the device. + /// Return true or false based on whether the pick up gesture detector is supported by the system. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of pick up gesture detectors available on the device. + /// Return the number of pick up gesture detectors available on the system. /// /// 3 /// The count of pick up gesture detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.gesture_recognition @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular pick up gesture detector in case of multiple sensors. + /// Default value is 0. /// public PickUpGestureDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs index 80a1838c4..5c4f37036 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string PressureSensorKey = "http://tizen.org/feature/sensor.barometer"; /// - /// Gets the value of the pressure sensor. + /// Get the pressure value from the pressure sensor as float type. /// /// 3 /// Pressure public float Pressure { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the pressure sensor is supported by the device. + /// Return true or false based on whether the pressure sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of pressure sensors available on the device. + /// Return the number of pressure sensors available on the system. /// /// 3 /// The count of pressure sensors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.barometer @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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 refers to a particular pressure sensor in case of multiple sensors. + /// Default value is 0. /// public PressureSensor(uint index = 0) : base(index) { @@ -86,7 +87,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the pressure sensor data. /// /// 3 - public event EventHandler DataUpdated; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs index e1e4aa36a..c428a9fe5 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string ProximitySensorKey = "http://tizen.org/feature/sensor.proximity"; /// - /// Gets the proximity state. + /// Get the proximity state as enum type. /// /// 3 - /// The proximity state. + /// The proximity state, . public ProximitySensorState Proximity { get; private set; } = ProximitySensorState.Unknown; /// - /// Returns true or false based on whether the proximity sensor is supported by the device. + /// Return true or false based on whether the proximity sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of proximity sensors available on the device. + /// Return the number of proximity sensors available on the system. /// /// 3 /// The count of proximity sensors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.proximity @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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 proximity sensor in case of multiple sensors. + /// Index refers to a particular proximity sensor in case of multiple sensors. + /// Default value is 0. /// public ProximitySensor(uint index = 0) : base(index) { @@ -86,7 +87,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the proximity sensor data. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs index 209cc33c6..5a08af0f4 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs @@ -27,43 +27,44 @@ namespace Tizen.Sensor private static string RotationVectorKey = "http://tizen.org/feature/sensor.rotation_vector"; private event EventHandler _accuracyChanged; + /// - /// Gets the X component of the rotation vector. + /// Get the X component value of the rotation vector as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the rotation vector. + /// Get the Y component value of the rotation vector as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the rotation vector. + /// Get the Z component value of the rotation vector as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Gets the W component of the rotation vector. + /// Get the W component value of the rotation vector as float type. /// /// 3 /// W public float W { get; private set; } = float.MinValue; /// - /// Gets the accuracy of the rotation vector data. + /// Get the accuracy value of the rotation vector data as enum type. /// /// 3 - /// Accuracy + /// Accuracy, . public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined; /// - /// Returns true or false based on whether the rotation vector sensor is supported by the device. + /// Return true or false based on whether the rotation vector sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -77,7 +78,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of rotation vector sensors available on the device. + /// Return the number of rotation vector sensors available on the system. /// /// 3 /// The count of rotation vector sensors. @@ -91,7 +92,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.rotation_vector @@ -99,7 +100,8 @@ namespace Tizen.Sensor /// 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 refers to a particular rotation vector sensor in case of multiple sensors. + /// Default value is 0. /// public RotationVectorSensor(uint index = 0) : base(index) { @@ -115,11 +117,12 @@ namespace Tizen.Sensor /// 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; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs index d42a2cb4b..b87f0c668 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of the running activity detector. + /// Get the state of the running activity detector as enum type. /// /// 3 - /// The running state. + /// The running state, . public DetectorState Running { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the running activity detector is supported by the device. + /// Return true or false based on whether the running activity detector is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of running activity detectors available on the device. + /// Return the number of running activity detectors available on the system. /// /// 3 /// The count of running activity detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular running activity detector in case of multiple sensors. + /// Default value is 0. /// public RunningActivityDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs index bdeb27eb1..2bab44945 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string SleepMonitorKey = "http://tizen.org/feature/sensor.sleep_monitor"; /// - /// Gets the value of the sleep state. + /// Get the value of the sleep state as enum type. /// /// 3 - /// The sleep state. + /// The sleep state, . public SleepMonitorState SleepState { get; private set; } = SleepMonitorState.Unknown; /// - /// Returns true or false based on whether the sleep monitor is supported by the device. + /// Return true or false based on whether the sleep monitor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of sleep monitors available on the device. + /// Return the number of sleep monitors available on the system. /// /// 3 /// The count of sleep monitors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/privilege/healthinfo @@ -73,7 +73,8 @@ namespace Tizen.Sensor /// 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 refers to a particular sleep monitor in case of multiple sensors. + /// Default value is 0. /// public SleepMonitor(uint index = 0) : base(index) { @@ -89,7 +90,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data. /// /// 3 - public event EventHandler DataUpdated; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs index d72306256..f85ab0b77 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of the stationary activity detector. + /// Get the state of the stationary activity detector as enum type. /// /// 3 - /// The stationary state. + /// The stationary state, . public DetectorState Stationary { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the stationary activity detector is supported by the device. + /// Return true or false based on whether the stationary activity detector is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of stationary activity detectors available on the device. + /// Return the number of stationary activity detectors available on the system. /// /// 3 /// The count of stationary activity detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular stationary activity detector in case of multiple sensors. + /// Default value is 0. /// public StationaryActivityDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs index d9a1df951..efbf80356 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string TemperatureSensorKey = "http://tizen.org/feature/sensor.temperature"; /// - /// Gets the value of the temperature sensor. + /// Get the value of the temperature sensor as float type. /// /// 3 /// Temperature (Celsius) public float Temperature { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the temperature sensor is supported by the device. + /// Return true or false based on whether the temperature sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of temperature sensors available on the device. + /// Return the number of temperature sensors available on the system. /// /// 3 /// The count of temperature sensors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.temperature @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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 refers to a particular temperature sensor in case of multiple sensors. + /// Default value is 0. /// public TemperatureSensor(uint index = 0) : base(index) { @@ -86,7 +87,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the temperature sensor data. /// /// 3 - public event EventHandler DataUpdated; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs index 53bfb10db..a027068b5 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string UltravioletSensorKey = "http://tizen.org/feature/sensor.ultraviolet"; /// - /// Gets the value of the ultraviolet sensor. + /// Get the value of the ultraviolet sensor as float type. /// /// 3 /// The ultraviolet index. public float UltravioletIndex { get; private set; } = float.MinValue; /// - /// Returns true or false based on whether the ultraviolet sensor is supported by the device. + /// Return true or false based on whether the ultraviolet sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of ultraviolet sensors available on the device. + /// Return the number of ultraviolet sensors available on the system. /// /// 3 /// The count of ultraviolet sensors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.ultraviolet @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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 refers to a particular ultraviolet sensor in case of multiple sensors. + /// Default value is 0. /// public UltravioletSensor(uint index = 0) : base(index) { @@ -86,7 +87,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the ultraviolet sensor data. /// /// 3 - public event EventHandler DataUpdated; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs index 33c9b1264..e5904bff5 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs @@ -27,49 +27,49 @@ namespace Tizen.Sensor private static string UncalibratedGyroscopeKey = "http://tizen.org/feature/sensor.gyroscope.uncalibrated"; /// - /// Gets the X component of the acceleration. + /// Get the X component value of the acceleration as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the acceleration. + /// Get the Y component value of the acceleration as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the acceleration. + /// Get the Z component value of the acceleration as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Gets the BiasX component of the uncalibrated gyroscope data. + /// Get the BiasX component value of the uncalibrated gyroscope data as float type. /// /// 3 /// The X bias. public float BiasX { get; private set; } = 0; /// - /// Gets the BiasY component of the uncalibrated gyroscope data. + /// Get the BiasY component value of the uncalibrated gyroscope data as float type. /// /// 3 /// The Y bias. public float BiasY { get; private set; } = 0; /// - /// Gets the BiasZ component of the uncalibrated gyroscope data. + /// Get the BiasZ component value of the uncalibrated gyroscope data as float type. /// /// 3 /// The Z bias. public float BiasZ { get; private set; } = 0; /// - /// Returns true or false based on whether the uncalibrated gyroscope sensor is supported by the device. + /// Return true or false based on whether the uncalibrated gyroscope sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -83,7 +83,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of the uncalibrated gyroscope sensors available on the device. + /// Return the number of the uncalibrated gyroscope sensors available on the system. /// /// 3 /// The count of the uncalibrated gyroscope sensors. @@ -97,7 +97,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.gyroscope.uncalibrated @@ -105,7 +105,8 @@ namespace Tizen.Sensor /// 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 refers to a particular uncalibrated gyroscope sensor in case of multiple sensors. + /// Default value is 0. /// public UncalibratedGyroscope(uint index = 0) : base(index) { @@ -121,7 +122,6 @@ namespace Tizen.Sensor /// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated gyroscope sensor data. /// /// 3 - public event EventHandler DataUpdated; private static int GetCount() diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs index ee1927dcb..8feee4276 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs @@ -27,50 +27,51 @@ namespace Tizen.Sensor private static string UncalibratedMagnetometerKey = "http://tizen.org/feature/sensor.magnetometer.uncalibrated"; private event EventHandler _accuracyChanged; + /// - /// Gets the X component of the acceleration. + /// Get the X component value of the acceleration as float type. /// /// 3 /// X public float X { get; private set; } = float.MinValue; /// - /// Gets the Y component of the acceleration. + /// Get the Y component value of the acceleration as float type. /// /// 3 /// Y public float Y { get; private set; } = float.MinValue; /// - /// Gets the Z component of the acceleration. + /// Get the Z component value of the acceleration as float type. /// /// 3 /// Z public float Z { get; private set; } = float.MinValue; /// - /// Gets the BiasX component of the uncalibrated magnetometer data. + /// Get the BiasX component value of the uncalibrated magnetometer data as float type. /// /// 3 /// The X bias. public float BiasX { get; private set; } = 0; /// - /// Gets the BiasY component of the uncalibrated magnetometer data. + /// Get the BiasY component value of the uncalibrated magnetometer data as float type. /// /// 3 /// The Y bias. public float BiasY { get; private set; } = 0; /// - /// Gets the BiasZ component of the uncalibrated magnetometer data. + /// Get the BiasZ component value of the uncalibrated magnetometer data as float type. /// /// 3 /// The Z bias. public float BiasZ { get; private set; } = 0; /// - /// Returns true or false based on whether the uncalibrated magnetometer sensor is supported by the device. + /// Return true or false based on whether the uncalibrated magnetometer sensor is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -84,7 +85,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of uncalibrated magnetometer sensors available on the device. + /// Return the number of uncalibrated magnetometer sensors available on the system. /// /// 3 /// The count of uncalibrated magnetometer sensors. @@ -98,7 +99,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.magnetometer.uncalibrated @@ -106,7 +107,8 @@ namespace Tizen.Sensor /// 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 refers to a particular uncalibrated magnetometer sensor in case of multiple sensors. + /// Default value is 0. /// public UncalibratedMagnetometer(uint index = 0) : base(index) { @@ -122,11 +124,12 @@ namespace Tizen.Sensor /// 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; /// /// An event handler for accuracy changed events. + /// If an event is added, a new accuracy change callback is registered for this sensor. + /// If an event is removed, accuracy change callback is unregistered for this sensor. /// /// 3 public event EventHandler AccuracyChanged diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs index a7ecb6188..e969e544e 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; /// - /// Gets the state of the walking activity detector. + /// Get the state of the walking activity detector as enum type. /// /// 3 - /// The walking state. + /// The walking state, . public DetectorState Walking { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the walking activity detector is supported by the device. + /// Return true or false based on whether the walking activity detector is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of walking activity detectors available on the device. + /// Return the number of walking activity detectors available on the system. /// /// 3 /// The count of walking activity detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.activity_recognition @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular walking activity detector in case of multiple sensors. + /// Default value is 0. /// public WalkingActivityDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs index 1e4966ff6..bdbde3e0b 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs @@ -27,14 +27,14 @@ namespace Tizen.Sensor private static string WristUpKey = "http://tizen.org/feature/sensor.wrist_up"; /// - /// Gets the state of the wrist up gesture. + /// Get the state of the wrist up gesture as enum type. /// /// 3 - /// The wrist up state. + /// The wrist up state, . public DetectorState WristUp { get; private set; } = DetectorState.Unknown; /// - /// Returns true or false based on whether the wrist up gesture detector is supported by the device. + /// Return true or false based on whether the wrist up gesture detector is supported by the device. /// /// 3 /// true if supported; otherwise false. @@ -48,7 +48,7 @@ namespace Tizen.Sensor } /// - /// Returns the number of wrist up gesture detectors available on the device. + /// Return the number of wrist up gesture detectors available on the system. /// /// 3 /// The count of wrist up gesture detectors. @@ -62,7 +62,7 @@ namespace Tizen.Sensor } /// - /// Initializes a new instance of the class. + /// Initialize a new instance of the class. /// /// 3 /// http://tizen.org/feature/sensor.wrist_up @@ -70,7 +70,8 @@ namespace Tizen.Sensor /// 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. + /// Index refers to a particular wrist up gesture detector in case of multiple sensors. + /// Default value is 0. /// public WristUpGestureDetector(uint index = 0) : base(index) { diff --git a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs index 1812c7ccf..602ef32bf 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs @@ -52,13 +52,38 @@ namespace Tizen.Sensor /// - /// Read a sensor data synchronously. + /// Read sensor(which inherits this class) data synchronously. /// internal abstract void ReadData(); + + /// + /// Get the type of a sensor which inherits this class. + /// internal abstract SensorType GetSensorType(); + + /// + /// Start to listen the event of a sensor which inherits this class. + /// internal abstract void EventListenStart(); + + /// + /// Stop to listen the event of a sensor which inherits this class. + /// internal abstract void EventListenStop(); + /// + /// Update the internal batch event list using the latest events. + /// + /// + /// It will be called for updating events about the sensor like + /// BatchSensor or Plugin classes which inherits this class. + /// + /// + /// General batch data's raw pointer + /// + /// + /// Number of general batch events + /// internal void updateBatchEvents(IntPtr eventsPtr, uint events_count) { if (events_count >= 1) @@ -73,6 +98,14 @@ namespace Tizen.Sensor } } + /// + /// Return the last element of Batched elements, which is the latest + /// sensor event. + /// + /// + /// If there is no event, default(Interop.SensorEventStruct) will be + /// returned. + /// internal Interop.SensorEventStruct latestEvent() { if (BatchedEvents.Count > 0) @@ -82,6 +115,9 @@ namespace Tizen.Sensor return default(Interop.SensorEventStruct); } + /// + /// Create the Sensor object to listen to the sensor events. + /// internal Sensor(uint index) { SensorType type = GetSensorType(); @@ -94,7 +130,7 @@ namespace Tizen.Sensor } /// - /// Destroy the Sensor object. + /// Destroy the Sensor object and release all resources. /// ~Sensor() { @@ -102,7 +138,7 @@ namespace Tizen.Sensor } /// - /// Property: Gets the name of the sensor. + /// Property: Gets the name of the sensor as a string. /// /// 3 /// The name of the sensor. @@ -116,7 +152,7 @@ namespace Tizen.Sensor } /// - /// Property: Gets the vendor. + /// Property: Gets the vendor of the sensor as a string. /// /// 3 /// The vendor name of the sensor. @@ -158,7 +194,7 @@ namespace Tizen.Sensor } /// - /// Property: Gets the resolution. + /// Property: Gets the resolution of the sensor as a float type. /// /// 3 /// The resolution. @@ -172,7 +208,7 @@ namespace Tizen.Sensor } /// - /// Property: Gets the minimum interval. + /// Property: Gets the minimum interval of the sensor. /// /// 3 /// The minimum update interval. @@ -186,7 +222,7 @@ namespace Tizen.Sensor } /// - /// Property: Gets the FIFO count. + /// Property: Gets the FIFO count of the sensor as int type. /// /// 3 /// The size of the hardware FIFO. @@ -200,7 +236,7 @@ namespace Tizen.Sensor } /// - /// Property: Gets the maximum batch count. + /// Property: Gets the maximum batch count of the sensor. /// /// 3 /// The maximum batch count. @@ -257,7 +293,8 @@ namespace Tizen.Sensor } /// - /// Sets the pause policy of the sensor. + /// Get the pause policy or set the pause policy of the sensor as the + /// set value. /// /// 3 /// The pause policy. @@ -280,6 +317,9 @@ namespace Tizen.Sensor /// /// Gets or sets the time span. + /// Set value will be used as its 'Ticks' attribute. + /// Get will return the newly allocated TimeSpan object with the same + /// ticks as the sensor's timestamp. /// /// 3 /// The time span. @@ -298,7 +338,8 @@ namespace Tizen.Sensor } /// - /// Gets or sets the timestamp. + /// Gets or sets the timestamp of a sensor which inherits the sensor + /// class. /// /// 8 /// Timestamp. @@ -317,10 +358,10 @@ namespace Tizen.Sensor } /// - /// Indicates whether this sensor is sensing. + /// Indicate whether the sensor is sensing or not sensing. /// /// 3 - /// true if this sensor is sensing; otherwise false. + /// true if the sensor is sensing; otherwise false. public bool IsSensing { get @@ -338,6 +379,12 @@ namespace Tizen.Sensor } } + /// + /// Check if the sensor type is supported or not by the system. + /// + /// The sensor type to check. + /// The key for the sensor type to check. + /// True if the sensor type is supported, otherwise false. internal static bool CheckIfSupported(SensorType type, String key) { bool isSupported = false; @@ -414,7 +461,7 @@ namespace Tizen.Sensor } /// - /// Destroy the current object. + /// Destroy the current object and release all the resources. /// /// 3 public void Dispose() @@ -453,6 +500,13 @@ namespace Tizen.Sensor } } + /// + /// Gets the handle list of the sensors of a given type and index. + /// + /// + /// A device may have more than one sensors of the given type. + /// In such case, the 'index'th sensor handle will be used. + /// private void GetHandleList(SensorType type, uint index) { IntPtr list; @@ -469,6 +523,10 @@ namespace Tizen.Sensor Interop.Libc.Free(list); } + /// + /// Get the following sensor properties of the sensor: + /// name, vendor, minimum range, maximum range, resolution, minimum interval, fifo count, maximum batch count + /// private void GetProperty() { int error = (int)SensorError.None; @@ -530,6 +588,9 @@ namespace Tizen.Sensor } } + /// + /// Create a sensor listener and store a handle of the listener as an member variable. + /// private void CreateListener() { int error = Interop.SensorListener.CreateListener(_sensorHandle, out _listenerHandle); @@ -540,6 +601,9 @@ namespace Tizen.Sensor } } + /// + /// Change the interval between updates for the sensor with the value stored in member variable. + /// private void SetInterval() { if (CheckListenerHandle()) @@ -556,6 +620,20 @@ namespace Tizen.Sensor } } + /// + /// Set the desired maximum batch latency of the sensor. + /// Sensors that support batching may allow applications to change their maximum batch latencies. + /// For example, if you set the latency as 10,000 ms, the sensor may store its data + /// up to 10,000 ms, before delivering the data through the HAL. + /// In case of non-batching sensors no error will be occured, + /// but nothing is affected by the input latency value. + /// + /// + /// Even if you set a batch latency, the sensor may not work as you intended, + /// as one sensor can be used by more than one listeners. + /// In addition, some batch sensors may already have fixed batching latency + /// or batching queue size, which cannot be altered by applications. + /// private void SetMaxBatchLatency() { if (CheckListenerHandle()) @@ -569,6 +647,14 @@ namespace Tizen.Sensor } } + /// + /// Check if listener handle for the sensor is valid or not. + /// + /// + /// If listener handle is not valid, then it will throw ArgumentException. + /// + /// Thrown when the sensor listener handler is invalid. + /// true if listener handle is valid. private bool CheckListenerHandle() { bool result = false; @@ -584,6 +670,12 @@ namespace Tizen.Sensor return result; } + /// + /// Check if sensor handle for the sensor is valid or not. + /// If sensor handle is not valid, then it will throw ArgumentException. + /// + /// Thrown when the sensor handler is invalid. + /// true if sensor handle is valid. private bool CheckSensorHandle() { bool result = false; @@ -599,6 +691,14 @@ namespace Tizen.Sensor return result; } + /// + /// Destroy resources of a listener handle of the sensor. + /// Release all resources allocated for a listener handle. + /// + /// + /// If this function is called while the sensor is still running, + /// that is, then it is implicitly stopped. + /// private void DestroyHandles() { Interop.SensorListener.DestroyListener(_listenerHandle); -- 2.34.1