sensor: csapi: add feature/privilege tags to doxygen
authorkibak.yoon <kibak.yoon@samsung.com>
Fri, 26 May 2017 12:49:08 +0000 (21:49 +0900)
committerkibak.yoon <kibak.yoon@samsung.com>
Fri, 26 May 2017 12:49:08 +0000 (21:49 +0900)
Change-Id: Ieee001f4a789147485b5c8333b63925f273aa23e
Signed-off-by: kibak.yoon <kibak.yoon@samsung.com>
27 files changed:
src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs
src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs

index 3e18ad8..0bf9aa4 100644 (file)
@@ -67,6 +67,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.Accelerometer"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.accelerometer</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 1902855..49bb2cf 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.FaceDownGestureDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 41d90e3..71f2301 100644 (file)
@@ -68,6 +68,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.GravitySensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.gravity</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 09be0a1..5eda227 100644 (file)
@@ -67,6 +67,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.Gyroscope"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.gyroscope</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index dfecaab..486d9b9 100644 (file)
@@ -77,6 +77,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.GyroscopeRotationVectorSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.gyroscope_rotation_vector</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 154abc2..e695a37 100644 (file)
@@ -57,9 +57,8 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.HeartRateMonitor"/> class.
         /// </summary>
-        /// <remarks>
-        /// For accessing heart rate monitor, app should have http://tizen.org/privilege/healthinfo privilege.
-        /// </remarks>
+        /// <privilege>http://tizen.org/privilege/healthinfo</privilege>
+        /// <feature>http://tizen.org/feature/sensor.heart_rate_monitor</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
@@ -80,7 +79,6 @@ namespace Tizen.Sensor
         /// <summary>
         /// Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data.
         /// </summary>
-
         public event EventHandler<HeartRateMonitorDataUpdatedEventArgs> DataUpdated;
 
         private static int GetCount()
index 0c992e6..0cb6101 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.HumiditySensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.humidity</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 5c35a18..162d32f 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.InVehicleActivityDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index fffdfc9..32db23c 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.LightSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.photometer</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 1017506..4303f68 100644 (file)
@@ -68,6 +68,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.LinearAccelerationSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.linear_acceleration</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index a695cf1..712b0f0 100644 (file)
@@ -68,6 +68,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.Magnetometer"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.magnetometer</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index e033043..63feec8 100644 (file)
@@ -78,6 +78,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.MagnetometerRotationVectorSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.geomagnetic_rotation_vector</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 3488523..6e26e7b 100644 (file)
@@ -68,6 +68,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.OrientationSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.tiltmeter</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 48bb1b0..4821e33 100644 (file)
@@ -92,9 +92,8 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.Pedometer"/> class.
         /// </summary>
-        /// <remarks>
-        /// For accessing pedometer, app should have http://tizen.org/privilege/healthinfo privilege.
-        /// </remarks>
+        /// <privilege>http://tizen.org/privilege/healthinfo</privilege>
+        /// <feature>http://tizen.org/feature/sensor.pedometer</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
index 486d941..40ca860 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.PickUpGestureDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 58ebdb4..799ff2d 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.PressureSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.barometer</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index a91645b..f5735fd 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.ProximitySensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.proximity</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 8d0f0f7..10185ae 100644 (file)
@@ -78,6 +78,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.RotationVectorSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.rotation_vector</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index fc08d41..785ec31 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.RunningActivityDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index ed4b12c..e527a27 100644 (file)
@@ -57,9 +57,8 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.SleepMonitor"/> class.
         /// </summary>
-        /// <remarks>
-        /// For accessing sleep monitor, app should have http://tizen.org/privilege/healthinfo privilege.
-        /// </remarks>
+        /// <privilege>http://tizen.org/privilege/healthinfo</privilege>
+        /// <feature>http://tizen.org/feature/sensor.sleep_monitor</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
index 2c42f13..5f67f9f 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.stationaryActivityDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 6d3e848..c2d4662 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.TemperatureSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.temperature</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 5ab32e4..21af905 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.UltravioletSensor"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.ultraviolet</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index ef10c79..98584cb 100644 (file)
@@ -82,6 +82,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.UncalibratedGyroscope"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.gyroscope.uncalibrated</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 350acaa..b4451d5 100644 (file)
@@ -83,6 +83,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.UncalibratedMagnetometer"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.magnetometer.uncalibrated</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index 391f3ae..cf875cf 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.walkingActivityDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
index f182c81..dceb4d6 100644 (file)
@@ -57,6 +57,7 @@ namespace Tizen.Sensor
         /// <summary>
         /// Initializes a new instance of the <see cref="Tizen.Sensor.WristUpGestureDetector"/> class.
         /// </summary>
+        /// <feature>http://tizen.org/feature/sensor.wrist_up</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>