From: Abhijit RD Date: Tue, 5 Jul 2016 11:13:19 +0000 (+0530) Subject: [Location] Addressing the doxygen review comments X-Git-Tag: submit/trunk/20170823.075128~103^2~34^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0984213de4bb84692cc5eca48751c2e92e4f71b2;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [Location] Addressing the doxygen review comments Change-Id: Ib8281e7e68d4b2ea38c8bc4a44d2c12896fe52fd Signed-off-by: Abhijit RD --- diff --git a/src/Tizen.Location/Tizen.Location/Location.cs b/src/Tizen.Location/Tizen.Location/Location.cs index c7ccb90..b04116c 100644 --- a/src/Tizen.Location/Tizen.Location/Location.cs +++ b/src/Tizen.Location/Tizen.Location/Location.cs @@ -34,8 +34,8 @@ namespace Tizen.Location /// /// The parameterized constructor of Location Class. - /// Latitude component of the device co-ordinate. - /// Longitude component of the device co-ordinate. + /// Latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees). + /// Longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees). /// Altitude value. /// Horizontal Accuracy in meters. /// Devie Speed. @@ -144,7 +144,7 @@ namespace Tizen.Location } /// - /// The timestamp (time when measurement took place or 0 if valid). + /// The time value when the measurement was done. /// public DateTime Timestamp { @@ -162,10 +162,10 @@ namespace Tizen.Location /// /// Gets the distance between the two given coordinates. /// - /// The latitude of the source location. - /// The Longitude of the source location. - /// The latitude of the source location. - /// The longitude of the source location. + /// The latitude of the source location [-90.0 ~ 90.0] (degrees). + /// The Longitude of the source location[-180.0 ~ 180.0] (degrees). + /// The latitude of the source location [-90.0 ~ 90.0] (degrees). + /// The longitude of the source location[-180.0 ~ 180.0] (degrees). /// Returns the distance between source and destination. public static double GetDistanceBetween(double startLatitude, double startLongitude, double endLatitude, double endLongitude) { diff --git a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs index 7b2a5bd..be95708 100644 --- a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs +++ b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs @@ -18,10 +18,11 @@ namespace Tizen.Location public abstract class LocationBoundary { internal IntPtr handle; + /// /// Gets the location boundary type. /// - 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 { + /// + /// Latitude component of the co-ordinate. + /// Should have a value between [-90.0 ~ 90.0] (degrees). + /// public double Latitude; + + /// + /// Longitude component of the co-ordinate. + /// Should have a value between [-180.0 ~ 180.0] (degrees). + /// public double Longitude; } } diff --git a/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs index d17261b..d4ec4e9 100644 --- a/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs +++ b/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs @@ -9,7 +9,7 @@ using System; -namespace Tizen.Location +namespace Tizen.Location { /// /// An extended EventArgs class which contains the changed location information. @@ -21,9 +21,9 @@ namespace Tizen.Location /// Class Constructor for LocationUpdatedEventArgs class. /// /// Object of Location class. - public LocationChangedEventArgs(Location updatatedLocation) + public LocationChangedEventArgs(Location locationUpdate) { - Location = updatatedLocation; + Location = locationUpdate; } /// diff --git a/src/Tizen.Location/Tizen.Location/LocationError.cs b/src/Tizen.Location/Tizen.Location/LocationError.cs index 59ac119..91bb7ae 100644 --- a/src/Tizen.Location/Tizen.Location/LocationError.cs +++ b/src/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/src/Tizen.Location/Tizen.Location/Locator.cs b/src/Tizen.Location/Tizen.Location/Locator.cs index 30d3698..c92fae5 100644 --- a/src/Tizen.Location/Tizen.Location/Locator.cs +++ b/src/Tizen.Location/Tizen.Location/Locator.cs @@ -299,7 +299,7 @@ namespace Tizen.Location /// /// Gets the details of the location asynchronously. /// - /// Timeout to stop requesting single location after. + /// Timeout to stop requesting single location after(seconds). /// A task which contains the current location details public Task GetLocationAsync(int timeout) { @@ -383,9 +383,9 @@ namespace Tizen.Location /// - /// Adds a bounds for a given location manager. + /// Adds a bounds for a given locator. /// - /// The boundary object to be added to the location manager. + /// The boundary object to be added to the locator. public void AddBoundary(LocationBoundary locationBoundary) { Log.Info(Globals.LogTag, "AddBoundary called"); @@ -399,9 +399,9 @@ namespace Tizen.Location } /// - /// Deletes a bounds for a given location. + /// Deletes a bounds for a given locator. /// - /// The boundary object to be removed from the location manager. + /// The boundary object to be removed from the locator. public void RemoveBoundary(LocationBoundary locationBoundary) { Log.Info(Globals.LogTag, "RemoveBoundary called"); diff --git a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs index 77531ed..8483f1d 100644 --- a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs +++ b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs @@ -29,7 +29,7 @@ namespace Tizen.Location /// /// The back-end positioning method to be used for LBS. /// Returns a boolean value indicating whether or not the specified method is supported. - 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/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs index e44f720..4b7db7e 100644 --- a/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs +++ b/src/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. - -using System; - - -namespace Tizen.Location -{ +// you entered into with Samsung. + +using System; + + +namespace Tizen.Location +{ public class ZoneChangedEventArgs : EventArgs { /// /// Class Constructor for ZoneChangedEventArgs class. /// /// An enumeration of type BoundaryState. - /// The latitude value. - /// The longitude value. + /// The latitude value[-90.0 ~ 90.0] (degrees). + /// The longitude value[-180.0 ~ 180.0] (degrees). /// The altitude value. /// The timestamp value. public ZoneChangedEventArgs(BoundaryState state, double latitude, double longitude, double altitude, DateTime timestamp) @@ -54,5 +54,5 @@ namespace Tizen.Location /// Method to get the timestamp. /// public DateTime TimeStamp { get; private set; } - } -} + } +}