[Location] Addressing the doxygen review comments

Change-Id: Ib8281e7e68d4b2ea38c8bc4a44d2c12896fe52fd
Signed-off-by: Abhijit RD <abhijit.rd@samsung.com>

diff --git a/Tizen.Location/Tizen.Location/Location.cs b/Tizen.Location/Tizen.Location/Location.cs
index c7ccb90..b04116c 100644 (file)
--- a/Tizen.Location/Tizen.Location/Location.cs
+++ b/Tizen.Location/Tizen.Location/Location.cs
@@ -34,8 +34,8 @@ namespace Tizen.Location
 
         /// <summary>
         /// The parameterized constructor of Location Class.
-        /// <param name="latitude"> Latitude component of the device co-ordinate.</param>
-        /// <param name="longitude"> Longitude component of the device co-ordinate.</param>
+        /// <param name="latitude"> Latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees).</param>
+        /// <param name="longitude"> Longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees).</param>
         /// <param name="altitude"> Altitude value.</param>
         /// <param name="horizontalAccuracy"> Horizontal Accuracy in meters.</param>
         /// <param name="speed"> Devie Speed.</param>
@@ -144,7 +144,7 @@ namespace Tizen.Location
         }
 
         /// <summary>
-        /// The timestamp (time when measurement took place or 0 if valid).
+        /// The time value when the measurement was done.
         /// </summary>
         public DateTime Timestamp
         {
@@ -162,10 +162,10 @@ namespace Tizen.Location
         /// <summary>
         /// Gets the distance between the two given coordinates.
         /// </summary>
-        /// <param name="startLatitude"> The latitude of the source location.</param>
-        /// <param name="startLongitude"> The Longitude of the source location.</param>
-        /// <param name="endLatitude"> The latitude of the source location.</param>
-        /// <param name="endLongitude"> The longitude of the source location.</param>
+        /// <param name="startLatitude"> The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
+        /// <param name="startLongitude"> The Longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
+        /// <param name="endLatitude"> The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
+        /// <param name="endLongitude"> The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
         /// <returns>Returns the distance between source and destination.</returns>
         public static double GetDistanceBetween(double startLatitude, double startLongitude, double endLatitude, double endLongitude)
         {

diff --git a/Tizen.Location/Tizen.Location/LocationBoundary.cs b/Tizen.Location/Tizen.Location/LocationBoundary.cs
index 7b2a5bd..be95708 100644 (file)
--- a/Tizen.Location/Tizen.Location/LocationBoundary.cs
+++ b/Tizen.Location/Tizen.Location/LocationBoundary.cs
@@ -18,10 +18,11 @@ namespace Tizen.Location
     public abstract class LocationBoundary
     {
         internal IntPtr handle;
+
         /// <summary>
         /// Gets the location boundary type.
         /// </summary>
-        public BoundaryType BoundaryType{ get; internal set;}
+        public BoundaryType BoundaryType{ get; internal set; }
 
         internal IntPtr GetHandle()
         {
@@ -239,7 +240,16 @@ namespace Tizen.Location
     [StructLayout(LayoutKind.Sequential)]
     public struct Coordinate
     {
+        /// <summary>
+        /// Latitude component of the co-ordinate.
+        /// Should have a value between [-90.0 ~ 90.0] (degrees).
+        /// </summary>
         public double Latitude;
+
+        /// <summary>
+        /// Longitude component of the co-ordinate.
+        /// Should have a value between [-180.0 ~ 180.0] (degrees).
+        /// </summary>
         public double Longitude;
     }
 }

diff --git a/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs b/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs
index d17261b..d4ec4e9 100644 (file)
--- a/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs
+++ b/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs
@@ -9,7 +9,7 @@
 using System;\r
 \r
 \r
-namespace Tizen.Location\r
+namespace Tizen.Location
 {\r
     /// <summary>
     /// An extended EventArgs class which contains the changed location information.
@@ -21,9 +21,9 @@ namespace Tizen.Location
         /// Class Constructor for LocationUpdatedEventArgs class.
         /// </summary>
         /// <param name="locationUpdate"> Object of Location class.</param>
-        public LocationChangedEventArgs(Location updatatedLocation)
+        public LocationChangedEventArgs(Location locationUpdate)
         {
-            Location = updatatedLocation;
+            Location = locationUpdate;
         }
 
         /// <summary>

diff --git a/Tizen.Location/Tizen.Location/LocationError.cs b/Tizen.Location/Tizen.Location/LocationError.cs
index 59ac119..91bb7ae 100644 (file)
--- a/Tizen.Location/Tizen.Location/LocationError.cs
+++ b/Tizen.Location/Tizen.Location/LocationError.cs
@@ -12,7 +12,7 @@ using Tizen.Internals.Errors;
 
 namespace Tizen.Location
 {
-    public static class LocationManagerError
+    internal static class LocationManagerError
     {
         public const int Base = -0x02C00000;
         public const int BoundsBase = -0x02C00000 | 0x20;

diff --git a/Tizen.Location/Tizen.Location/Locator.cs b/Tizen.Location/Tizen.Location/Locator.cs
index 30d3698..c92fae5 100644 (file)
--- a/Tizen.Location/Tizen.Location/Locator.cs
+++ b/Tizen.Location/Tizen.Location/Locator.cs
@@ -299,7 +299,7 @@ namespace Tizen.Location
         /// <summary>
         /// Gets the details of the location asynchronously.
         /// </summary>
-        /// <param name="timeout"> Timeout to stop requesting single location after.</param>
+        /// <param name="timeout"> Timeout to stop requesting single location after(seconds).</param>
         /// <returns> A task which contains the current location details</returns>
         public Task<Location> GetLocationAsync(int timeout)
         {
@@ -383,9 +383,9 @@ namespace Tizen.Location
 
 
         /// <summary>
-        /// Adds a bounds for a given location manager.
+        /// Adds a bounds for a given locator.
         /// </summary>
-        /// <param name="locationBoundary"> The boundary object to be added to the location manager.</param>
+        /// <param name="locationBoundary"> The boundary object to be added to the locator.</param>
         public void AddBoundary(LocationBoundary locationBoundary)
         {
             Log.Info(Globals.LogTag, "AddBoundary called");
@@ -399,9 +399,9 @@ namespace Tizen.Location
         }
 
         /// <summary>
-        /// Deletes a bounds for a given location.
+        /// Deletes a bounds for a given locator.
         /// </summary>
-        /// <param name="locationBoundary"> The boundary object to be removed from the location manager.</param>
+        /// <param name="locationBoundary"> The boundary object to be removed from the locator.</param>
         public void RemoveBoundary(LocationBoundary locationBoundary)
         {
             Log.Info(Globals.LogTag, "RemoveBoundary called");

diff --git a/Tizen.Location/Tizen.Location/LocatorHelper.cs b/Tizen.Location/Tizen.Location/LocatorHelper.cs
index 77531ed..8483f1d 100644 (file)
--- a/Tizen.Location/Tizen.Location/LocatorHelper.cs
+++ b/Tizen.Location/Tizen.Location/LocatorHelper.cs
@@ -29,7 +29,7 @@ namespace Tizen.Location
         /// </summary>
         /// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
         /// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
-        public static bool IsEnableType(LocationType locationType)
+        public static bool IsEnabledType(LocationType locationType)
         {
             Log.Info(Globals.LogTag, "Checking if the Location Manager type is Enabled");
             bool initStatus;

diff --git a/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs b/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs
index e44f720..4b7db7e 100644 (file)
--- a/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs
+++ b/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs
@@ -4,21 +4,21 @@
 // of Samsung Electronics, Inc. ("Confidential Information"). You
 // shall not disclose such Confidential Information and shall use
 // it only in accordance with the terms of the license agreement
-// you entered into with Samsung.\r
-\r
-using System;\r
-\r
-\r
-namespace Tizen.Location\r
-{\r
+// you entered into with Samsung.
+
+using System;
+
+
+namespace Tizen.Location
+{
     public class ZoneChangedEventArgs : EventArgs
     {
         /// <summary>
         /// Class Constructor for ZoneChangedEventArgs class.
         /// </summary>
         /// <param name="state"> An enumeration of type BoundaryState.</param>
-        /// <param name="latitude"> The latitude value.</param>
-        /// <param name="longitude"> The longitude value.</param>
+        /// <param name="latitude"> The latitude value[-90.0 ~ 90.0] (degrees).</param>
+        /// <param name="longitude"> The longitude value[-180.0 ~ 180.0] (degrees).</param>
         /// <param name="altitude"> The altitude value.</param>
         /// <param name="timestamp"> The timestamp value.</param>
         public ZoneChangedEventArgs(BoundaryState state, double latitude, double longitude, double altitude, DateTime timestamp)
@@ -54,5 +54,5 @@ namespace Tizen.Location
         /// Method to get the timestamp.
         /// </summary>
         public DateTime TimeStamp { get; private set; }
-    }\r
-}\r
+    }
+}