From f8f31596e3e33da16f889937deeb54481d5a1fac Mon Sep 17 00:00:00 2001 From: chanywa Date: Fri, 12 May 2017 09:26:22 +0900 Subject: [PATCH] Modify documentation of APIs Change-Id: I67effcb8d092bada8ff6bf107401abfefb2baa23 --- src/Tizen.Maps/Interop/Interop.ErrorCode.cs | 8 +- src/Tizen.Maps/Tizen.Maps/Area.cs | 17 +- src/Tizen.Maps/Tizen.Maps/Direction.cs | 18 +- src/Tizen.Maps/Tizen.Maps/DistanceUnit.cs | 8 +- src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs | 21 ++- src/Tizen.Maps/Tizen.Maps/GeocoordinatesList.cs | 3 + src/Tizen.Maps/Tizen.Maps/GestureType.cs | 16 +- src/Tizen.Maps/Tizen.Maps/IGeocodePreference.cs | 13 +- .../Tizen.Maps/IPlaceSearchPreference.cs | 17 +- .../Tizen.Maps/IRouteSearchPreference.cs | 12 +- src/Tizen.Maps/Tizen.Maps/MapGestureEventArgs.cs | 12 +- src/Tizen.Maps/Tizen.Maps/MapObject.cs | 5 +- src/Tizen.Maps/Tizen.Maps/MapService.cs | 115 +++++++----- src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs | 17 +- src/Tizen.Maps/Tizen.Maps/MapTypes.cs | 12 +- src/Tizen.Maps/Tizen.Maps/MapView.cs | 199 +++++++++++++++++---- src/Tizen.Maps/Tizen.Maps/Marker.cs | 52 ++++-- src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs | 3 +- src/Tizen.Maps/Tizen.Maps/Overlay.cs | 39 ++-- src/Tizen.Maps/Tizen.Maps/Place.cs | 35 ++-- src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs | 29 +-- src/Tizen.Maps/Tizen.Maps/PlaceAddressList.cs | 10 +- src/Tizen.Maps/Tizen.Maps/PlaceAttribute.cs | 11 +- src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs | 15 +- src/Tizen.Maps/Tizen.Maps/PlaceContact.cs | 8 +- src/Tizen.Maps/Tizen.Maps/PlaceEditorial.cs | 8 +- src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs | 24 ++- src/Tizen.Maps/Tizen.Maps/PlaceImage.cs | 12 +- src/Tizen.Maps/Tizen.Maps/PlaceLink.cs | 8 +- src/Tizen.Maps/Tizen.Maps/PlaceList.cs | 5 +- src/Tizen.Maps/Tizen.Maps/PlaceMedia.cs | 6 +- src/Tizen.Maps/Tizen.Maps/PlaceRating.cs | 6 +- src/Tizen.Maps/Tizen.Maps/PlaceReview.cs | 14 +- src/Tizen.Maps/Tizen.Maps/Polygon.cs | 20 ++- src/Tizen.Maps/Tizen.Maps/Polyline.cs | 15 +- src/Tizen.Maps/Tizen.Maps/ReverseGeocodeRequest.cs | 2 +- src/Tizen.Maps/Tizen.Maps/Route.cs | 25 +-- src/Tizen.Maps/Tizen.Maps/RouteFeature.cs | 22 +-- src/Tizen.Maps/Tizen.Maps/RouteFeatureWeight.cs | 10 +- src/Tizen.Maps/Tizen.Maps/RouteManeuver.cs | 16 +- src/Tizen.Maps/Tizen.Maps/RouteOptimization.cs | 15 +- src/Tizen.Maps/Tizen.Maps/RouteSearchRequest.cs | 2 +- src/Tizen.Maps/Tizen.Maps/RouteSegment.cs | 15 +- src/Tizen.Maps/Tizen.Maps/SearchPreference.cs | 32 ++-- src/Tizen.Maps/Tizen.Maps/ServiceData.cs | 34 ++-- src/Tizen.Maps/Tizen.Maps/ServiceRequestType.cs | 28 +-- src/Tizen.Maps/Tizen.Maps/SnapshotType.cs | 4 +- src/Tizen.Maps/Tizen.Maps/TransportMode.cs | 10 +- src/Tizen.Maps/Tizen.Maps/TurnInstruction.cs | 30 ++-- 49 files changed, 648 insertions(+), 410 deletions(-) diff --git a/src/Tizen.Maps/Interop/Interop.ErrorCode.cs b/src/Tizen.Maps/Interop/Interop.ErrorCode.cs index 49f46da..8c4eaab 100755 --- a/src/Tizen.Maps/Interop/Interop.ErrorCode.cs +++ b/src/Tizen.Maps/Interop/Interop.ErrorCode.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); @@ -57,7 +57,7 @@ internal static class ErrorCodeExtensions /// /// Utility method to check for error, returns false if failed and print warning messages /// - /// true in case of no error, false otherwise + /// Returns true in case of no error, otherwise false. internal static bool WarnIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0) { if (err.IsFailed()) @@ -71,7 +71,7 @@ internal static class ErrorCodeExtensions /// /// Utility method to check for error, returns false if failed and throw exception /// - /// true in case of no error + /// Returns true in case of no error, otherwise false. internal static bool ThrowIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0) { if (err.IsFailed()) @@ -104,4 +104,4 @@ internal static class ErrorCodeExtensions default: return new System.InvalidOperationException(errMessage); } } -} \ No newline at end of file +} diff --git a/src/Tizen.Maps/Tizen.Maps/Area.cs b/src/Tizen.Maps/Tizen.Maps/Area.cs index 49908e1..965ee38 100755 --- a/src/Tizen.Maps/Tizen.Maps/Area.cs +++ b/src/Tizen.Maps/Tizen.Maps/Area.cs @@ -26,24 +26,26 @@ namespace Tizen.Maps internal Interop.AreaHandle handle; /// - /// Constructs rectangular area + /// Constructs rectangular area. /// /// Top left coordinate of the area /// Bottom left coordinate of the area - /// Throws if input coordinates are invalid - /// Throws if native operation failed to allocate memory + /// Thrown when the required feature is not supported. + /// Thrown when input coordinates are invalid + /// Thrown when native operation failed to allocate memory. public Area(Geocoordinates topLeft, Geocoordinates bottomRight) { handle = new Interop.AreaHandle(topLeft?.handle, bottomRight?.handle); } /// - /// Constructs circular area + /// Constructs circular area. /// /// Coordinate for center of the area /// Radius of the area - /// Throws if input coordinates are invalid - /// Throws if native operation failed to allocate memory + /// Thrown when the required feature is not supported. + /// Thrown when input coordinates are invalid + /// Thrown when native operation failed to allocate memory. public Area(Geocoordinates center, double radius) { handle = new Interop.AreaHandle(center?.handle, radius); @@ -66,6 +68,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/Direction.cs b/src/Tizen.Maps/Tizen.Maps/Direction.cs index ac2e3f3..9d9e584 100755 --- a/src/Tizen.Maps/Tizen.Maps/Direction.cs +++ b/src/Tizen.Maps/Tizen.Maps/Direction.cs @@ -22,39 +22,39 @@ namespace Tizen.Maps public enum DirectionType { /// - /// Unknown direction + /// Indicates unknown direction. /// None = Interop.RouteDirection.None, /// - /// North direction + /// Indicates north direction. /// North = Interop.RouteDirection.North, /// - /// North-West direction + /// Indicates north-west direction. /// NorthWest = Interop.RouteDirection.NorthWest, /// - /// North-East direction + /// Indicates north-east direction. /// NorthEast = Interop.RouteDirection.NorthEast, /// - /// South direction + /// Indicates south direction. /// South = Interop.RouteDirection.South, /// - /// South-East direction + /// Indicates south-East direction. /// SouthEast = Interop.RouteDirection.SouthEast, /// - /// South-West direction + /// Indicates south-West direction. /// SouthWest = Interop.RouteDirection.SouthWest, /// - /// West direction + /// Indicates west direction. /// West = Interop.RouteDirection.West, /// - /// East direction + /// Indicates east direction. /// East = Interop.RouteDirection.East, } diff --git a/src/Tizen.Maps/Tizen.Maps/DistanceUnit.cs b/src/Tizen.Maps/Tizen.Maps/DistanceUnit.cs index a1a4012..56cab0d 100755 --- a/src/Tizen.Maps/Tizen.Maps/DistanceUnit.cs +++ b/src/Tizen.Maps/Tizen.Maps/DistanceUnit.cs @@ -22,19 +22,19 @@ namespace Tizen.Maps public enum DistanceUnit { /// - /// Meter + /// Indicates meter unit. /// Meter = Interop.DistanceUnit.Meter, /// - /// Kilometer + /// Indicates kilometer unit. /// Kilometer = Interop.DistanceUnit.Kilometer, /// - /// Foot + /// Indicates foot unit. /// Foot = Interop.DistanceUnit.Foot, /// - /// Yard + /// Indicates yard unit. /// Yard = Interop.DistanceUnit.Yard, } diff --git a/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs b/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs index cd4377b..c2e4744 100755 --- a/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs +++ b/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs @@ -19,19 +19,19 @@ using System; namespace Tizen.Maps { /// - /// Class representing geographical co-ordinates + /// Class representing geographical coordinates. /// public class Geocoordinates : IDisposable { internal Interop.CoordinatesHandle handle; /// - /// Constructs map coordinate object + /// Constructs map coordinate object. /// - /// latitude value, must be between (-90.0 ~ 90.0) degrees - /// longitude value, must be between (-180.0 ~ 180.0) degrees - /// Throws if values for latitude and longitude are not valid - /// Throws if native operation failed to allocate memory + /// Latitude value, must be between (-90.0 ~ 90.0) degrees + /// Longitude value, must be between (-180.0 ~ 180.0) degrees + /// Thrown when values for latitude and longitude are not valid. + /// Thrown when native operation failed to allocate memory. public Geocoordinates(double latitude, double longitude) { handle = new Interop.CoordinatesHandle(latitude, longitude); @@ -43,7 +43,7 @@ namespace Tizen.Maps } /// - /// Latitude for this coordinate + /// Gets latitude of the coordinates. /// public double Latitude { @@ -54,7 +54,7 @@ namespace Tizen.Maps } /// - /// Longitude for this coordinate + /// Gets longitude of the coordinates. /// public double Longitude { @@ -65,7 +65,7 @@ namespace Tizen.Maps } /// - /// String that represents this coordinate + /// Returns a string that represents this object. /// public override string ToString() { @@ -84,6 +84,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/GeocoordinatesList.cs b/src/Tizen.Maps/Tizen.Maps/GeocoordinatesList.cs index 9f40a8c..59617cb 100755 --- a/src/Tizen.Maps/Tizen.Maps/GeocoordinatesList.cs +++ b/src/Tizen.Maps/Tizen.Maps/GeocoordinatesList.cs @@ -60,6 +60,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/GestureType.cs b/src/Tizen.Maps/Tizen.Maps/GestureType.cs index f81f659..4607787 100755 --- a/src/Tizen.Maps/Tizen.Maps/GestureType.cs +++ b/src/Tizen.Maps/Tizen.Maps/GestureType.cs @@ -22,35 +22,35 @@ namespace Tizen.Maps public enum GestureType { /// - /// Indicates empty gesture + /// Indicates empty gesture. /// None = Interop.ViewGesture.None, /// - /// Indicates the move map user gesture + /// Indicates the move map user gesture. /// Scroll = Interop.ViewGesture.Scroll, /// - /// Indicates the zoom user gesture + /// Indicates the zoom user gesture. /// Zoom = Interop.ViewGesture.Zoom, /// - /// Indicates the tap user gesture + /// Indicates the tap user gesture. /// Tap = Interop.ViewGesture.Tap, /// - /// Indicates the double tap user gesture + /// Indicates the double tap user gesture. /// DoubleTap = Interop.ViewGesture.DoubleTap, /// - /// Indicates the two-finger tap user gesture + /// Indicates the two-finger tap user gesture. /// TwoFingerTap = Interop.ViewGesture.TwoFingerTap, /// - /// Indicates the rotation user gesture + /// Indicates the rotation user gesture. /// Rotate = Interop.ViewGesture.Rotate, /// - /// Indicates the long press user gesture + /// Indicates the long press user gesture. /// LongPress = Interop.ViewGesture.LongPress, } diff --git a/src/Tizen.Maps/Tizen.Maps/IGeocodePreference.cs b/src/Tizen.Maps/Tizen.Maps/IGeocodePreference.cs index c3410a5..f767330 100755 --- a/src/Tizen.Maps/Tizen.Maps/IGeocodePreference.cs +++ b/src/Tizen.Maps/Tizen.Maps/IGeocodePreference.cs @@ -23,17 +23,16 @@ namespace Tizen.Maps public interface IGeocodePreference { /// - /// Preferred language + /// Gets or sets a string that presents preferred language. /// - /// - /// Language should be specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code e.g. "ko-KR" - /// + /// Language should be specified as an ISO 3166 alpha-2 two letter country-code + /// followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". string Language { get; set; } /// - /// Maximum result count for a service request + /// Gets or sets the maximum number of results. /// - /// Setting negative value will not have any effect on MaxResults value + /// Setting negative value will not have any effect on MaxResults value. int MaxResults { get; set; } } -} \ No newline at end of file +} diff --git a/src/Tizen.Maps/Tizen.Maps/IPlaceSearchPreference.cs b/src/Tizen.Maps/Tizen.Maps/IPlaceSearchPreference.cs index 771377f..fe8dae8 100755 --- a/src/Tizen.Maps/Tizen.Maps/IPlaceSearchPreference.cs +++ b/src/Tizen.Maps/Tizen.Maps/IPlaceSearchPreference.cs @@ -25,31 +25,30 @@ namespace Tizen.Maps public interface IPlaceSearchPreference { /// - /// Distance unit + /// Gets or sets distance unit. /// DistanceUnit Unit { get; set; } /// - /// Preferred language + /// Gets or sets preferred language. /// - /// - /// Language should be specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code e.g. "ko-KR" - /// + /// Language should be specified as an ISO 3166 alpha-2 two letter country-code + /// followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". string Language { get; set; } /// - /// Maximum result count for a service request + /// Gets or sets the maximum number of results. /// int MaxResults { get; set; } /// - /// Preferred country + /// Gets or sets a string that represents code of preferred country. /// string CountryCode { get; set; } /// - /// Search properties as key value pair + /// Gets or sets search properties as key value pair. /// IReadOnlyDictionary Properties { get; set; } } -} \ No newline at end of file +} diff --git a/src/Tizen.Maps/Tizen.Maps/IRouteSearchPreference.cs b/src/Tizen.Maps/Tizen.Maps/IRouteSearchPreference.cs index 0beaf09..b8c0a0d 100755 --- a/src/Tizen.Maps/Tizen.Maps/IRouteSearchPreference.cs +++ b/src/Tizen.Maps/Tizen.Maps/IRouteSearchPreference.cs @@ -23,32 +23,32 @@ namespace Tizen.Maps public interface IRouteSearchPreference { /// - /// Distance unit + /// Gets or sets distance unit. /// DistanceUnit Unit { get; set; } /// - /// Selected route optimization + /// Gets or sets route optimization. /// RouteOptimization Optimization { get; set; } /// - /// Route transport mode + /// Gets or sets route transport mode. /// TransportMode Mode { get; set; } /// - /// Route feature weight + /// Gets or sets route feature weight. /// RouteFeatureWeight RouteFeatureWeight { get; set; } /// - /// Route feature + /// Gets or sets route feature. /// RouteFeature RouteFeature { get; set; } /// - /// Indicate if search for alternative routes is enabled. + /// Gets or sets if searching for alternative routes is enabled. /// bool SearchAlternativeRoutes { get; set; } } diff --git a/src/Tizen.Maps/Tizen.Maps/MapGestureEventArgs.cs b/src/Tizen.Maps/Tizen.Maps/MapGestureEventArgs.cs index f3804a8..8c8679b 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapGestureEventArgs.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapGestureEventArgs.cs @@ -38,32 +38,32 @@ namespace Tizen.Maps } /// - /// Type of gesture event + /// Gets type of gesture event. /// public GestureType GestureType { get; } /// - /// Screen coordinates for the event + /// Gets screen coordinates in the event. /// public Point Position { get; } /// - /// Number of fingers detected in the event + /// Gets the number of fingers detected in the event. /// public int TouchCount { get; } /// - /// Zoom factor for zoom gesture event + /// Gets zoom factor for zoom gesture event. /// public double ZoomFactor { get; } /// - /// Angle of rotation for rotate gesture event + /// Gets angle of rotation for rotate gesture event. /// public double RotationAngle { get; } /// - /// Geo-coordinates for the event + /// Gets geographical coordinates for the event. /// public Geocoordinates Geocoordinates { get; } } diff --git a/src/Tizen.Maps/Tizen.Maps/MapObject.cs b/src/Tizen.Maps/Tizen.Maps/MapObject.cs index 802f0c7..56118fb 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapObject.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapObject.cs @@ -25,11 +25,14 @@ namespace Tizen.Maps internal MapObject() { } /// - /// Map Object's visibility + /// Gets or sets visibility of the map object. /// public abstract bool IsVisible { get; set; } + internal abstract void HandleClickedEvent(); + internal abstract void InvalidateMapObject(); + internal abstract Interop.ViewObjectHandle GetHandle(); } } diff --git a/src/Tizen.Maps/Tizen.Maps/MapService.cs b/src/Tizen.Maps/Tizen.Maps/MapService.cs index fee9379..c1f84cd 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapService.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapService.cs @@ -35,13 +35,16 @@ namespace Tizen.Maps /// - /// Creates a new Maps Service object for given service provider + /// Creates a new Maps Service object for given service provider. /// - /// Name of map service provider - /// Key string provided by map service provider - /// Throws if parameters are invalid - /// Throws if native operation failed to allocate memory, connect to service - /// Throws if user does not have privilege to access this API + /// A string which representing name of map service provider + /// A string which representing certificate key to use the map service provider + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when parameters are invalid. + /// Thrown when native operation failed to allocate memory, connect to service. + /// Thrown when application does not have some privilege to access this method. public MapService(string serviceProvider, string serviceProviderKey) { _serviceProvider = serviceProvider; @@ -52,8 +55,12 @@ namespace Tizen.Maps } /// - /// List of available map service providers + /// Gets list of available map service providers. /// + /// The list of map service providers. + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have privileges to access this property. public static IEnumerable Providers { get @@ -67,14 +74,16 @@ namespace Tizen.Maps } /// - /// Name of map service provider + /// Gets name of map service provider. /// public string Provider { get { return _serviceProvider; } } /// - /// Key for map service provider + /// Gets and sets a string representing keys for map service provider /// + /// Regaularly, the provider key is issued by each maps provider, after signing up for a plan in the web site. + /// Depending on the plan and its provider which you have signed, you might pay for the network traffic. public string ProviderKey { get @@ -88,7 +97,7 @@ namespace Tizen.Maps } /// - /// Filter used for place search result + /// Gets and sets a filter used for place search result. /// public PlaceFilter PlaceSearchFilter { @@ -106,7 +115,7 @@ namespace Tizen.Maps } /// - /// Search preferences used for Geocode/ ReverseGeocode request + /// Gets search preferences used for or request. /// public IGeocodePreference GeocodePreferences { @@ -117,7 +126,7 @@ namespace Tizen.Maps } /// - /// Search preferences used for search request + /// Gets search preferences used for search request. /// public IPlaceSearchPreference PlaceSearchPreferences { @@ -128,7 +137,7 @@ namespace Tizen.Maps } /// - /// Search preferences used for search request + /// Gets search preferences used for search request. /// public IRouteSearchPreference RouteSearchPreferences { @@ -139,7 +148,7 @@ namespace Tizen.Maps } /// - /// Search preferences + /// Gets and sets search preferences. /// public SearchPreference Preferences { @@ -162,9 +171,13 @@ namespace Tizen.Maps } /// - /// Gets the user's consent to use maps data + /// Gets the user's consent to use maps data. /// - /// true if user agreed that the application can use maps data, false otherwise + /// A string which representing the name of maps provider + /// Returns true if user agreed that the application can use maps data, otherwise false. + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public static async Task RequestUserConsent(string provider) { TaskCompletionSource tcs = new TaskCompletionSource(); @@ -182,10 +195,13 @@ namespace Tizen.Maps } /// - /// Checks if the Maps Service supports given request + /// Checks if the Maps Service supports given request. /// - /// request type to be checked - /// true if the Maps Service supports a request, false otherwise + /// Request type to check + /// Returns true if the Maps Service supports a request, otherwise false. + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public bool IsSupported(ServiceRequestType type) { bool result; @@ -195,10 +211,13 @@ namespace Tizen.Maps } /// - /// Checks if the Maps Service supports given data feature + /// Checks if the Maps Service supports given data feature. /// - /// data feature to be checked - /// true if the Maps Service supports a data feature, false otherwise + /// Data feature to check + /// Returns true if the Maps Service supports a data feature, otherwise false. + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public bool IsSupported(ServiceData data) { bool result; @@ -208,30 +227,31 @@ namespace Tizen.Maps } /// - /// Creates gGeocode search request for given free-formed address string + /// Creates geocode search request for given free-formed address string. /// - /// Free-formed address - /// Returns GeocodeRequest object created with address string + /// A string which representing free-formed address + /// GeocodeRequest object created with address string public GeocodeRequest CreateGeocodeRequest(string address) { return new GeocodeRequest(this, address); } /// - /// Creates geocode search request for given free-formed address string, within the specified boundary + /// Creates geocode search request for given free-formed address string, within the specified boundary. /// - /// Free-formed address - /// Interested area - /// Returns GeocodeRequest object created with address string and specified boundary + /// A string which representing free-formed address + /// An instance of Area object which representing interested area + /// + /// GeocodeRequest object created with address string and specified boundary public GeocodeRequest CreateGeocodeRequest(string address, Area boundary) { return new GeocodeRequest(this, address, boundary); } /// - /// Creates geocode search request for given structured address + /// Creates geocode search request for given structured address. /// - /// address of interest + /// A string which representing address of interest /// Returns GeocodeRequest object created with structured address public GeocodeRequest CreateGeocodeRequest(PlaceAddress address) { @@ -239,10 +259,10 @@ namespace Tizen.Maps } /// - /// Creates reverse geocode search request for given latitude and longitude + /// Creates a reverse geocode search request for given latitude and longitude. /// - /// Latitude for location of interest - /// Longitude for location of interest + /// Latitude of interested place + /// Longitude of interested place /// Returns ReverseGeocodeRequest object created with location coordinates public ReverseGeocodeRequest CreateReverseGeocodeRequest(double latitude, double longitute) { @@ -250,7 +270,7 @@ namespace Tizen.Maps } /// - /// Creates reverse geocode search request for given position coordinates list + /// Creates a reverse geocode search request for given position coordinates list. /// /// Coordinates list with [2 ~ 100] coordinates /// Returns MultiReverseGeocodeRequest object created with list of location coordinates @@ -260,10 +280,10 @@ namespace Tizen.Maps } /// - /// Creates route search request for origin and destination points + /// Creates a route search request for origin and destination points. /// - /// starting point - /// destination + /// Starting point + /// Destination /// Returns RouteSearchRequest object created with origin and destination coordinates public RouteSearchRequest CreateRouteSearchRequest(Geocoordinates from, Geocoordinates to) { @@ -271,10 +291,10 @@ namespace Tizen.Maps } /// - /// Creates place search request for specified search radius around a given coordinates position + /// Creates a place search request for specified search radius around a given coordinates position. /// - /// Interested position - /// Search radius + /// A geographical coordinates of center + /// A double value which representing radius of area to search places /// Returns PlaceSearchRequest object created with location coordinates and search radius public PlaceSearchRequest CreatePlaceSearchRequest(Geocoordinates coordinates, int distance) { @@ -282,9 +302,9 @@ namespace Tizen.Maps } /// - /// Creates place search for places within specified boundary + /// Creates a place search request for places within specified boundary. /// - /// Interested area + /// An instance of Area object which representing area to search interested places /// Returns PlaceSearchRequest object created with specified boundary public PlaceSearchRequest CreatePlaceSearchRequest(Area boundary) { @@ -292,10 +312,10 @@ namespace Tizen.Maps } /// - /// Creates place search for free formed address within boundary + /// Creates a place search request for free-formed address within boundary. /// - /// Free-formed address - /// Interested area + /// A string which representing free-formed address + /// An instance of Area object which representing area to search interested places /// Returns PlaceSearchRequest object created with address string and specified boundary public PlaceSearchRequest CreatePlaceSearchRequest(string address, Area boundary) { @@ -318,6 +338,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs b/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs index 3490032..cebc9e1 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs @@ -37,7 +37,7 @@ namespace Tizen.Maps internal MapService _service; /// - /// Creates map service request + /// Creates a map service request. /// /// map service object /// Request type @@ -48,12 +48,16 @@ namespace Tizen.Maps } /// - /// Sends request to map service provider + /// Sends a request to map service provider. /// /// Response from map service provider - /// Throws if request is canceled - /// Throws if native operation failed - /// Throws if arguments are invalid + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the result is invalid. + /// Thrown when arguments are invalid public async Task> GetResponseAsync() { IEnumerable task = null; @@ -98,6 +102,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/MapTypes.cs b/src/Tizen.Maps/Tizen.Maps/MapTypes.cs index fbc3525..4cde30c 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapTypes.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapTypes.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); @@ -22,20 +22,20 @@ namespace Tizen.Maps public enum MapTypes { /// - /// Normal street theme + /// Indicates normal street theme. /// Normal = Interop.ViewType.Normal, /// - /// Satellite theme + /// Indicates satellite theme. /// Satellite = Interop.ViewType.Satellite, /// - /// Terrain theme + /// Indicates terrain theme. /// Terrain = Interop.ViewType.Terrain, /// - /// Hybrid theme, has both satellite and normal theme + /// Indicates hybrid theme, has both satellite and normal theme. /// Hybrid = Interop.ViewType.Hybrid, } -} \ No newline at end of file +} diff --git a/src/Tizen.Maps/Tizen.Maps/MapView.cs b/src/Tizen.Maps/Tizen.Maps/MapView.cs index 178fc06..a9cd3a4 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapView.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapView.cs @@ -23,7 +23,7 @@ using System.Collections.Generic; namespace Tizen.Maps { /// - /// Map View + /// Map View class to show a map on the screen. /// public class MapView : Layout, IDisposable { @@ -46,10 +46,15 @@ namespace Tizen.Maps private event EventHandler _viewReadyEventHandler; /// - /// Creates the View and link it to the instance of map service + /// Creates the view and link it to the instance of map service. /// - /// The evas object to be drawn - /// Map service + /// An instance of object which map view will be drawn + /// An instance of object + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when parameters are invalid + /// Thrown when native operation failed to allocate memory, connect to service public MapView(EvasObject parent, MapService service) : base(parent) { handle = new Interop.ViewHandle(service.handle, this); @@ -64,8 +69,10 @@ namespace Tizen.Maps } /// - /// Scrolled gesture event + /// Adds or removes event handlers to deliver scrolled gesture event. /// + /// Event handlers to get scrolled gesture event + /// Thrown when the required feature is not supported. public event EventHandler Scrolled { add @@ -88,8 +95,10 @@ namespace Tizen.Maps } /// - /// ZoomChanged gesture event + /// Adds or removes event handlers to deliver zoomed gesture event. /// + /// Event handlers to get zoomed gesture event + /// Thrown when the required feature is not supported. public event EventHandler ZoomChanged { add @@ -112,8 +121,10 @@ namespace Tizen.Maps } /// - /// Clicked gesture event + /// Adds or removes event handlers to deliver clicked gesture event. /// + /// Event handlers to get clicked gesture event + /// Thrown when the required feature is not supported. public event EventHandler Clicked { add @@ -136,8 +147,10 @@ namespace Tizen.Maps } /// - /// DoubleClicked gesture event + /// Adds or removes event handlers to deliver double-clicked gesture event. /// + /// Event handlers to get double-clicked gesture event + /// Thrown when the required feature is not supported. public event EventHandler DoubleClicked { add @@ -160,8 +173,10 @@ namespace Tizen.Maps } /// - /// TwoFingerPressed gesture event + /// Adds or removes event handlers to deliver clicked gesture event with two-fingers. /// + /// Event handlers to get clicked gesture event + /// Thrown when the required feature is not supported. public event EventHandler TwoFingerPressed { add @@ -184,8 +199,10 @@ namespace Tizen.Maps } /// - /// Rotated gesture event + /// Adds or removes event handlers to deliver rotated gesture event. /// + /// Event handlers to get rotated gesture event + /// Thrown when the required feature is not supported. public event EventHandler Rotated { add @@ -207,9 +224,12 @@ namespace Tizen.Maps } } + /// - /// LongPressed gesture event + /// Adds or removes event handlers to deliver long-pressed gesture event. /// + /// Event handlers to get long-pressed gesture event + /// Thrown when the required feature is not supported. public event EventHandler LongPressed { add @@ -232,8 +252,10 @@ namespace Tizen.Maps } /// - /// ViewReady gesture event + /// Adds or removes event handlers to deliver a event representing the view is ready to be used. /// + /// Event handlers to get view ready event + /// Thrown when the required feature is not supported. public event EventHandler ViewReady { add @@ -251,8 +273,14 @@ namespace Tizen.Maps } /// - /// Map View's current zoom level + /// Gets or sets current zoom level. /// + /// It is an integer value that representing current zoom level. + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public int ZoomLevel { get @@ -267,8 +295,14 @@ namespace Tizen.Maps } /// - /// Minimum zoom level for map view + /// Gets or sets minimum zoom level. /// + /// It is an integer value that limits minimal zoom level within range of current map plug-in supported. + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public int MinimumZoomLevel { get @@ -283,8 +317,14 @@ namespace Tizen.Maps } /// - /// Maximum zoom level for map view + /// Gets or sets maximum zoom level. /// + /// It is an integer value that limits maximum zoom level within range of current map plug-in supported. + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public int MaximumZoomLevel { get @@ -299,8 +339,14 @@ namespace Tizen.Maps } /// - /// orientation on the View [0 ~ 360 degrees] + /// Gets or sets orientation on the map view. /// + /// It is an integer value from 0 to 360 that indicates orientation of the map view + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public double Orientation { get @@ -315,8 +361,13 @@ namespace Tizen.Maps } /// - /// Map view type (theme) + /// Gets or sets theme type of the map view. /// + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public MapTypes MapType { get @@ -331,8 +382,13 @@ namespace Tizen.Maps } /// - /// Indicates whether the map should show the 3D buildings layer + /// Indicates whether the map should show the 3D buildings layer. /// + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public bool BuildingsEnabled { get @@ -347,8 +403,13 @@ namespace Tizen.Maps } /// - /// Indicates whether the map should show the traffic layer + /// Indicates whether the map should show the traffic layer. /// + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public bool TrafficEnabled { get @@ -363,8 +424,13 @@ namespace Tizen.Maps } /// - /// Indicates whether the map should show the public transit layer + /// Indicates whether the map should show the public transit layer. /// + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public bool PublicTransitEnabled { get @@ -379,8 +445,13 @@ namespace Tizen.Maps } /// - /// Gets whether the scale-bar is enabled or not + /// Indicates whether the scale-bar is enabled or not. /// + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. public bool ScalebarEnabled { get @@ -395,8 +466,20 @@ namespace Tizen.Maps } /// - /// Map view's language + /// Sets language of map view. /// + /// The display language in the map. + /// A language is specified as an ISO 3166 alpha-2 two letter country-code + /// followed by ISO 639-1 for the two-letter language code. + /// Each language tag is composed of one or more "subtags" separated by hyphens (-). + /// Each subtag is composed of basic Latin letters or digits only. + /// For example, "ko-KR" for Korean, "en-US" for American English. + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. public string Language { get @@ -411,8 +494,14 @@ namespace Tizen.Maps } /// - /// Geographical coordinates for map view's center + /// Gets or sets geographical coordinates for map view's center. /// + /// http://tizen.org/privilege/mapservice + /// http://tizen.org/privilege/internet + /// http://tizen.org/privilege/network.get + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. public Geocoordinates Center { get @@ -427,7 +516,7 @@ namespace Tizen.Maps } /// - /// List of map object added to map view + /// Gets a list of map object added to map view. /// public IEnumerable Children { @@ -438,29 +527,44 @@ namespace Tizen.Maps } /// - /// Changes geographical coordinates to screen coordinates + /// Changes geographical coordinates to screen coordinates. /// /// Geographical coordinates - /// + /// Returns an instance of screen coordinates on the current screen + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. + /// Thrown when native operation failed to allocate memory, connect to service. public Point GeolocationToScreen(Geocoordinates coordinates) { return handle.GeolocationToScreen(coordinates.handle); } /// - /// Changes screen coordinates to geographical coordinates + /// Changes screen coordinates to geographical coordinates. /// - /// screen coordinates - /// + /// Screen coordinates + /// Returns an instance of geographical coordinates object. + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. + /// Thrown when native operation failed to allocate memory, connect to service. public Geocoordinates ScreenToGeolocation(Point screenCoordinates) { return new Geocoordinates(handle.ScreenToGeolocation(screenCoordinates)); } /// - /// Adds map object to map view + /// Adds a map object to map view. /// - /// map object to add + /// An instance of map object to be added + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. + /// Thrown when native operation failed to allocate memory, connect to service. public void Add(MapObject child) { Log.Info(string.Format("Add a object")); @@ -476,10 +580,15 @@ namespace Tizen.Maps } /// - /// Removes map object from map view + /// Removes a map object from map view. /// - /// map object to remove - /// Once removed, child object will be become invalid + /// An instance of map object to be removed + /// Once removed, the child object will be become invalid + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. + /// Thrown when native operation failed to allocate memory, connect to service. public void Remove(MapObject child) { Log.Info(string.Format("Remove a object")); @@ -494,8 +603,12 @@ namespace Tizen.Maps } /// - /// Removes all map objects from map view + /// Removes all map objects from map view. /// + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when native operation failed to allocate memory, connect to service. public void RemoveAll() { Log.Info(string.Format("Remove all of objects")); @@ -508,11 +621,16 @@ namespace Tizen.Maps } /// - /// Captures a snapshot of the Map View + /// Captures a snapshot of map view /// - /// type of file format - /// quality for encoding (1~100) - /// The file path for snapshot + /// Type of file format + /// A integer value which representing quality for encoding, from 1 to 100 + /// A string which representing The file path for snapshot + /// http://tizen.org/privilege/mapservice + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when the value is invalid. + /// Thrown when native operation failed to allocate memory, connect to service. public void CaptureSnapshot(SnapshotType type, int quality, string path) { var err = Interop.ViewSnapshot.ViewCaptureSnapshot(handle, (Interop.ViewSnapshotFormatType)type, quality, path); @@ -620,6 +738,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/Marker.cs b/src/Tizen.Maps/Tizen.Maps/Marker.cs index 10b3df4..dc48cf0 100755 --- a/src/Tizen.Maps/Tizen.Maps/Marker.cs +++ b/src/Tizen.Maps/Tizen.Maps/Marker.cs @@ -37,12 +37,12 @@ namespace Tizen.Maps } /// - /// Clicked event + /// Gets or sets clicked event handlers. /// public event EventHandler Clicked; /// - /// Marker's visibility + /// Gets or sets marker's visibility. /// public override bool IsVisible { @@ -57,7 +57,7 @@ namespace Tizen.Maps } /// - /// Geographical coordinates for marker + /// Gets or sets geographical coordinates for this marker. /// public Geocoordinates Coordinates { @@ -75,7 +75,7 @@ namespace Tizen.Maps } /// - /// Image file path for marker + /// Gets or sets a string representing image file path for this marker. /// public string ImagePath { @@ -90,7 +90,7 @@ namespace Tizen.Maps } /// - /// Screen size for marker + /// Gets or sets screen size for this marker. /// public Size MarkerSize { @@ -105,8 +105,9 @@ namespace Tizen.Maps } /// - /// Z-order for marker + /// Gets or sets z-order for this marker. /// + /// The integer value is 0 in default, and must be in range of from -100 to 100. public int ZOrder { get @@ -120,7 +121,7 @@ namespace Tizen.Maps } /// - /// Changes marker size + /// Changes marker size. /// /// New size public void Resize(Size newSize) @@ -129,7 +130,7 @@ namespace Tizen.Maps } /// - /// Changes marker coordinates + /// Changes marker coordinates. /// /// New position for marker public void Move(Geocoordinates newPosition) @@ -164,6 +165,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); @@ -182,21 +186,27 @@ namespace Tizen.Maps private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_pin_48.png"; /// - /// Creates Pin type parker + /// Creates a Pin type marker. /// /// Marker coordinates - /// Throws if input coordinates are invalid + /// Thrown when input coordinates are invalid. public Pin(Geocoordinates coordinates) : base(coordinates, defaultImagePath, Interop.ViewMarkerType.Pin) { } /// - /// Creates Pin type parker + /// Creates a Pin type marker. /// /// Marker coordinates - /// Image path - /// Throws if input coordinates or imagePath are invalid + /// Image file path for Marker + /// + /// http://tizen.org/privilege/mediastorage is needed if the file path are relevant to media storage. + /// http://tizen.org/privilege/externalstorage is needed if the file path are relevant to external storage. + /// + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when input coordinates or imagePath are invalid. public Pin(Geocoordinates coordinates, string imagePath) : base(coordinates, imagePath, Interop.ViewMarkerType.Pin) { @@ -211,21 +221,27 @@ namespace Tizen.Maps private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_sticker_48.png"; /// - /// Creates Sticker type parker + /// Creates a Sticker type marker. /// /// Marker coordinates - /// Throws if input coordinates are invalid + /// Thrown when input coordinates are invalid. public Sticker(Geocoordinates coordinates) : base(coordinates, defaultImagePath, Interop.ViewMarkerType.Sticker) { } /// - /// Creates Sticker type parker + /// Creates a Sticker type marker. /// /// Marker coordinates - /// Image path - /// Throws if input coordinates or imagePath are invalid + /// Image file path for Marker + /// + /// http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. + /// http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + /// + /// Thrown when the required feature is not supported. + /// Thrown when application does not have some privilege to access this method. + /// Thrown when input coordinates or imagePath are invalid. public Sticker(Geocoordinates coordinates, string imagePath) : base(coordinates, imagePath, Interop.ViewMarkerType.Sticker) { diff --git a/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs b/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs index b3ebbd2..ef48b26 100755 --- a/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs +++ b/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs @@ -121,7 +121,8 @@ Various Properties:
To guarantee that the Maps application runs on a device with Maps profile feature, declare the following feature requirements in the config file:
-http://tizen.org/feature/maps +http://tizen.org/feature/maps
+http://tizen.org/feature/internet diff --git a/src/Tizen.Maps/Tizen.Maps/Overlay.cs b/src/Tizen.Maps/Tizen.Maps/Overlay.cs index e17283d..b7110d3 100755 --- a/src/Tizen.Maps/Tizen.Maps/Overlay.cs +++ b/src/Tizen.Maps/Tizen.Maps/Overlay.cs @@ -27,12 +27,13 @@ namespace Tizen.Maps internal Interop.OverlayHandle handle; /// - /// Creates normal overlay map object + /// Creates a normal overlay map object. /// /// /// - /// Throws if input coordinates or objectToContain are invalid - public Overlay(Geocoordinates coordinates, EvasObject objectToContain) : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal) + /// Thrown when input coordinates or objectToContain are invalid + public Overlay(Geocoordinates coordinates, EvasObject objectToContain) + : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal) { } @@ -46,6 +47,9 @@ namespace Tizen.Maps handle = new Interop.OverlayHandle(coordinates.handle, objectToContain, type); } + /// + /// Gets or sets visibility of overlay map object. + /// public override bool IsVisible { get { return handle.IsVisible; } @@ -53,7 +57,7 @@ namespace Tizen.Maps } /// - /// Geographical coordinates for overlay + /// Gets or sets geographical coordinates for overlay map object. /// public Geocoordinates Coordinates { @@ -70,7 +74,7 @@ namespace Tizen.Maps } /// - /// Minimum zoom level for overlay + /// Gets or sets minimum zoom level for overlay map object. /// public int MinimumZoomLevel { @@ -85,7 +89,7 @@ namespace Tizen.Maps } /// - /// Maximum zoom lever for overlay + /// Gets or sets maximum zoom lever for overlay map object. /// public int MaximumZoomLevel { @@ -127,6 +131,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); @@ -141,10 +148,14 @@ namespace Tizen.Maps public class BubbleOverlay : Overlay { /// - /// Creates Box overlay + /// Creates a Bubble overlay. /// - /// Throws if input coordinates or objectToContain are invalid - public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain) : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble) + /// The geographical coordinates to be pointed + /// The EvasObject to be shown + /// Thrown when the required feature is not supported. + /// Thrown when input coordinates or objectToContain are invalid + public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain) + : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble) { } } @@ -155,10 +166,14 @@ namespace Tizen.Maps public class BoxOverlay : Overlay { /// - /// Creates Box overlay + /// Creates a Box overlay. /// - /// Throws if input coordinates or objectToContain are invalid - public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain) : base(coordinates, objectToContain, Interop.ViewOverlayType.Box) + /// The geographical coordinates to be pointed + /// The EvasObject to be shown + /// Thrown when the required feature is not supported. + /// Thrown when input coordinates or objectToContain are invalid + public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain) + : base(coordinates, objectToContain, Interop.ViewOverlayType.Box) { } } diff --git a/src/Tizen.Maps/Tizen.Maps/Place.cs b/src/Tizen.Maps/Tizen.Maps/Place.cs index c9027c8..ca527ea 100755 --- a/src/Tizen.Maps/Tizen.Maps/Place.cs +++ b/src/Tizen.Maps/Tizen.Maps/Place.cs @@ -32,7 +32,7 @@ namespace Tizen.Maps } /// - /// Place ID + /// Gets ID string for the place. /// public string Id { @@ -43,7 +43,7 @@ namespace Tizen.Maps } /// - /// Place Name + /// Gets name string for the place. /// public string Name { @@ -54,7 +54,7 @@ namespace Tizen.Maps } /// - /// Place URI + /// Gets view URI for the place. /// public string Uri { @@ -65,7 +65,7 @@ namespace Tizen.Maps } /// - /// Distance from the center of the search area + /// Gets distance for the place from the center. /// public int Distance { @@ -76,7 +76,7 @@ namespace Tizen.Maps } /// - /// Place location + /// Gets geographical location for the place. /// public Geocoordinates Coordinates { @@ -87,7 +87,7 @@ namespace Tizen.Maps } /// - /// Place address + /// Gets address for the place. /// public PlaceAddress Address { @@ -98,7 +98,7 @@ namespace Tizen.Maps } /// - /// Rating for the place + /// Gets rating for the place. /// public PlaceRating Rating { @@ -109,7 +109,7 @@ namespace Tizen.Maps } /// - /// Place image supplier link + /// Gets supplier link for the place. /// public PlaceLink Supplier { @@ -120,7 +120,7 @@ namespace Tizen.Maps } /// - /// Place image related link + /// Gets related link for the place. /// public PlaceLink Related { @@ -131,7 +131,7 @@ namespace Tizen.Maps } /// - /// All properties attached with this place + /// Gets all properties attached to this place. /// public IDictionary Properties { @@ -144,7 +144,7 @@ namespace Tizen.Maps } /// - /// All categories attached with this place + /// Gets all categories attached to this place. /// public IEnumerable Categories { @@ -157,7 +157,7 @@ namespace Tizen.Maps } /// - /// All attributes attached with this place + /// Gets all attributes attached to this place. /// public IEnumerable Attributes { @@ -170,7 +170,7 @@ namespace Tizen.Maps } /// - /// All contacts attached with this place + /// Gets all contacts attached to this place. /// public IEnumerable Contacts { @@ -183,7 +183,7 @@ namespace Tizen.Maps } /// - /// All editorials attached with this place + /// Gets all editorials attached to this place. /// public IEnumerable Editorials { @@ -196,7 +196,7 @@ namespace Tizen.Maps } /// - /// All images attached with this place + /// Gets all images attached to this place. /// public IEnumerable Images { @@ -209,7 +209,7 @@ namespace Tizen.Maps } /// - /// All reviews attached with this place + /// Gets all reviews attached to this place. /// public IEnumerable Reviews { @@ -233,6 +233,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs b/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs index e839e5f..e9eba1d 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs @@ -26,9 +26,9 @@ namespace Tizen.Maps internal Interop.AddressHandle handle; /// - /// Construct map address object + /// Constructs map address object. /// - /// Throws if native operation failed to allocate memory + /// Thrown when native operation failed to allocate memory. public PlaceAddress() { handle = new Interop.AddressHandle(); @@ -40,7 +40,7 @@ namespace Tizen.Maps } /// - /// Building number for this address + /// Gets a building number for this address. /// public string Building { @@ -55,7 +55,7 @@ namespace Tizen.Maps } /// - /// City name for this address + /// Gets a city name for this address. /// public string City { @@ -70,7 +70,7 @@ namespace Tizen.Maps } /// - /// Country name for this address + /// Gets a country name for this address. /// public string Country { @@ -85,7 +85,7 @@ namespace Tizen.Maps } /// - /// Country code for this address + /// Gets a country code for this address. /// public string CountryCode { @@ -100,7 +100,7 @@ namespace Tizen.Maps } /// - /// County for this address + /// Gets a county name for this address. /// public string County { @@ -115,7 +115,7 @@ namespace Tizen.Maps } /// - /// District name for this address + /// Gets a district name for this address. /// public string District { @@ -130,7 +130,7 @@ namespace Tizen.Maps } /// - /// Free text associated with this address + /// Gets a free text associated with this address. /// public string Freetext { @@ -145,7 +145,7 @@ namespace Tizen.Maps } /// - /// Postal code for this address + /// Gets a postal code for this address. /// public string PostalCode { @@ -160,7 +160,7 @@ namespace Tizen.Maps } /// - /// State name for this address + /// Gets a state name for this address. /// public string State { @@ -175,7 +175,7 @@ namespace Tizen.Maps } /// - /// Street name for this address + /// Gets a street name for this address. /// public string Street { @@ -190,7 +190,7 @@ namespace Tizen.Maps } /// - /// String that represents this address + /// Returns a string that represents this object. /// public override string ToString() { @@ -209,6 +209,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceAddressList.cs b/src/Tizen.Maps/Tizen.Maps/PlaceAddressList.cs index e78dd6b..fc3c184 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceAddressList.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceAddressList.cs @@ -28,9 +28,10 @@ namespace Tizen.Maps private List _list; /// - /// Construct map address list object + /// Constructs a map address list object. /// - /// Throws if native operation failed to allocate memory + /// Thrown when the required feature is not supported. + /// Thrown when native operation failed to allocate memory. public PlaceAddressList() { handle = new Interop.AddressListHandle(); @@ -42,7 +43,7 @@ namespace Tizen.Maps } /// - /// Iterator for addresses in this list + /// Gets an iterator for addresses in this list. /// public IEnumerable Addresses { @@ -69,6 +70,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceAttribute.cs b/src/Tizen.Maps/Tizen.Maps/PlaceAttribute.cs index b63a840..0e5d65f 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceAttribute.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceAttribute.cs @@ -34,27 +34,28 @@ namespace Tizen.Maps _text = nativeHandle.Text; } - internal PlaceAttribute(IntPtr nativeHandle, bool needToRelease) : this(new Interop.PlaceAttributeHandle(nativeHandle, needToRelease)) + internal PlaceAttribute(IntPtr nativeHandle, bool needToRelease) + : this(new Interop.PlaceAttributeHandle(nativeHandle, needToRelease)) { } /// - /// Place Attribute ID + /// Gets an ID for the place attribute. /// public string Id { get { return _id; } } /// - /// Place attribute label + /// Gets a label for the place attribute. /// public string Label { get { return _label; } } /// - /// Place attribute text + /// Gets a text for the place attribute. /// public string Text { get { return _text; } } /// - /// String that represents this attribute + /// Returns a string that represents this object. /// public override string ToString() { diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs b/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs index d4ad62a..acbb1f0 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs @@ -26,9 +26,9 @@ namespace Tizen.Maps internal Interop.PlaceCategoryHandle handle; /// - /// Constructs search category object + /// Constructs search category object. /// - /// Throws if native operation failed to allocate memory + /// Thrown when native operation failed to allocate memory. public PlaceCategory() { handle = new Interop.PlaceCategoryHandle(); @@ -41,7 +41,7 @@ namespace Tizen.Maps /// - /// ID for this category + /// Gets or sets an ID for this category. /// public string Id { @@ -50,7 +50,7 @@ namespace Tizen.Maps } /// - /// Name for this category + /// Gets or sets a name for this category. /// public string Name { @@ -59,7 +59,7 @@ namespace Tizen.Maps } /// - /// URL for this category + /// Gets or sets an URL for this category. /// public string Url { @@ -68,7 +68,7 @@ namespace Tizen.Maps } /// - /// String that represents this category + /// Returns a string that represents this object. /// public override string ToString() { @@ -87,6 +87,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceContact.cs b/src/Tizen.Maps/Tizen.Maps/PlaceContact.cs index b94157c..e06ed72 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceContact.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceContact.cs @@ -40,22 +40,22 @@ namespace Tizen.Maps } /// - /// Place contact type + /// Gets an ID for this place contact. /// public string Id { get { return _type; } } /// - /// Place contact label + /// Gets a label for this place contact. /// public string Label { get { return _label; } } /// - /// Place contact value + /// Gets a value for this place contact. /// public string Value { get { return _value; } } /// - /// String that represents this place contact + /// Returns a string that represents this object. /// public override string ToString() { diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceEditorial.cs b/src/Tizen.Maps/Tizen.Maps/PlaceEditorial.cs index 5b304f6..4a702a3 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceEditorial.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceEditorial.cs @@ -39,22 +39,22 @@ namespace Tizen.Maps } /// - /// Place editorial description + /// Gets a description for this place editorial. /// public string Description { get { return _description; } } /// - /// Place editorial language + /// Gets a language for this place editorial. /// public string Language { get { return _language; } } /// - /// Place editorial value + /// Gets an instance of object which representing media for this place editorial. /// public PlaceMedia Media { get { return _media; } } /// - /// String that represents this place media + /// Returns a string that represents this object. /// public override string ToString() { diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs b/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs index e097baa..42d251b 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs @@ -26,17 +26,20 @@ namespace Tizen.Maps internal Interop.PlaceFilterHandle handle; /// - /// Constructs new place filter + /// Constructs new place filter. /// - /// Throws if native operation failed to allocate memory + /// Thrown when native operation failed to allocate memory. public PlaceFilter() { handle = new Interop.PlaceFilterHandle(); } /// - /// Filter string for place addresses + /// Gets or sets an free-formed address string for this place filter. /// + /// Depending on maps provider which the application has selected, + /// it may treat , and + /// as same kind of strings to search places. public string Address { get @@ -50,7 +53,7 @@ namespace Tizen.Maps } /// - /// Category filter for places + /// Gets or sets an instance of object for this place filter. /// public PlaceCategory Category { @@ -65,8 +68,11 @@ namespace Tizen.Maps } /// - /// Filter keyword for place + /// Gets or sets a keyword for this place filter. /// + /// Depending on maps provider which the application has selected, + /// it may treat , and + /// as same kind of strings to search places. public string Keyword { get @@ -80,8 +86,11 @@ namespace Tizen.Maps } /// - /// Filter string for place names + /// Gets or sets a name for this place filter. /// + /// Depending on maps provider which the application has selected, + /// it may treat , and + /// as same kind of strings to search places. public string Name { get @@ -106,6 +115,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceImage.cs b/src/Tizen.Maps/Tizen.Maps/PlaceImage.cs index 0f269e3..f08d868 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceImage.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceImage.cs @@ -41,32 +41,32 @@ namespace Tizen.Maps } /// - /// Place image Id + /// Gets an ID for this place image. /// public string Id { get { return _id; } } /// - /// Place image URL + /// Gets an URL for this place image. /// public string Url { get { return _url; } } /// - /// Place image width + /// Gets width for this place image. /// public int Width { get { return _width; } } /// - /// Place image height + /// Gets height for this place image. /// public int Height { get { return _height; } } /// - /// Place image user link + /// Gets an object which representing user link for this place image. /// public PlaceLink UserLink { get { return _userLink; } } /// - /// Place image media + /// Gets an object which representing image media for this place image. /// public PlaceMedia ImageMedia { get { return _media; } } } diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceLink.cs b/src/Tizen.Maps/Tizen.Maps/PlaceLink.cs index 4ad28f8..d5f0526 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceLink.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceLink.cs @@ -38,22 +38,22 @@ namespace Tizen.Maps } /// - /// Place link ID + /// Gets a string which representing ID for this place link. /// public string Id { get { return _id; } } /// - /// Place link name + /// Gets a string which representing name for this place link. /// public string Name { get { return _name; } } /// - /// Place link string + /// Gets a string which representing link for this place link. /// public string Link { get { return _link; } } /// - /// Place link type + /// Gets a string which representing type for this place link. /// public string Type { get { return _type; } } } diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceList.cs b/src/Tizen.Maps/Tizen.Maps/PlaceList.cs index 4c33d9e..56e67f4 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceList.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceList.cs @@ -33,7 +33,7 @@ namespace Tizen.Maps } /// - /// Iterator for addresses in this list + /// Gets an iterator for addresses in this list. /// public IEnumerable Places { @@ -60,6 +60,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceMedia.cs b/src/Tizen.Maps/Tizen.Maps/PlaceMedia.cs index 0df0a3b..f6ac148 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceMedia.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceMedia.cs @@ -35,17 +35,17 @@ namespace Tizen.Maps } /// - /// Place media attribution + /// Gets a string which representing attribution for this place media. /// public string Attribution { get { return _attribution; } } /// - /// Place media supplier value + /// Gets an instance of object which representing supplier for this place media. /// public PlaceLink Supplier { get { return _supplier; } } /// - /// Place media via value + /// Gets an instance of object which representing via data for this place media. /// public PlaceLink Via { get { return _via; } } } diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceRating.cs b/src/Tizen.Maps/Tizen.Maps/PlaceRating.cs index b29d177..617fcb5 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceRating.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceRating.cs @@ -33,17 +33,17 @@ namespace Tizen.Maps } /// - /// Number of users rated for this rating + /// Gets the number of users rated for this place rating. /// public int UserCount { get { return _count; } } /// - /// Average value of user rating + /// Gets average value of this place rating. /// public double Average { get { return _average; } } /// - /// String that represents this place rating + /// Returns a string that represents this object. /// public override string ToString() { diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceReview.cs b/src/Tizen.Maps/Tizen.Maps/PlaceReview.cs index 286b658..f29f268 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceReview.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceReview.cs @@ -48,37 +48,37 @@ namespace Tizen.Maps } /// - /// Time of this review + /// Gets an instance of object which representing time of this review. /// public DateTime Date { get { return _date; } } /// - /// Title of this review + /// Gets a string which representing title of this review. /// public string Title { get { return _title; } } /// - /// Rating of this review + /// Gets a value which representing rating of this review. /// public double Rating { get { return _rating; } } /// - /// Description of this review + /// Gets a string which representing description of this review. /// public string Description { get { return _description; } } /// - /// Language of this review + /// Gets a string which representing language of this review. /// public string Language { get { return _language; } } /// - /// Media attached with this review + /// Gets an instance of object which representing review media of this review. /// public PlaceMedia ReviewMedia { get { return _media; } } /// - /// User link of this review + /// Gets an instance of object which representing user link of this review. /// public PlaceLink UserLink { get { return _userLink; } } } diff --git a/src/Tizen.Maps/Tizen.Maps/Polygon.cs b/src/Tizen.Maps/Tizen.Maps/Polygon.cs index f38c6c8..ea6578c 100755 --- a/src/Tizen.Maps/Tizen.Maps/Polygon.cs +++ b/src/Tizen.Maps/Tizen.Maps/Polygon.cs @@ -31,11 +31,11 @@ namespace Tizen.Maps private List _coordinateList; /// - /// Creates a polygon visual object + /// Creates a polygon visual object. /// - /// list of geographical coordinates - /// background color - /// Throws if input values are invalid + /// List of geographical coordinates + /// Background color + /// Thrown when input values are invalid. public Polygon(IEnumerable coordinates, Color color) : base() { var err = Interop.ErrorCode.InvalidParameter; @@ -49,10 +49,13 @@ namespace Tizen.Maps } /// - /// Clicked event + /// Adds or removes clicked event handlers. /// public event EventHandler Clicked; + /// + /// Gets or sets visibility for the polygon. + /// public override bool IsVisible { get { return handle.IsVisible; } @@ -60,7 +63,7 @@ namespace Tizen.Maps } /// - /// List of geographical coordinates of polygon vertices + /// Gets or sets a list of geographical coordinates of polygon vertices. /// public IEnumerable Coordinates { @@ -86,7 +89,7 @@ namespace Tizen.Maps } /// - /// Background fill color + /// Gets or sets background color to fill the polygon. /// public Color FillColor { @@ -131,6 +134,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/Polyline.cs b/src/Tizen.Maps/Tizen.Maps/Polyline.cs index 7ccbef9..b1522b0 100755 --- a/src/Tizen.Maps/Tizen.Maps/Polyline.cs +++ b/src/Tizen.Maps/Tizen.Maps/Polyline.cs @@ -31,12 +31,12 @@ namespace Tizen.Maps private List _coordinateList; /// - /// Creates polyline visual object + /// Creates polyline visual object. /// /// List of geographical coordinates /// Line color /// The width of line [1 ~ 100] (pixels) - /// Throws if input values are invalid + /// Thrown when input values are invalid public Polyline(List coordinates, Color color, int width) : base() { var err = Interop.ErrorCode.InvalidParameter; @@ -50,7 +50,7 @@ namespace Tizen.Maps } /// - /// Clicked event + /// Adds or removes clicked event handlers. /// public event EventHandler Clicked; @@ -61,7 +61,7 @@ namespace Tizen.Maps } /// - /// List of geographical coordinates for polyline vertices + /// Gets or sets a list of geographical coordinates for polyline vertices. /// public IEnumerable Coordinates { @@ -87,7 +87,7 @@ namespace Tizen.Maps } /// - /// Line color + /// Gets or sets line color. /// public Color LineColor { @@ -102,7 +102,7 @@ namespace Tizen.Maps } /// - /// line width [1 ~ 100 pixels] + /// Gets or sets line width from 1 to 100 pixels. /// public int Width { @@ -147,6 +147,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/ReverseGeocodeRequest.cs b/src/Tizen.Maps/Tizen.Maps/ReverseGeocodeRequest.cs index 00c9612..3021cce 100755 --- a/src/Tizen.Maps/Tizen.Maps/ReverseGeocodeRequest.cs +++ b/src/Tizen.Maps/Tizen.Maps/ReverseGeocodeRequest.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Maps { /// - /// Reverse geocode request for Tizen map service + /// Reverse geocode request for map service. /// public class ReverseGeocodeRequest : MapServiceRequest { diff --git a/src/Tizen.Maps/Tizen.Maps/Route.cs b/src/Tizen.Maps/Tizen.Maps/Route.cs index 20ffe83..8efe390 100755 --- a/src/Tizen.Maps/Tizen.Maps/Route.cs +++ b/src/Tizen.Maps/Tizen.Maps/Route.cs @@ -21,7 +21,7 @@ using System.Collections.Generic; namespace Tizen.Maps { /// - /// Route information, used in Route Search requests + /// Route information, used in Route Search requests. /// public class Route : IDisposable { @@ -33,7 +33,7 @@ namespace Tizen.Maps } /// - /// Destination coordinates for this route + /// Gets an instance of object which representing destination coordinates for this route. /// public Geocoordinates Destination { @@ -44,7 +44,7 @@ namespace Tizen.Maps } /// - /// Total distance for this route + /// Gets total distance for this route. /// public double Distance { @@ -55,7 +55,7 @@ namespace Tizen.Maps } /// - /// Total duration to cover this route + /// Get total duration to cover this route. /// public double Duration { @@ -66,7 +66,7 @@ namespace Tizen.Maps } /// - /// Id for this route + /// Gets an ID for this route. /// public string Id { @@ -77,7 +77,7 @@ namespace Tizen.Maps } /// - /// Transport Mode for this route + /// Gets transport mode for this route. /// public TransportMode Mode { @@ -88,7 +88,7 @@ namespace Tizen.Maps } /// - /// Origin coordinates for this route + /// Gets origin coordinates for this route. /// public Geocoordinates Origin { @@ -99,7 +99,7 @@ namespace Tizen.Maps } /// - /// Coordinates list for this route + /// Gets a coordinates list for this route. /// public IEnumerable Path { @@ -112,7 +112,7 @@ namespace Tizen.Maps } /// - /// Segment list for this route + /// Gets a segment list for this route. /// public IEnumerable Segments { @@ -125,7 +125,7 @@ namespace Tizen.Maps } /// - /// Distance unit for this route + /// Gets distance unit for this route. /// public DistanceUnit Unit { @@ -136,7 +136,7 @@ namespace Tizen.Maps } /// - /// Bounding area for this route + /// Gets an instance of object which representing bounding area for this route. /// private Area BoundingBox { @@ -158,6 +158,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/RouteFeature.cs b/src/Tizen.Maps/Tizen.Maps/RouteFeature.cs index cb50d46..dd070bc 100755 --- a/src/Tizen.Maps/Tizen.Maps/RouteFeature.cs +++ b/src/Tizen.Maps/Tizen.Maps/RouteFeature.cs @@ -22,47 +22,47 @@ namespace Tizen.Maps public enum RouteFeature { /// - /// Indicates no route features (are selected) + /// Indicates no route features (are selected). /// None = Interop.RouteRequestFeature.None, /// - /// Indicates toll roads (toll gates/booths) + /// Indicates toll roads (toll gates/booths). /// Toll = Interop.RouteRequestFeature.Toll, /// - /// Indicates motorway + /// Indicates motorway. /// Motorway = Interop.RouteRequestFeature.MotorWay, /// - /// Indicates a boat ferry + /// Indicates a boat ferry. /// BoatFerry = Interop.RouteRequestFeature.BoatFerry, /// - /// Indicates rail (train) ferry + /// Indicates rail (train) ferry. /// RailFerry = Interop.RouteRequestFeature.RailFerry, /// - /// Indicates public transport + /// Indicates public transport. /// PublicTransit = Interop.RouteRequestFeature.PublicTransit, /// - /// Indicates tunnel + /// Indicates tunnel. /// Tunnel = Interop.RouteRequestFeature.Tunnel, /// - /// Indicates dirt road + /// Indicates dirt road. /// DirtRoad = Interop.RouteRequestFeature.DirtRoad, /// - /// Indicates park + /// Indicates park. /// Parks = Interop.RouteRequestFeature.Parks, /// - /// Indicates a high-occupancy vehicle lane + /// Indicates a high-occupancy vehicle lane. /// Hovlane = Interop.RouteRequestFeature.Hovlane, /// - /// Indicates stairs + /// Indicates stairs. /// Stairs = Interop.RouteRequestFeature.Stairs, } diff --git a/src/Tizen.Maps/Tizen.Maps/RouteFeatureWeight.cs b/src/Tizen.Maps/Tizen.Maps/RouteFeatureWeight.cs index f93faba..a788ed9 100755 --- a/src/Tizen.Maps/Tizen.Maps/RouteFeatureWeight.cs +++ b/src/Tizen.Maps/Tizen.Maps/RouteFeatureWeight.cs @@ -22,23 +22,23 @@ namespace Tizen.Maps public enum RouteFeatureWeight { /// - /// Indicates normal weighting + /// Indicates normal weighting. /// Normal = Interop.RouteFeatureWeight.Normal, /// - /// Indicates that a feature is preferred + /// Indicates that a feature is preferred. /// Prefer = Interop.RouteFeatureWeight.Prefer, /// - /// Indicates that a feature is to be avoided + /// Indicates that a feature is to be avoided. /// Avoid = Interop.RouteFeatureWeight.Avoid, /// - /// Indicates that soft-exclude applies to the feature + /// Indicates that soft-exclude applies to the feature. /// SoftExclude = Interop.RouteFeatureWeight.SoftExclude, /// - /// Indicates that the feature is to be strictly excluded + /// Indicates that the feature is to be strictly excluded. /// StrictExclude = Interop.RouteFeatureWeight.StrictExclude, } diff --git a/src/Tizen.Maps/Tizen.Maps/RouteManeuver.cs b/src/Tizen.Maps/Tizen.Maps/RouteManeuver.cs index 147738e..0fbb8e4 100755 --- a/src/Tizen.Maps/Tizen.Maps/RouteManeuver.cs +++ b/src/Tizen.Maps/Tizen.Maps/RouteManeuver.cs @@ -45,42 +45,42 @@ namespace Tizen.Maps } /// - /// Direction type for this maneuver + /// Gets direction type for this maneuver. /// public DirectionType Direction { get { return (DirectionType)_direction; } } /// - /// Turn type for this maneuver + /// Gets turn type for this maneuver. /// public TurnInstruction Turn { get { return (TurnInstruction)_turntype; } } /// - /// Position for this maneuver + /// Gets a geographical coordinates position for this maneuver. /// public Geocoordinates Position { get { return _coordinates; } } /// - /// Name of the road for this maneuver + /// Gets a name of the road for this maneuver. /// public string Road { get { return _road; } } /// - /// Instruction text for this maneuver + /// Gets an instruction text for this maneuver. /// public string Instruction { get { return _instruction; } } /// - /// Locale for this maneuver + /// Gets a locale for this maneuver. /// public string Locale { get { return _locale; } } /// - /// Time to next instruction for this maneuver + /// Gets time to next instruction for this maneuver. /// public int TimeToNextInstruction { get { return _timeToNextInstruction; } } /// - /// Distance to next instruction for this maneuver + /// Gets distance to next instruction for this maneuver. /// public double DistanceToNextInstruction { get { return _distanceToNextInstruction; } } } diff --git a/src/Tizen.Maps/Tizen.Maps/RouteOptimization.cs b/src/Tizen.Maps/Tizen.Maps/RouteOptimization.cs index bde76fd..da47189 100755 --- a/src/Tizen.Maps/Tizen.Maps/RouteOptimization.cs +++ b/src/Tizen.Maps/Tizen.Maps/RouteOptimization.cs @@ -19,30 +19,33 @@ namespace Tizen.Maps /// /// Allowed route optimization option used in route search requests /// + /// + /// Depending on loaded maps plug-in using , some features may have no effect or differences with descriptions. + /// public enum RouteOptimization { /// - /// Search for fastest routes + /// Indicates that searching for fastest routes. /// Fastest = Interop.RouteOptimization.Fastest, /// - /// Search for shortest routes (car mode only) + /// Indicates that searching for shortest routes (car mode only). /// Shortest = Interop.RouteOptimization.Shortest, /// - /// Search for most economic routes (car mode only) + /// Indicates that searching for most economic routes (car mode only). /// Economic = Interop.RouteOptimization.Economic, /// - /// Search for most scenic routes + /// Indicates that searching for most scenic routes. /// Scenic = Interop.RouteOptimization.Scenic, /// - /// Search for most fastest routes now, based on current traffic condition + /// Indicates that searching for most fastest routes now, based on current traffic condition. /// FastestNow = Interop.RouteOptimization.FastestNow, /// - /// Search for direct drive routes + /// Indicates that searching for direct drive routes. /// DirectDrive = Interop.RouteOptimization.DirectDrive, } diff --git a/src/Tizen.Maps/Tizen.Maps/RouteSearchRequest.cs b/src/Tizen.Maps/Tizen.Maps/RouteSearchRequest.cs index d3bd456..1d97a11 100755 --- a/src/Tizen.Maps/Tizen.Maps/RouteSearchRequest.cs +++ b/src/Tizen.Maps/Tizen.Maps/RouteSearchRequest.cs @@ -92,7 +92,7 @@ namespace Tizen.Maps } /// - /// List of way-points to cover between origin and destination + /// Gets or sets a list of way-points to cover between origin and destination. /// public IEnumerable Waypoints { diff --git a/src/Tizen.Maps/Tizen.Maps/RouteSegment.cs b/src/Tizen.Maps/Tizen.Maps/RouteSegment.cs index 2072b55..3e7a982 100755 --- a/src/Tizen.Maps/Tizen.Maps/RouteSegment.cs +++ b/src/Tizen.Maps/Tizen.Maps/RouteSegment.cs @@ -47,38 +47,35 @@ namespace Tizen.Maps } /// - /// Origin coordinates for this segment + /// Gets an origin coordinates for this segment. /// public Geocoordinates Origin { get { return _origin; } } /// - /// Destination coordinates for this segment + /// Gets a destination coordinates for this segment. /// public Geocoordinates Destination { get { return _destination; } } /// - /// Total distance for this segment + /// Gets total distance for this segment. /// public double Distance { get { return _distance; } } /// - /// Total duration to cover this segment + /// Gets total duration to cover this segment. /// public double Duration { get { return _duration; } } /// - /// Maneuver list for this segment path + /// Gets a maneuver list for this segment. /// public IEnumerable Maneuvers { get { return _maneuvers; } } /// - /// Coordinates list for this segment path + /// Gets a coordinates list for this segment. /// public IEnumerable Path { get { return _path; } } - /// - /// Bounding area for this segment - /// private Area BoundingBox { get { return _boundingBox; } } } } diff --git a/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs b/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs index b27ef18..731358f 100755 --- a/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs +++ b/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs @@ -28,7 +28,7 @@ namespace Tizen.Maps private IReadOnlyDictionary _properties = new Dictionary(); /// - /// Constructor for search preference + /// Constructors a new search preference. /// public SearchPreference() { @@ -36,7 +36,7 @@ namespace Tizen.Maps } /// - /// Constructor for search preference + /// Constructors a new search preference. /// internal SearchPreference(Interop.PreferenceHandle nativeHandle) { @@ -44,11 +44,10 @@ namespace Tizen.Maps } /// - /// Preferred language + /// Gets or sets preferred language. /// - /// - /// Language should be specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code e.g. "ko-KR" - /// + /// Language should be specified as an ISO 3166 alpha-2 two letter country-code + /// followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". public string Language { get @@ -63,7 +62,7 @@ namespace Tizen.Maps } /// - /// Maximum result count for a service request + /// Gets or sets the maximum result count for each service request. /// /// Setting negative value will not have any effect on MaxResults value public int MaxResults @@ -80,7 +79,7 @@ namespace Tizen.Maps } /// - /// Distance unit + /// Gets or sets distance unit. /// public DistanceUnit Unit { @@ -96,7 +95,7 @@ namespace Tizen.Maps } /// - /// Preferred country + /// Gets or sets preferred country. /// public string CountryCode { @@ -112,7 +111,7 @@ namespace Tizen.Maps } /// - /// Search properties as key value pair + /// Gets or sets search properties as key value pair. /// public IReadOnlyDictionary Properties { @@ -128,7 +127,7 @@ namespace Tizen.Maps } /// - /// Selected route optimization + /// Gets or sets route optimization. /// public RouteOptimization Optimization { @@ -144,7 +143,7 @@ namespace Tizen.Maps } /// - /// Route transport mode + /// Gets or sets route transport mode. /// public TransportMode Mode { @@ -160,7 +159,7 @@ namespace Tizen.Maps } /// - /// Route feature weight + /// Gets or sets route feature weight. /// public RouteFeatureWeight RouteFeatureWeight { @@ -176,7 +175,7 @@ namespace Tizen.Maps } /// - /// Route feature + /// Gets or sets route feature. /// public RouteFeature RouteFeature { @@ -192,7 +191,7 @@ namespace Tizen.Maps } /// - /// Indicate if search for alternative routes is enabled. + /// Gets or sets if searching for alternative routes is enabled. /// public bool SearchAlternativeRoutes { @@ -219,6 +218,9 @@ namespace Tizen.Maps } } + /// + /// Releases all resources used by this object. + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Maps/Tizen.Maps/ServiceData.cs b/src/Tizen.Maps/Tizen.Maps/ServiceData.cs index 6df7db5..43011d0 100755 --- a/src/Tizen.Maps/Tizen.Maps/ServiceData.cs +++ b/src/Tizen.Maps/Tizen.Maps/ServiceData.cs @@ -22,73 +22,73 @@ namespace Tizen.Maps public enum ServiceData { /// - /// Indicates availability of address value in the Place data + /// Indicates availability of address value in the Place data. /// PlaceAddress = Interop.ServiceData.PlaceAddress, /// - /// Indicates availability of rating value in the Place data + /// Indicates availability of rating value in the Place data. /// PlaceRating = Interop.ServiceData.PlaceRating, /// - /// Indicates availability of place category list in the Place data + /// Indicates availability of place category list in the Place data. /// PlaceCategories = Interop.ServiceData.PlaceCategories, /// - /// Indicates availability of place attribute list in the Place data + /// Indicates availability of place attribute list in the Place data. /// PlaceAttributes = Interop.ServiceData.PlaceAttributes, /// - /// Indicates availability of place contact list in the Place data + /// Indicates availability of place contact list in the Place data. /// PlaceContacts = Interop.ServiceData.PlaceContacts, /// - /// Indicates availability of place editorial list in the Place data + /// Indicates availability of place editorial list in the Place data. /// PlaceEditorials = Interop.ServiceData.PlaceEditorials, /// - /// Indicates availability of place review list in the Place data + /// Indicates availability of place review list in the Place data. /// PlaceReviews = Interop.ServiceData.PlaceReviews, /// - /// Indicates availability of place image in Place the data + /// Indicates availability of place image in Place the data. /// PlaceImage = Interop.ServiceData.PlaceImage, /// - /// Indicates availability of place supplier link value in the Place data + /// Indicates availability of place supplier link value in the Place data. /// PlaceSupplier = Interop.ServiceData.PlaceSupplier, /// - /// Indicates availability of related place link in the Place data + /// Indicates availability of related place link in the Place data. /// PlaceRelated = Interop.ServiceData.PlaceRelated, /// - /// Indicates that the Route Data Structure is defined as a Path (a list of geographical coordinates) + /// Indicates that the Route Data Structure is defined as a Path (a list of geographical coordinates). /// RoutePath = Interop.ServiceData.RoutePath, /// - /// Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a Path + /// Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a Path. /// RouteSegmentsPath = Interop.ServiceData.RouteSegmentsPath, /// - /// Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a list of Maneuvers + /// Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a list of Maneuvers. /// RouteSegmentsManeuvers = Interop.ServiceData.RouteSegmentsManeuvers, /// - /// Indicates availability of traffic information on the Map + /// Indicates availability of traffic information on the Map. /// ViewTraffic = Interop.ServiceData.ViewTraffic, /// - /// Indicates availability of public transit information on the Map + /// Indicates availability of public transit information on the Map. /// ViewPublicTransit = Interop.ServiceData.ViewPublicTransit, /// - /// Indicates availability of 3D building drawable on the Map + /// Indicates availability of 3D building drawable on the Map. /// ViewBuilding = Interop.ServiceData.ViewBuilding, /// - /// Indicates availability of scale bar on the Map + /// Indicates availability of scale bar on the Map. /// ViewScalebar = Interop.ServiceData.ViewScalebar, } diff --git a/src/Tizen.Maps/Tizen.Maps/ServiceRequestType.cs b/src/Tizen.Maps/Tizen.Maps/ServiceRequestType.cs index 7a67fb9..1397980 100755 --- a/src/Tizen.Maps/Tizen.Maps/ServiceRequestType.cs +++ b/src/Tizen.Maps/Tizen.Maps/ServiceRequestType.cs @@ -22,62 +22,62 @@ namespace Tizen.Maps public enum ServiceRequestType { /// - /// Service request to get position for a given free-formed address string is allowed + /// Indicates that service request to get position for a given free-formed address string is allowed. /// Geocode = Interop.ServiceType.Geocode, /// - /// Service request to get position for a given address, within the specified bounding , is allowed + /// Indicates that service request to get position for a given address, within the specified bounding , is allowed. /// GeocodeInsideArea = Interop.ServiceType.GeocodeInsideArea, /// - /// Service request to get position for a given is allowed + /// Indicates that service request to get position for a given is allowed. /// GeocodeByStructuredAddress = Interop.ServiceType.GeocodeByStructuredAddress, /// - /// Service request to get for a given is allowed + /// Indicates that service request to get for a given is allowed. /// ReverseGeocode = Interop.ServiceType.ReverseGeocode, /// - /// Service request to get for a given is allowed + /// Indicates that service request to get for a given is allowed. /// MultiReverseGeocode = Interop.ServiceType.MultiReverseGeocode, /// - /// Service request to query information for a given is allowed + /// Indicates that service request to query information for a given is allowed. /// SearchPlace = Interop.ServiceType.SearchPlace, /// - /// Service request to query information for a given is allowed + /// Indicates that service request to query information for a given is allowed. /// SearchPlaceByArea = Interop.ServiceType.SearchPlaceByArea, /// - /// Service request to query information for a given free-formed address string is allowed + /// Indicates that service request to query information for a given free-formed address string is allowed. /// SearchPlaceByAddress = Interop.ServiceType.SearchPlaceByAddress, /// - /// Service request to query information list for all places in a given is allowed + /// Indicates that service request to query information list for all places in a given is allowed. /// SearchPlaceList = Interop.ServiceType.SearchPlaceList, /// - /// Service request to get detailed information for a given is allowed + /// Indicates that service request to get detailed information for a given is allowed. /// SearchGetPlaceDetails = Interop.ServiceType.SearchGetPlaceDetails, /// - /// Service request to query information from a given origin and destination is allowed + /// Indicates that service request to query information from a given origin and destination is allowed. /// SearchRoute = Interop.ServiceType.SearchRoute, /// - /// Service request to query information passing through specified way-points is allowed + /// Indicates that service request to query information passing through specified way-points is allowed. /// SearchRouteWithWaypoints = Interop.ServiceType.SearchRouteWaypoints, /// - /// Map view service is allowed + /// Indicates that map view service is allowed. /// View = Interop.ServiceType.View, /// - /// Map view snapshot service is allowed + /// Indicates that map view snapshot service is allowed. /// ViewSnapshot = Interop.ServiceType.ViewSnapshot, } diff --git a/src/Tizen.Maps/Tizen.Maps/SnapshotType.cs b/src/Tizen.Maps/Tizen.Maps/SnapshotType.cs index 88fce00..2dfffee 100755 --- a/src/Tizen.Maps/Tizen.Maps/SnapshotType.cs +++ b/src/Tizen.Maps/Tizen.Maps/SnapshotType.cs @@ -22,11 +22,11 @@ namespace Tizen.Maps public enum SnapshotType { /// - /// BMP file format + /// Indicates BMP file format. /// BMP = Interop.ViewSnapshotFormatType.ViewSnapshotBmp, /// - /// JPEG file format + /// Indicates JPEG file format. /// JPEG = Interop.ViewSnapshotFormatType.ViewSnapshotJpeg, } diff --git a/src/Tizen.Maps/Tizen.Maps/TransportMode.cs b/src/Tizen.Maps/Tizen.Maps/TransportMode.cs index 92195ea..ac31221 100755 --- a/src/Tizen.Maps/Tizen.Maps/TransportMode.cs +++ b/src/Tizen.Maps/Tizen.Maps/TransportMode.cs @@ -22,23 +22,23 @@ namespace Tizen.Maps public enum TransportMode { /// - /// Route is to be traveled by car + /// Indicates that route is to be traveled by car. /// Car = Interop.RouteTransportMode.Car, /// - /// Route is for a pedestrian + /// Indicates that route is for a pedestrian. /// Pedestrian = Interop.RouteTransportMode.Pedestrian, /// - /// Route is for a cyclist + /// Indicates that route is for a cyclist. /// Bicycle = Interop.RouteTransportMode.Bicycle, /// - /// Route is to be traveled using public transport + /// Indicates that route is to be traveled using public transport. /// Publictransit = Interop.RouteTransportMode.PublicTransit, /// - /// Route is for a truck + /// Indicates that route is for a truck. /// Truck = Interop.RouteTransportMode.Truck, } diff --git a/src/Tizen.Maps/Tizen.Maps/TurnInstruction.cs b/src/Tizen.Maps/Tizen.Maps/TurnInstruction.cs index 0cb2761..175a828 100755 --- a/src/Tizen.Maps/Tizen.Maps/TurnInstruction.cs +++ b/src/Tizen.Maps/Tizen.Maps/TurnInstruction.cs @@ -22,63 +22,63 @@ namespace Tizen.Maps public enum TurnInstruction { /// - /// Unknown Instruction + /// Indicates unknown instruction. /// None = Interop.RouteTurnType.None, /// - /// Instruction to move straight + /// Indicates instruction to move straight. /// Straight = Interop.RouteTurnType.Straight, /// - /// Instruction to bear right + /// Indicates instruction to bear right. /// BearRight = Interop.RouteTurnType.BearRight, /// - /// Instruction to turn slightly to the right + /// Indicates instruction to turn slightly to the right. /// LightRight = Interop.RouteTurnType.LightRight, /// - /// Instruction to turn right + /// Indicates instruction to turn right. /// Right = Interop.RouteTurnType.Right, /// - /// Instruction to turn hard to the right + /// Indicates instruction to turn hard to the right. /// HardRight = Interop.RouteTurnType.HardRight, /// - /// Instruction to u-turn to the right + /// Indicates instruction to u-turn to the right. /// UturnRight = Interop.RouteTurnType.UturnRight, /// - /// Instruction to u-turn to the left + /// Indicates instruction to u-turn to the left. /// UturnLeft = Interop.RouteTurnType.UturnLeft, /// - /// Instruction to turn hard to the left + /// Indicates instruction to turn hard to the left. /// HardLeft = Interop.RouteTurnType.HardLeft, /// - /// Instruction to turn left + /// Indicates instruction to turn left. /// Left = Interop.RouteTurnType.Left, /// - /// Instruction to turn slightly to the left + /// Indicates instruction to turn slightly to the left. /// LightLeft = Interop.RouteTurnType.LightLeft, /// - /// Instruction to bear left + /// Indicates instruction to bear left. /// BearLeft = Interop.RouteTurnType.BearLeft, /// - /// Instruction to take right fork + /// Indicates instruction to take right fork. /// RightFork = Interop.RouteTurnType.RightFork, /// - /// Instruction to take left fork + /// Indicates instruction to take left fork. /// LeftFork = Interop.RouteTurnType.LeftFork, /// - /// Instruction to take straight fork + /// Indicates instruction to take straight fork. /// StraightFork = Interop.RouteTurnType.StraightFork, } -- 2.7.4