From: kibak.yoon Date: Fri, 26 May 2017 12:49:08 +0000 (+0900) Subject: sensor: csapi: add feature/privilege tags to doxygen X-Git-Tag: submit/tizen/20170612.020304~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=bb2869ab02ef130f0ecac09dc7ac0ddca60a2baf;p=platform%2Fcore%2Fcsapi%2Fsensor.git sensor: csapi: add feature/privilege tags to doxygen Change-Id: Ieee001f4a789147485b5c8333b63925f273aa23e Signed-off-by: kibak.yoon --- diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs index 3e18ad8..0bf9aa4 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs @@ -67,6 +67,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.accelerometer /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs index 1902855..49bb2cf 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.gesture_recognition /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs index 41d90e3..71f2301 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs @@ -68,6 +68,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.gravity /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs index 09be0a1..5eda227 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs @@ -67,6 +67,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.gyroscope /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs index dfecaab..486d9b9 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs @@ -77,6 +77,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.gyroscope_rotation_vector /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs index 154abc2..e695a37 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs @@ -57,9 +57,8 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// - /// - /// For accessing heart rate monitor, app should have http://tizen.org/privilege/healthinfo privilege. - /// + /// http://tizen.org/privilege/healthinfo + /// http://tizen.org/feature/sensor.heart_rate_monitor /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the app has no privilege to use the sensor @@ -80,7 +79,6 @@ namespace Tizen.Sensor /// /// Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data. /// - public event EventHandler DataUpdated; private static int GetCount() diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs index 0c992e6..0cb6101 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.humidity /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs index 5c35a18..162d32f 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.activity_recognition /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs index fffdfc9..32db23c 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.photometer /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs index 1017506..4303f68 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs @@ -68,6 +68,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.linear_acceleration /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs index a695cf1..712b0f0 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs @@ -68,6 +68,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.magnetometer /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs index e033043..63feec8 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs @@ -78,6 +78,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.geomagnetic_rotation_vector /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs index 3488523..6e26e7b 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs @@ -68,6 +68,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.tiltmeter /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs index 48bb1b0..4821e33 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs @@ -92,9 +92,8 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// - /// - /// For accessing pedometer, app should have http://tizen.org/privilege/healthinfo privilege. - /// + /// http://tizen.org/privilege/healthinfo + /// http://tizen.org/feature/sensor.pedometer /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the app has no privilege to use the sensor diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs index 486d941..40ca860 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.gesture_recognition /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs index 58ebdb4..799ff2d 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.barometer /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs index a91645b..f5735fd 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.proximity /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs index 8d0f0f7..10185ae 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs @@ -78,6 +78,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.rotation_vector /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs index fc08d41..785ec31 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.activity_recognition /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs index ed4b12c..e527a27 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs @@ -57,9 +57,8 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// - /// - /// For accessing sleep monitor, app should have http://tizen.org/privilege/healthinfo privilege. - /// + /// http://tizen.org/privilege/healthinfo + /// http://tizen.org/feature/sensor.sleep_monitor /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the app has no privilege to use the sensor diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs index 2c42f13..5f67f9f 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.activity_recognition /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs index 6d3e848..c2d4662 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.temperature /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs index 5ab32e4..21af905 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.ultraviolet /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs index ef10c79..98584cb 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs @@ -82,6 +82,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.gyroscope.uncalibrated /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs index 350acaa..b4451d5 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs @@ -83,6 +83,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.magnetometer.uncalibrated /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs index 391f3ae..cf875cf 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.activity_recognition /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state diff --git a/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs b/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs index f182c81..dceb4d6 100644 --- a/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs +++ b/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs @@ -57,6 +57,7 @@ namespace Tizen.Sensor /// /// Initializes a new instance of the class. /// + /// http://tizen.org/feature/sensor.wrist_up /// Thrown when an invalid argument is used /// Thrown when the sensor is not supported /// Thrown when the operation is invalid for the current state