From 3938b456452ac41d06197eb392a6c7ad323ad1c3 Mon Sep 17 00:00:00 2001 From: "kj7.sung" Date: Fri, 26 May 2017 11:51:36 +0900 Subject: [PATCH] Modify api documentation Change-Id: I528b37b42b156a61ec2e9e3ce6ec490dcf9eba83 Signed-off-by: kj7.sung --- src/Tizen.Location/Tizen.Location/GpsSatellite.cs | 50 ++++----- src/Tizen.Location/Tizen.Location/Location.cs | 12 +-- .../Tizen.Location/LocationBoundary.cs | 40 +++---- src/Tizen.Location/Tizen.Location/LocationError.cs | 4 +- src/Tizen.Location/Tizen.Location/Locator.cs | 115 +++++++++++---------- src/Tizen.Location/Tizen.Location/LocatorHelper.cs | 6 +- 6 files changed, 119 insertions(+), 108 deletions(-) diff --git a/src/Tizen.Location/Tizen.Location/GpsSatellite.cs b/src/Tizen.Location/Tizen.Location/GpsSatellite.cs index f32db04..da40e85 100755 --- a/src/Tizen.Location/Tizen.Location/GpsSatellite.cs +++ b/src/Tizen.Location/Tizen.Location/GpsSatellite.cs @@ -37,8 +37,8 @@ namespace Tizen.Location /// The time interval between callback updates. /// Should be in the range [1~120] seconds. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public int Interval { get @@ -64,10 +64,10 @@ namespace Tizen.Location /// /// The NMEAData from the Satellite. /// - /// 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 location is not supported + /// 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 location is not supported. public string Nmea { get @@ -94,10 +94,11 @@ namespace Tizen.Location /// /// The Count of Active satellites. /// - /// 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 location is not supported + /// 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 location is not supported. public int ActiveCount { get @@ -124,10 +125,11 @@ namespace Tizen.Location /// /// The Count of satellites in view. /// - /// 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 location is not supported + /// 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 location is not supported. public int InViewCount { get @@ -154,10 +156,11 @@ namespace Tizen.Location /// /// The list of satellites/last recorded satellites in view. /// - /// 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 location is not supported + /// 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 location is not supported. public IList Satellites { get @@ -192,9 +195,9 @@ namespace Tizen.Location /// /// The constructor of GpsSatellite class. - /// Locator object initilized using Gps. /// - /// Thrown when an invalid argument is used + /// Locator object initilized using Gps. + /// Thrown when an invalid argument is used. public GpsSatellite(Locator locator) { Log.Info(Globals.LogTag, "Calling GpsSatellite constructor"); @@ -221,9 +224,10 @@ namespace Tizen.Location /// (event) SatelliteStatusUpdated is raised whenever satellite information is updated. /// The callback will be invoked periodically (every Interval seconds). /// - /// Thrown when an invalid argument is used - /// Thrown when the app has no privilege to use the location - /// Thrown when the location is not supported + /// 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 location is not supported. public event EventHandler SatelliteStatusUpdated { add diff --git a/src/Tizen.Location/Tizen.Location/Location.cs b/src/Tizen.Location/Tizen.Location/Location.cs index 61b5a27..c46838e 100755 --- a/src/Tizen.Location/Tizen.Location/Location.cs +++ b/src/Tizen.Location/Tizen.Location/Location.cs @@ -42,6 +42,7 @@ namespace Tizen.Location /// /// The parameterized constructor of Location Class. + /// /// 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. @@ -49,8 +50,7 @@ namespace Tizen.Location /// Devie Speed. /// Device direction with respect to north. /// Time when the measurement took place. - /// - /// Thrown when an invalid argument is used + /// Thrown when an invalid argument is used. public Location(double latitude, double longitude, double altitude, double speed, double direction, double accuracy, int timestamp) { _latitude = latitude; @@ -196,8 +196,8 @@ namespace Tizen.Location /// 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. - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// 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) { double result; @@ -216,8 +216,8 @@ namespace Tizen.Location /// /// The location object to which distance is to be calculated. /// Returns the distance to the specified location. - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public double GetDistanceTo(Location location) { double result; diff --git a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs index 3dab561..116f6d5 100755 --- a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs +++ b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs @@ -62,8 +62,8 @@ namespace Tizen.Location /// /// The overidden Dispose method of the IDisposable class. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public void Dispose() { Log.Info(Globals.LogTag, "Dispose"); @@ -106,9 +106,9 @@ namespace Tizen.Location /// /// The coordinate which constitute the top left handside of the rectangular boundary. /// The coordinate which constitute 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 + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public RectangleBoundary(Coordinate topLeft, Coordinate bottomRight) { Log.Info(Globals.LogTag, "Calling RectangleBoundary constructor"); @@ -176,9 +176,9 @@ namespace Tizen.Location /// /// 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 - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public CircleBoundary(Coordinate coordinate, double radius) { Log.Info(Globals.LogTag, "Calling CircleBoundary constructor"); @@ -196,9 +196,9 @@ namespace Tizen.Location /// /// Gets the coordinate of the center of a circular 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 + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public Coordinate Center { get @@ -210,9 +210,9 @@ namespace Tizen.Location /// /// Gets the radius of a circular 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 + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public double Radius { get @@ -259,9 +259,9 @@ namespace Tizen.Location /// Constructor of the polygon boundary class. /// /// The coordinates which constitute the polgonal 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 + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public PolygonBoundary(IList coordinates) { Log.Info(Globals.LogTag, "Calling PolygonBoundary Constructor"); @@ -290,9 +290,9 @@ namespace Tizen.Location /// /// Gets the list of coordinates which constitute a polygonal 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 + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public IList Coordinates { get diff --git a/src/Tizen.Location/Tizen.Location/LocationError.cs b/src/Tizen.Location/Tizen.Location/LocationError.cs index 459ddd0..0471e54 100755 --- a/src/Tizen.Location/Tizen.Location/LocationError.cs +++ b/src/Tizen.Location/Tizen.Location/LocationError.cs @@ -26,7 +26,7 @@ namespace Tizen.Location } /// - /// Location Manager error codes + /// Location Manager error codes. /// public enum LocationError { @@ -43,7 +43,7 @@ namespace Tizen.Location } /// - /// Location Boundary error codes + /// Location Boundary error codes. /// public enum LocationBoundError { diff --git a/src/Tizen.Location/Tizen.Location/Locator.cs b/src/Tizen.Location/Tizen.Location/Locator.cs index b5c374e..229398a 100755 --- a/src/Tizen.Location/Tizen.Location/Locator.cs +++ b/src/Tizen.Location/Tizen.Location/Locator.cs @@ -62,9 +62,10 @@ namespace Tizen.Location /// The constructor of Locator class. /// /// The back-end positioning method to be used for LBS. - /// Thrown when the operation is invalid for the current state - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// http://tizen.org/feature/location + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public Locator(LocationType locationType) { Log.Info(Globals.LogTag, "Locator Constructor"); @@ -90,8 +91,8 @@ namespace Tizen.Location /// The time interval between callback updates. /// Should be in the range [1~120] seconds. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public int Interval { get @@ -118,8 +119,8 @@ namespace Tizen.Location /// The time interval between Distance based location callback updates. /// Should be in the range [1~120] seconds. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public int StayInterval { get @@ -146,8 +147,8 @@ namespace Tizen.Location /// The distance between callback updates. /// Should be in the range [1-120] meters. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public double Distance { get @@ -197,8 +198,9 @@ namespace Tizen.Location /// /// Gets the status whether mock location is enabled or not. /// - /// Thrown when the app has no privilege to use the location - /// Thrown when the location is not supported + /// http://tizen.org/privilege/location + /// Thrown when the app has no privilege to use the location. + /// Thrown when the location is not supported. public bool EnableMock { get @@ -244,10 +246,11 @@ namespace Tizen.Location /// /// Starts the Location Manager which has been created using the specified method. /// - /// 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 location is not supported + /// 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 location is not supported. public void Start() { Log.Info(Globals.LogTag, "Starting Location Manager"); @@ -264,9 +267,9 @@ namespace Tizen.Location /// Stops the Location Manager which has been activated using the specified method. /// Does not destroy the manager. /// - /// Thrown when the operation is invalid for the current state - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public void Stop() { Log.Info(Globals.LogTag, "Stopping Location Manager"); @@ -283,10 +286,11 @@ namespace Tizen.Location /// Sets a mock location for the given location method. /// /// The location object containing the mock location details. - /// 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 location is not supported + /// 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 location is not supported. public void SetMockLocation(Location location) { Log.Info(Globals.LogTag, "Setting mock location"); @@ -310,10 +314,11 @@ namespace Tizen.Location /// /// Clears a mock location for the given location method. /// - /// 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 location is not supported + /// 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 location is not supported. public void ClearMock() { Log.Info(Globals.LogTag, "Clear mock location"); @@ -330,10 +335,11 @@ namespace Tizen.Location /// /// Timeout to stop requesting single location after(seconds). /// A task which contains the current location details - /// 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 location is not supported + /// 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 location is not supported. public Task GetLocationAsync(int timeout) { var task = new TaskCompletionSource(); @@ -373,11 +379,12 @@ namespace Tizen.Location /// /// Gets the details of the location. /// - /// which contains the current location details - /// 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 location is not supported + /// 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 location is not supported. public Location GetLocation() { double latitude = 0; @@ -423,9 +430,9 @@ namespace Tizen.Location /// Adds a bounds for a given locator. /// /// 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 + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public void AddBoundary(LocationBoundary locationBoundary) { Log.Info(Globals.LogTag, "AddBoundary called"); @@ -442,9 +449,9 @@ namespace Tizen.Location /// Deletes a bounds for a given locator. /// /// 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 - /// Thrown when the location is not supported + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public void RemoveBoundary(LocationBoundary locationBoundary) { Log.Info(Globals.LogTag, "RemoveBoundary called"); @@ -459,8 +466,8 @@ namespace Tizen.Location /// /// The overidden Dispose method of the IDisposable class. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public void Dispose() { Dispose(true); @@ -491,8 +498,8 @@ namespace Tizen.Location /// /// (event) ServiceStateChanged Event is invoked when the location service state is changed. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public event EventHandler ServiceStateChanged { add @@ -552,8 +559,8 @@ namespace Tizen.Location /// /// (event) ZoneChanged is invoked when the previously set boundary area is entered or left. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public event EventHandler ZoneChanged { add @@ -618,9 +625,9 @@ namespace Tizen.Location /// /// (event) SetttingChanged is raised when the location setting is changed. /// - /// Thrown when the operation is invalid for the current state - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public event EventHandler SettingChanged { add @@ -681,8 +688,8 @@ 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. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public event EventHandler DistanceBasedLocationChanged { add @@ -746,8 +753,8 @@ namespace Tizen.Location /// (event)LocationUpdated is raised at defined intervals of time with updated location information. /// The callback will be invoked periodically. /// - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public event EventHandler LocationChanged { add diff --git a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs index d66e591..064a1ad 100755 --- a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs +++ b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs @@ -37,9 +37,9 @@ 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. - /// Thrown when the operation is invalid for the current state - /// Thrown when an invalid argument is used - /// Thrown when the location is not supported + /// Thrown when the operation is invalid for the current state. + /// Thrown when an invalid argument is used. + /// Thrown when the location is not supported. public static bool IsEnabledType(LocationType locationType) { Log.Info(Globals.LogTag, "Checking if the Location Manager type is Enabled"); -- 2.7.4