Adding doxygen comments for missing symbols
authorJyothi Kumar Sambolu <s.jyothi@samsung.com>
Thu, 7 Jul 2016 04:55:38 +0000 (10:25 +0530)
committerJyothi Kumar Sambolu <s.jyothi@samsung.com>
Thu, 7 Jul 2016 04:55:38 +0000 (10:25 +0530)
Change-Id: Ib4d8eac8198af60f65ed95c14e0e7b1888be5039
Signed-off-by: Jyothi Kumar Sambolu <s.jyothi@samsung.com>
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/GravitySensor.cs
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/LinearAccelerationSensor.cs
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/Magnetometer.cs
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/OrientationSensor.cs
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/RotationVectorSensor.cs
Tizen.System.Sensor/Tizen.System.Sensor/Plugins/UncalibratedMagnetometer.cs
Tizen.System.Sensor/Tizen.System.Sensor/Sensor.cs
Tizen.System.Sensor/Tizen.System.Sensor/SensorEnumerations.cs

index 9d73e7ab44972bcbe339d2eaefde047ca638eb6b..def7954f145c2487e1b80c038cf12663f617cf71 100644 (file)
@@ -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
index 8a2484352b9d635b101613403281f0884ea5df16..6ca09e4048b1faed3314aae3a2144cde6354ccbc 100644 (file)
@@ -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
index b2fd4c8b3607c96a37212344864e5bce45973578..33e7eea90a710d58eb5668b8123f1c57c6ecdbde 100644 (file)
@@ -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
index a1e0df65879fff33012291365986c7b660fb25f6..0987d7f67ea62a54463e80259c5e9b162d055b7c 100644 (file)
@@ -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
index 6f0d7d39c64cdfc7fd322ffe37f952a42be90a96..682db099dc6c4af8109bb48b4992bc703aa1ce0a 100644 (file)
@@ -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
index 71a1ec2367798f550f6cfd31fe934ba0d9c038c5..55505eead0434ed137df25ddd138184dbedbc5d1 100644 (file)
@@ -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
index bb1bde21e65ae32ad47c29c85471aaaa57aaf41d..fb3eb6f0d7c5afefc3601da64c68117efa586501 100644 (file)
@@ -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
index 4b64eb207bedeb51c26fe4f764ea40d20a20fe01..dfff1aa84ba24eca2d9aa3b118742d680cf35089 100644 (file)
@@ -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
index 94f071c1b47aa6e2c17e560ee8550a4b7f42a745..c71115295013d9cbefc26f1e87262922d6f7a401 100644 (file)
@@ -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
     }
 }