From: Jyothi Kumar Sambolu <s.jyothi@samsung.com>
Date: Thu, 7 Jul 2016 04:55:38 +0000 (+0530)
Subject: Adding doxygen comments for missing symbols
X-Git-Tag: submit/tizen/20161214.063015~29
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3931717440c7c302b72351938323f79c246b0539;p=platform%2Fcore%2Fcsapi%2Fsensor.git

Adding doxygen comments for missing symbols

Change-Id: Ib4d8eac8198af60f65ed95c14e0e7b1888be5039
Signed-off-by: Jyothi Kumar Sambolu <s.jyothi@samsung.com>
---

diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/GravitySensor.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/GravitySensor.cs
index 9d73e7a..def7954 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/GravitySensor.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/GravitySensor.cs
@@ -77,6 +77,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<GravitySensorDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/LinearAccelerationSensor.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/LinearAccelerationSensor.cs
index 8a24843..6ca09e4 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/LinearAccelerationSensor.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/LinearAccelerationSensor.cs
@@ -77,6 +77,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<LinearAccelerationSensorDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/Magnetometer.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/Magnetometer.cs
index b2fd4c8..33e7eea 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/Magnetometer.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/Magnetometer.cs
@@ -77,6 +77,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<MagnetometerDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/MagnetometerRotationVectorSensor.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
index a1e0df6..0987d7f 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
@@ -87,6 +87,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<MagnetometerRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/OrientationSensor.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/OrientationSensor.cs
index 6f0d7d3..682db09 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/OrientationSensor.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/OrientationSensor.cs
@@ -77,6 +77,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<OrientationSensorDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/RotationVectorSensor.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/RotationVectorSensor.cs
index 71a1ec2..55505ee 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/RotationVectorSensor.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/RotationVectorSensor.cs
@@ -87,6 +87,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<RotationVectorSensorDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/UncalibratedMagnetometer.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/UncalibratedMagnetometer.cs
index bb1bde2..fb3eb6f 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/UncalibratedMagnetometer.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Plugins/UncalibratedMagnetometer.cs
@@ -92,6 +92,9 @@ namespace Tizen.System.Sensor
 
         public event EventHandler<UncalibratedMagnetometerDataUpdatedEventArgs> DataUpdated;
 
+        /// <summary>
+        /// Event handler for accuracy changed events.
+        /// </summary>
         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
         {
             add
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/Sensor.cs b/Tizen.System.Sensor/Tizen.System.Sensor/Sensor.cs
index 4b64eb2..dfff1aa 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/Sensor.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/Sensor.cs
@@ -210,6 +210,10 @@ namespace Tizen.System.Sensor
             }
         }
 
+        /// <summary>
+        /// Gets or sets the time span.
+        /// </summary>
+        /// <value>The time span.</value>
         public TimeSpan TimeSpan
         {
             set
@@ -224,6 +228,10 @@ namespace Tizen.System.Sensor
             }
         }
 
+        /// <summary>
+        /// Indicates whether this sensor is sensing.
+        /// </summary>
+        /// <value><c>true</c> if this sensor is sensing; otherwise, <c>false</c>.</value>
         public bool IsSensing
         {
             get
diff --git a/Tizen.System.Sensor/Tizen.System.Sensor/SensorEnumerations.cs b/Tizen.System.Sensor/Tizen.System.Sensor/SensorEnumerations.cs
index 94f071c..c711152 100644
--- a/Tizen.System.Sensor/Tizen.System.Sensor/SensorEnumerations.cs
+++ b/Tizen.System.Sensor/Tizen.System.Sensor/SensorEnumerations.cs
@@ -151,30 +151,82 @@ namespace Tizen.System.Sensor
         All
     }
 
+    /// <summary>
+    /// Sensor attribute.
+    /// </summary>
     public enum SensorAttribute
     {
+        /// <summary>
+        /// The axis orientation.
+        /// </summary>
         AxisOrientation,
+
+        /// <summary>
+        /// The pause policy.
+        /// </summary>
         PausePolicy
     }
 
+    /// <summary>
+    /// Pedometer state.
+    /// </summary>
     public enum PedometerState
     {
+        /// <summary>
+        /// Unknown.
+        /// </summary>
         Unknown,
+
+        /// <summary>
+        /// Stop state.
+        /// </summary>
         Stop,
+
+        /// <summary>
+        /// Walking state.
+        /// </summary>
         Walk,
+
+        /// <summary>
+        /// Running state.
+        /// </summary>
         Run
     }
 
+    /// <summary>
+    /// Sleep monitor state.
+    /// </summary>
     public enum SleepMonitorState
     {
+        /// <summary>
+        /// Unknown.
+        /// </summary>
         Unknown,
+
+        /// <summary>
+        /// The wake state.
+        /// </summary>
+
         Wake,
+        /// <summary>
+        /// The sleeping state.
+        /// </summary>
         Sleep
     }
 
+    /// <summary>
+    /// Proximity sensor state.
+    /// </summary>
     public enum ProximitySensorState
     {
+        /// <summary>
+        /// Near sate.
+        /// </summary>
         Near = 0,
+
+        /// <summary>
+        /// Far state.
+        /// </summary>
         Far = 5
     }
 }