From 870b19ef52307b189610c29bd2b4a892f3190443 Mon Sep 17 00:00:00 2001 From: chanywa Date: Thu, 17 Aug 2017 19:56:23 +0900 Subject: [PATCH] Sync with original location package Change-Id: Ibf86cad3895d289e9ac81d2d2bc1b8d59b3c6511 --- src/Tizen.Location/Tizen.Location/GpsSatellite.cs | 84 +++++++-------- src/Tizen.Location/Tizen.Location/Location.cs | 58 +++++------ .../Tizen.Location/LocationBoundary.cs | 70 ++++++------- .../Tizen.Location/LocationChangedEventArgs.cs | 12 +-- src/Tizen.Location/Tizen.Location/LocationError.cs | 4 +- src/Tizen.Location/Tizen.Location/Locator.cs | 116 ++++++++++----------- .../Tizen.Location/LocatorEnumerations.cs | 12 +-- src/Tizen.Location/Tizen.Location/LocatorHelper.cs | 8 +- src/Tizen.Location/Tizen.Location/NamespaceDoc.cs | 10 +- .../SatelliteStatusChangedEventArgs.cs | 16 +-- .../Tizen.Location/ServiceStateChangedEventArgs.cs | 10 +- .../Tizen.Location/SettingChangedEventArgs.cs | 12 +-- .../Tizen.Location/ZoneChangedEventArgs.cs | 22 ++-- 13 files changed, 217 insertions(+), 217 deletions(-) diff --git a/src/Tizen.Location/Tizen.Location/GpsSatellite.cs b/src/Tizen.Location/Tizen.Location/GpsSatellite.cs index b9bf58d..d870c96 100755 --- a/src/Tizen.Location/Tizen.Location/GpsSatellite.cs +++ b/src/Tizen.Location/Tizen.Location/GpsSatellite.cs @@ -21,9 +21,9 @@ using System.Runtime.InteropServices; namespace Tizen.Location { /// - /// A class which contains the functionality for obtaining information about Gps satellites in range and in use. + /// This class contains the functionality for obtaining information about GPS satellites in the range and in use. /// - /// 3 + /// 3 public class GpsSatellite { private int _interval = 1; @@ -36,10 +36,10 @@ namespace Tizen.Location /// /// The time interval between callback updates. - /// Should be in the range [1~120] seconds. + /// Should be in the range of 1~120 seconds. /// - /// 3 - /// Thrown when an invalid argument is used. + /// 3 + /// Thrown when an an invalid argument is used. public int Interval { get @@ -63,12 +63,12 @@ namespace Tizen.Location } /// - /// The NMEAData from the Satellite. + /// The NMEA data from the satellite. /// - /// 3 + /// 3 /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public string Nmea { @@ -94,13 +94,13 @@ namespace Tizen.Location /// - /// The Count of Active satellites. + /// The count of active satellites. /// - /// 3 + /// 3 /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public int ActiveCount { @@ -126,13 +126,13 @@ namespace Tizen.Location } /// - /// The Count of satellites in view. + /// The count of satellites in view. /// - /// 3 + /// 3 /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public int InViewCount { @@ -158,13 +158,13 @@ namespace Tizen.Location } /// - /// The list of satellites/last recorded satellites in view. + /// The list of satellites or last recorded satellites in view. /// - /// 3 + /// 3 /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public IList Satellites { @@ -199,10 +199,10 @@ namespace Tizen.Location } /// - /// The constructor of GpsSatellite class. + /// The constructor of the GpsSatellite class. /// - /// 3 - /// Locator object initilized using Gps. + /// 3 + /// The locator object initilized using GPS. /// Thrown when an invalid argument is used. public GpsSatellite(Locator locator) { @@ -227,13 +227,13 @@ namespace Tizen.Location } /// - /// (event) SatelliteStatusUpdated is raised whenever satellite information is updated. + /// The SatelliteStatusUpdated event is raised whenever the satellite information is updated. /// The callback will be invoked periodically (every Interval seconds). /// - /// 3 + /// 3 /// http://tizen.org/privilege/location /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public event EventHandler SatelliteStatusUpdated { @@ -300,20 +300,20 @@ namespace Tizen.Location } /// - /// A class which contains the information of the Satellite under consideration. + /// This class contains the information of the satellite under consideration. /// - /// 3 + /// 3 public class SatelliteInformation { /// - /// Class Constructor for SatelliteInformation class. + /// The Class constructor for the SatelliteInformation class. /// - /// 3 - /// The azimuth value of the satellite in degrees. - /// The elevation of the satellite in meters. - /// The Prn value of the satellite. - /// The SNR value of the satellite in dB. - /// The flag signaling if satellite is in use. + /// 3 + /// The azimuth value of the satellite in degrees. + /// The elevation of the satellite in meters. + /// The PRN value of the satellite. + /// The SNR value of the satellite in dB. + /// The flag signaling if the satellite is in use. public SatelliteInformation(uint azimuth, uint elevation, uint prn, uint snr, bool active) { Azimuth = azimuth; @@ -324,36 +324,36 @@ namespace Tizen.Location } /// - /// The Azimuth information of the Satellite. + /// The azimuth information of the satellite. /// - /// 3 + /// 3 /// The azimuth value of the satellite in degrees. public uint Azimuth { get; private set; } /// - /// The Elevation information of the Satellite. + /// The elevation information of the satellite. /// - /// 3 + /// 3 /// The azimuth value of the satellite in degrees. public uint Elevation { get; private set; } /// - /// The PRN of the Satellite. + /// The PRN of the satellite. /// - /// 3 + /// 3 /// The azimuth value of the satellite in degrees. public uint Prn { get; private set; } /// - /// The SNR of the Satellite. + /// The SNR of the satellite. /// - /// 3 + /// 3 public uint Snr { get; private set; } /// - /// The operational status of the Satellite. + /// The operational status of the satellite. /// - /// 3 + /// 3 public bool Active { get; private set; } } } diff --git a/src/Tizen.Location/Tizen.Location/Location.cs b/src/Tizen.Location/Tizen.Location/Location.cs index 7127800..6b37212 100755 --- a/src/Tizen.Location/Tizen.Location/Location.cs +++ b/src/Tizen.Location/Tizen.Location/Location.cs @@ -20,10 +20,10 @@ using System.Collections.Generic; namespace Tizen.Location { /// - /// A class which contains the details of the location rrequested. + /// This class contains details of the location requested. /// Includes the functionality to get the distance between locations. /// - /// 3 + /// 3 public class Location { private double _latitude; @@ -35,23 +35,23 @@ namespace Tizen.Location internal int _timestamp; /// - /// The default constructor of Location Class. + /// The default constructor of the Location class. /// - /// 3 + /// 3 public Location() { } /// - /// The parameterized constructor of Location Class. + /// The parameterized constructor of the Location class. /// - /// 3 - /// 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. - /// Accuracy in meters. - /// Devie Speed. - /// Device direction with respect to north. + /// 3 + /// The latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees). + /// The longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees). + /// The altitude value. + /// The accuracy in meters. + /// The device speed. + /// The device direction with respect to the north. /// Time when the measurement took place. /// Thrown when an invalid argument is used. public Location(double latitude, double longitude, double altitude, double speed, double direction, double accuracy, int timestamp) @@ -68,7 +68,7 @@ namespace Tizen.Location /// /// The current latitude [-90.0 ~ 90.0] (degrees). /// - /// 3 + /// 3 public double Latitude { get @@ -94,7 +94,7 @@ namespace Tizen.Location /// /// The current longitude [-180.0 ~ 180.0] (degrees). /// - /// 3 + /// 3 public double Longitude { get @@ -120,7 +120,7 @@ namespace Tizen.Location /// /// The current altitude (meters). /// - /// 3 + /// 3 public double Altitude { get @@ -134,9 +134,9 @@ namespace Tizen.Location } /// - /// The Device Speed (km/h). + /// The device speed (km/h). /// - /// 3 + /// 3 public double Speed { get @@ -150,9 +150,9 @@ namespace Tizen.Location } /// - /// The direction, degrees from the north. + /// The direction and degrees from the north. /// - /// 3 + /// 3 public double Direction { get @@ -168,7 +168,7 @@ namespace Tizen.Location /// /// The accuracy. /// - /// 3 + /// 3 public double Accuracy { get @@ -184,7 +184,7 @@ namespace Tizen.Location /// /// The time value when the measurement was done. /// - /// 3 + /// 3 public DateTime Timestamp { get @@ -201,12 +201,12 @@ namespace Tizen.Location /// /// Gets the distance between the two given coordinates. /// - /// 3 - /// 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. + /// 3 + /// 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 the source and the destination. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. public static double GetDistanceBetween(double startLatitude, double startLongitude, double endLatitude, double endLongitude) @@ -223,9 +223,9 @@ namespace Tizen.Location } /// - /// Gets the distance between the current and specified location. + /// Gets the distance between the current and the specified location. /// - /// 3 + /// 3 /// The location object to which distance is to be calculated. /// Returns the distance to the specified location. /// Thrown when an invalid argument is used. diff --git a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs index f66f609..d8991e4 100755 --- a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs +++ b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs @@ -21,9 +21,9 @@ using System.Runtime.InteropServices; namespace Tizen.Location { /// - /// Abstract class which provides functions related to geographic bounds information. + /// The LocationBoundary class is an abstract class that provides functions related to the geographic bounds information. /// - /// 3 + /// 3 public abstract class LocationBoundary : IDisposable { internal IntPtr handle; @@ -32,14 +32,14 @@ namespace Tizen.Location /// /// Gets the location boundary type. /// - /// 3 + /// 3 public BoundaryType BoundaryType{ get; internal set; } internal LocationBoundary() { } /// - /// The destructor of LocationBoundary class. + /// The destructor of the LocationBoundary class. /// - /// 3 + /// 3 ~LocationBoundary() { Log.Info(Globals.LogTag, "The destructor of LocationBoundary class"); @@ -54,7 +54,7 @@ namespace Tizen.Location /// /// Checks if the boundary contains the specified geographical coordinates. /// - /// 3 + /// 3 /// The coordinate which needs to be checked. /// Returns a boolean value indicating whether or not the specified coordinate lies in the geographical area. public bool BoundaryContainsCoordinates(Coordinate coordinate) @@ -66,7 +66,7 @@ namespace Tizen.Location /// /// The overidden Dispose method of the IDisposable class. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. public void Dispose() @@ -101,18 +101,18 @@ namespace Tizen.Location } /// - /// Class representing a rectangular location boundary. + /// This class represents a rectangular location boundary. /// Inherits the Abstract LocationBoundary class. /// - /// 3 + /// 3 public class RectangleBoundary : LocationBoundary { /// - /// Constructor of the Rectangle boundary class. + /// The constructor of the Rectangle boundary class. /// - /// 3 - /// The coordinate which constitute the top left handside of the rectangular boundary. - /// The coordinate which constitute the bottom right handside of the rectangular boundary. + /// 3 + /// The coordinate which constitutes the top-left handside of the rectangular boundary. + /// The coordinate which constitutes the bottom-right handside of the rectangular boundary. /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -131,9 +131,9 @@ namespace Tizen.Location } /// - /// Gets the Top Left handside coordinate of a rectangular boundary. + /// Gets the top-left handside coordinate of a rectangular boundary. /// - /// 3 + /// 3 public Coordinate TopLeft { get @@ -144,9 +144,9 @@ namespace Tizen.Location } /// - /// Gets the Bottom Right handside coordinate of a rectangular boundary. + /// Gets the bottom-right handside coordinate of a rectangular boundary. /// - /// 3 + /// 3 public Coordinate BottomRight { get @@ -175,16 +175,16 @@ namespace Tizen.Location } /// - /// Class representing a circular location boundary. + /// This class represents a circular location boundary. /// Inherits the Abstract LocationBoundary class. /// - /// 3 + /// 3 public class CircleBoundary : LocationBoundary { /// - /// Constructor of the Circular boundary class. + /// The constructor of the Circular boundary class. /// - /// 3 + /// 3 /// The coordinates which constitute the center of the circular boundary. /// The radius value of the circular boundary. /// Thrown when the operation is invalid for the current state. @@ -207,7 +207,7 @@ namespace Tizen.Location /// /// Gets the coordinate of the center of a circular boundary. /// - /// 3 + /// 3 /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -222,7 +222,7 @@ namespace Tizen.Location /// /// Gets the radius of a circular boundary. /// - /// 3 + /// 3 /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -263,16 +263,16 @@ namespace Tizen.Location } /// - /// Class representing a polygonal location boundary. + /// This class represents a polygonal location boundary. /// Inherits the Abstract LocationBoundary class. /// - /// 3 + /// 3 public class PolygonBoundary : LocationBoundary { /// - /// Constructor of the polygon boundary class. + /// The constructor of the Polygon Boundary class. /// - /// 3 + /// 3 /// The coordinates which constitute the polgonal boundary. /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. @@ -303,9 +303,9 @@ namespace Tizen.Location } /// - /// Gets the list of coordinates which constitute a polygonal boundary + /// Gets the list of coordinates which constitute a polygonal boundary. /// - /// 3 + /// 3 /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -341,24 +341,24 @@ namespace Tizen.Location } /// - /// The structure which represents the co-ordinates of a geographical location. + /// This structure represents the coordinates of a geographical location. /// - /// 3 + /// 3 [StructLayout(LayoutKind.Sequential)] public struct Coordinate { /// - /// Latitude component of the co-ordinate. + /// Latitude component of the coordinate. /// Should have a value between [-90.0 ~ 90.0] (degrees). /// - /// 3 + /// 3 public double Latitude; /// - /// Longitude component of the co-ordinate. + /// Longitude component of the coordinate. /// Should have a value between [-180.0 ~ 180.0] (degrees). /// - /// 3 + /// 3 public double Longitude; } } diff --git a/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs index 6bfe66d..8774d0b 100755 --- a/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs +++ b/src/Tizen.Location/Tizen.Location/LocationChangedEventArgs.cs @@ -21,24 +21,24 @@ namespace Tizen.Location /// /// An extended EventArgs class which contains the changed location information. /// - /// 3 + /// 3 public class LocationChangedEventArgs : EventArgs { /// - /// Class Constructor for LocationUpdatedEventArgs class. + /// The class constructor for the LocationUpdatedEventArgs class. /// - /// 3 - /// Object of Location class. + /// 3 + /// Object of the Location class. public LocationChangedEventArgs(Location location) { Location = location; } /// - /// Get the Location Update information. + /// Gets the location update information. /// - /// 3 + /// 3 public Location Location { get; private set; } } } diff --git a/src/Tizen.Location/Tizen.Location/LocationError.cs b/src/Tizen.Location/Tizen.Location/LocationError.cs index 3254d8e..3f2f633 100755 --- a/src/Tizen.Location/Tizen.Location/LocationError.cs +++ b/src/Tizen.Location/Tizen.Location/LocationError.cs @@ -28,7 +28,7 @@ namespace Tizen.Location /// /// Location Manager error codes. /// - /// 3 + /// 3 public enum LocationError { None = ErrorCode.None,/**< Successful */ @@ -46,7 +46,7 @@ namespace Tizen.Location /// /// Location Boundary error codes. /// - /// 3 + /// 3 public enum LocationBoundError { None = ErrorCode.None,/**< Successful */ diff --git a/src/Tizen.Location/Tizen.Location/Locator.cs b/src/Tizen.Location/Tizen.Location/Locator.cs index 3c2d320..9bae3ae 100755 --- a/src/Tizen.Location/Tizen.Location/Locator.cs +++ b/src/Tizen.Location/Tizen.Location/Locator.cs @@ -28,11 +28,11 @@ namespace Tizen.Location } /// - /// A class which contains the functionality for obtaining geographical infomation and setting boundary condition. - /// Notifications on events like service becoming enabled or disabled, new position data being available + /// This class contains the functionality for obtaining the geographical infomation and setting the boundary condition. + /// Notifications on events like service becoming enabled or disabled, new position data being available, /// and others can also be acquired. /// - /// 3 + /// 3 public class Locator : IDisposable { private int _interval = 1; @@ -64,9 +64,9 @@ namespace Tizen.Location private EventHandler _locationChanged; /// - /// The constructor of Locator class. + /// The constructor of the Locator class. /// - /// 3 + /// 3 /// The back-end positioning method to be used for LBS. /// http://tizen.org/feature/location /// Thrown when the operation is invalid for the current state. @@ -86,9 +86,9 @@ namespace Tizen.Location } /// - /// The destructor of Locator class. + /// The destructor of the Locator class. /// - /// 3 + /// 3 ~Locator() { Dispose(false); @@ -96,9 +96,9 @@ namespace Tizen.Location /// /// The time interval between callback updates. - /// Should be in the range [1~120] seconds. + /// Should be in the range of 1~120 seconds. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. public int Interval { @@ -123,10 +123,10 @@ namespace Tizen.Location } /// - /// The time interval between Distance based location callback updates. - /// Should be in the range [1~120] seconds. + /// The time interval between the distance-based location callback updates. + /// Should be in the range of 1~120 seconds. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. public int StayInterval { @@ -151,10 +151,10 @@ namespace Tizen.Location } /// - /// The time interval between position collection in batch mode. - /// Should be in the range [1~255] seconds. + /// The time interval between the position collection in batch mode. + /// Should be in the range of 1~255 seconds. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. public int BatchInterval { @@ -179,10 +179,10 @@ namespace Tizen.Location } /// - /// The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If BatchPeriod is zero or smaller than BatchInterval, then batch mode will not working. In addition, sometimes the period may not work as you intended, the maximum permissible value for batch_period is device specific. - /// Should be in the range [0~60000] seconds. + /// The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If the BatchPeriod is zero or smaller than the BatchInterval, then the batch mode will not work. In addition, sometimes the period may not work as you intended, the maximum permissible value for the batch period is device specific. + /// Should be in the range of 0~60000 seconds. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. public int BatchPeriod { @@ -208,9 +208,9 @@ namespace Tizen.Location /// /// The distance between callback updates. - /// Should be in the range [1-120] meters. + /// Should be in the range of 1-120 meters. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. public double Distance { @@ -235,9 +235,9 @@ namespace Tizen.Location } /// - /// Gets the Location object. + /// Gets the location object. /// - /// 3 + /// 3 public Location Location { get @@ -248,9 +248,9 @@ namespace Tizen.Location } /// - /// Gets the type used to obtain Location data. + /// Gets the type used to obtain the location data. /// - /// 3 + /// 3 public LocationType LocationType { get @@ -261,11 +261,11 @@ namespace Tizen.Location } /// - /// Gets the status whether mock location is enabled or not. + /// Gets the status whether the mock location is enabled or not. /// - /// 3 + /// 3 /// http://tizen.org/privilege/location - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public bool EnableMock { @@ -312,11 +312,11 @@ namespace Tizen.Location /// /// Starts the Location Manager which has been created using the specified method. /// - /// 3 + /// 3 /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public void Start() { @@ -346,7 +346,7 @@ namespace Tizen.Location /// Stops the Location Manager which has been activated using the specified method. /// Does not destroy the manager. /// - /// 3 + /// 3 /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -365,12 +365,12 @@ namespace Tizen.Location /// /// Sets a mock location for the given location method. /// - /// 3 + /// 3 /// The location object containing the mock location details. /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public void SetMockLocation(Location location) { @@ -395,11 +395,11 @@ namespace Tizen.Location /// /// Clears a mock location for the given location method. /// - /// 3 + /// 3 /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public void ClearMock() { @@ -415,13 +415,13 @@ namespace Tizen.Location /// /// Gets the details of the location asynchronously. /// - /// 3 - /// Timeout to stop requesting single location after(seconds). - /// A task which contains the current location details + /// 3 + /// Timeout to stop requesting a single location after (seconds). + /// A task which contains the current location details. /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public Task GetLocationAsync(int timeout) { @@ -462,12 +462,12 @@ namespace Tizen.Location /// /// Gets the details of the location. /// - /// 3 - /// which contains the current location details. + /// 3 + /// Which contains the current location details. /// http://tizen.org/privilege/location /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. - /// Thrown when the app has no privilege to use the location. + /// Thrown when the application has no privilege to use the location. /// Thrown when the location is not supported. public Location GetLocation() { @@ -511,10 +511,10 @@ namespace Tizen.Location /// - /// Adds a bounds for a given locator. + /// Adds a bound for a given locator. /// - /// 3 - /// The boundary object to be added to the locator. + /// 3 + /// The boundary object to be added to the locator. /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -531,9 +531,9 @@ namespace Tizen.Location } /// - /// Deletes a bounds for a given locator. + /// Deletes a bound for a given locator. /// - /// 3 + /// 3 /// The boundary object to be removed from the locator. /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. @@ -552,7 +552,7 @@ namespace Tizen.Location /// /// The overidden Dispose method of the IDisposable class. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. public void Dispose() { @@ -582,9 +582,9 @@ namespace Tizen.Location } /// - /// (event) ServiceStateChanged Event is invoked when the location service state is changed. + /// The ServiceStateChanged event is invoked when the location service state is changed. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. public event EventHandler ServiceStateChanged @@ -644,9 +644,9 @@ namespace Tizen.Location } /// - /// (event) ZoneChanged is invoked when the previously set boundary area is entered or left. + /// The ZoneChanged event is invoked when the previously set boundary area is entered or left. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. public event EventHandler ZoneChanged @@ -711,9 +711,9 @@ namespace Tizen.Location } /// - /// (event) SetttingChanged is raised when the location setting is changed. + /// The SetttingChanged event is raised when the location setting is changed. /// - /// 3 + /// 3 /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. @@ -774,10 +774,10 @@ namespace Tizen.Location } /// - /// (event) DistanceBasedLocationChanged is raised with updated location information. - /// The callback will be invoked at minimum interval or minimum distance with updated position information. + /// The DistanceBasedLocationChanged event is raised with the updated location information. + /// The callback will be invoked at a minimum interval or minimum distance with the updated position information. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. public event EventHandler DistanceBasedLocationChanged @@ -840,10 +840,10 @@ namespace Tizen.Location } /// - /// (event)LocationUpdated is raised at defined intervals of time with updated location information. + /// The LocationUpdated event is raised at defined intervals of time with the updated location information. /// The callback will be invoked periodically. /// - /// 3 + /// 3 /// Thrown when an invalid argument is used. /// Thrown when the location is not supported. public event EventHandler LocationChanged diff --git a/src/Tizen.Location/Tizen.Location/LocatorEnumerations.cs b/src/Tizen.Location/Tizen.Location/LocatorEnumerations.cs index 8f04a80..9de03cc 100755 --- a/src/Tizen.Location/Tizen.Location/LocatorEnumerations.cs +++ b/src/Tizen.Location/Tizen.Location/LocatorEnumerations.cs @@ -22,7 +22,7 @@ namespace Tizen.Location /// /// Enumeration for the state of the location service. /// - /// 3 + /// 3 public enum ServiceState { Disabled = 0, /** - /// Enumeration for the type of connection used in acquiring Location data. + /// Enumeration for the type of connection used in acquiring the location data. /// - /// 3 + /// 3 public enum LocationType { Hybrid = 0, /** /// Enumeration for the created boundary type. /// - /// 3 + /// 3 public enum BoundaryType { Rectangle = 0, /** - /// Enumeration for error code for Location manager. + /// Enumeration for the error code for location manager. /// - /// 3 + /// 3 public enum BoundaryState { In = 0, /**< Boundary In (Zone In) */ diff --git a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs index 5ad09ee..37de8c9 100755 --- a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs +++ b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs @@ -23,8 +23,8 @@ namespace Tizen.Location /// /// Checks if the specified geographical positioning type is supported or not. /// - /// 3 - /// The back-end positioning method to be used for LBS. + /// 3 + /// 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 IsSupportedType(LocationType locationType) { @@ -36,8 +36,8 @@ namespace Tizen.Location /// /// Checks if the specified geographical positioning type is enabled or not. /// - /// 3 - /// The back-end positioning method to be used for LBS. + /// 3 + /// The back-end positioning method to be used for LBS. /// Returns a boolean value indicating whether or not the specified method is supported. /// Thrown when the operation is invalid for the current state. /// Thrown when an invalid argument is used. diff --git a/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs b/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs index e8ba5d4..697cfd1 100755 --- a/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs +++ b/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs @@ -1,16 +1,16 @@ /** -The Tizen.Location namespace provides classes for obtaining information related to geographical location. +The Tizen.Location namespace provides classes for obtaining information related to the geographical location. Notifications on events like service becoming enabled or disabled, -new position data being available and others can also be acquired. +new position data being available, and others can also be acquired.

Overview

-The Tizen.Location namespace provides classes for obtaining information related to geographical location. +The Tizen.Location namespace provides classes for obtaining information related to the geographical location. Notifications on events like service becoming enabled or disabled, -new position data being available and others can also be acquired. +new position data being available, and others can also be acquired.

Related Features

-To guarantee that the Location application runs on a device with location profile feature, +To guarantee that the location application runs on a device with the location profile feature, declare the following feature requirements in the config file:
http://tizen.org/feature/location
http://tizen.org/feature/location.gps
diff --git a/src/Tizen.Location/Tizen.Location/SatelliteStatusChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/SatelliteStatusChangedEventArgs.cs index c6f4ba4..aa27203 100755 --- a/src/Tizen.Location/Tizen.Location/SatelliteStatusChangedEventArgs.cs +++ b/src/Tizen.Location/Tizen.Location/SatelliteStatusChangedEventArgs.cs @@ -21,12 +21,12 @@ namespace Tizen.Location public class SatelliteStatusChangedEventArgs : EventArgs { /// - /// Class Constructor for SatelliteStatusChangedEventArgs class. + /// The class constructor for the SatelliteStatusChangedEventArgs class. /// - /// 3 - /// The number of active satellites. - /// The number of satellites in view. - /// The time at which the data has been extracted. + /// 3 + /// The number of active satellites. + /// The number of satellites in view. + /// The time at which the data has been extracted. public SatelliteStatusChangedEventArgs(uint activeCount, uint inviewCount, DateTime timestamp) { ActiveCount = activeCount; @@ -37,19 +37,19 @@ namespace Tizen.Location /// /// Gets the number of active satellites. /// - /// 3 + /// 3 public uint ActiveCount { get; private set; } /// /// Gets the number of satellites in view. /// - /// 3 + /// 3 public uint InViewCount { get; private set; } /// /// Get the timestamp. /// - /// 3 + /// 3 public DateTime Timestamp { get; private set; } } } diff --git a/src/Tizen.Location/Tizen.Location/ServiceStateChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/ServiceStateChangedEventArgs.cs index 35ff1a7..5cfbff7 100755 --- a/src/Tizen.Location/Tizen.Location/ServiceStateChangedEventArgs.cs +++ b/src/Tizen.Location/Tizen.Location/ServiceStateChangedEventArgs.cs @@ -19,14 +19,14 @@ using System; namespace Tizen.Location { /// - /// An extended EventArgs class which contains the changed location service state. + /// An extended EventArgs class contains the changed location service state. /// public class ServiceStateChangedEventArgs : EventArgs { /// - /// Class Constructor for ServiceStateChangedEventArgs class. + /// The class constructor for the ServiceStateChangedEventArgs class. /// - /// 3 + /// 3 /// An enumeration of type LocationServiceState. public ServiceStateChangedEventArgs(ServiceState state) { @@ -34,9 +34,9 @@ namespace Tizen.Location } /// - /// Get the Service state. + /// Get the service state. /// - /// 3 + /// 3 public ServiceState ServiceState { get; private set; } } } diff --git a/src/Tizen.Location/Tizen.Location/SettingChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/SettingChangedEventArgs.cs index 2869b69..c191ce3 100755 --- a/src/Tizen.Location/Tizen.Location/SettingChangedEventArgs.cs +++ b/src/Tizen.Location/Tizen.Location/SettingChangedEventArgs.cs @@ -21,11 +21,11 @@ namespace Tizen.Location public class SettingChangedEventArgs : EventArgs { /// - /// Class Constructor for SettingChangedEventArgs class. + /// The class constructor for the SettingChangedEventArgs class. /// - /// 3 - /// The positioing method used for Location information. - /// Status of the method. + /// 3 + /// The positioing method used for the location information. + /// The status of the method. public SettingChangedEventArgs(LocationType type, bool enable) { LocationType = type; @@ -35,13 +35,13 @@ namespace Tizen.Location /// /// Gets the currently used location method. /// - /// 3 + /// 3 public LocationType LocationType { get; private set; } /// /// Method to get the setting value changed. /// - /// 3 + /// 3 public bool IsEnabled { get; private set; } } } diff --git a/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs b/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs index 9bc05e4..7e4e91d 100755 --- a/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs +++ b/src/Tizen.Location/Tizen.Location/ZoneChangedEventArgs.cs @@ -21,12 +21,12 @@ namespace Tizen.Location public class ZoneChangedEventArgs : EventArgs { /// - /// Class Constructor for ZoneChangedEventArgs class. + /// The class constructor for the ZoneChangedEventArgs class. /// - /// 3 + /// 3 /// An enumeration of type BoundaryState. - /// The latitude value[-90.0 ~ 90.0] (degrees). - /// The longitude value[-180.0 ~ 180.0] (degrees). + /// 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) @@ -39,33 +39,33 @@ namespace Tizen.Location } /// - /// Get the Boundary State. + /// Gets the boundary state. /// /// 3 public BoundaryState BoundState { get; private set; } /// - /// Get the latitude. + /// Gets the latitude. /// - /// 3 + /// 3 public double Latitude { get; private set; } /// - /// Get the longitude. + /// Gets the longitude. /// /// 3 public double Longitude { get; private set; } /// - /// Get the altitude. + /// Gets the altitude. /// - /// 3 + /// 3 public double Altitude { get; private set; } /// /// Method to get the timestamp. /// - /// 3 + /// 3 public DateTime Timestamp { get; private set; } } } -- 2.7.4