Modify documentation of APIs
authorchanywa <cbible.kim@samsung.com>
Thu, 25 May 2017 02:20:00 +0000 (11:20 +0900)
committerchanywa <cbible.kim@samsung.com>
Thu, 25 May 2017 02:20:00 +0000 (11:20 +0900)
Change-Id: I9a80f7435fd901d938f47ee84103a5c6353d437a

src/Tizen.Maps/Interop/Interop.CoordinatesList.cs
src/Tizen.Maps/Interop/Interop.View.cs
src/Tizen.Maps/Tizen.Maps/Area.cs
src/Tizen.Maps/Tizen.Maps/GeocodeRequest.cs
src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs
src/Tizen.Maps/Tizen.Maps/MapService.cs
src/Tizen.Maps/Tizen.Maps/Marker.cs
src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs
src/Tizen.Maps/Tizen.Maps/PlaceSearchRequest.cs
src/Tizen.Maps/Tizen.Maps/ReverseGeocodeRequest.cs
src/Tizen.Maps/Tizen.Maps/RouteOptimization.cs

index 4a1700a..5c31cf9 100755 (executable)
@@ -51,7 +51,7 @@ internal static partial class Interop
         {
             using (var clonedHandle = CoordinatesHandle.CloneFrom(handleToAdd))
             {
-                if (this.Append(clonedHandle).WarnIfFailed("Failed to add coordinate to the list"))
+                if (this.Append(clonedHandle).WarnIfFailed("Failed to add coordinates to the list"))
                 {
                     clonedHandle.HasOwnership = false;
                 }
index 4990529..c50ffc1 100755 (executable)
@@ -244,14 +244,14 @@ internal static partial class Interop
         internal CoordinatesHandle ScreenToGeolocation(Point position)
         {
             IntPtr coordinates;
-            this.ScreenToGeolocation(position.X, position.Y, out coordinates).WarnIfFailed("Failed to convert screen position to geo-coordinates");
+            this.ScreenToGeolocation(position.X, position.Y, out coordinates).WarnIfFailed("Failed to convert screen position to geocoordinates");
             return CoordinatesHandle.Create(coordinates);
         }
 
         internal Point GeolocationToScreen(CoordinatesHandle coordinates)
         {
             int x, y;
-            this.GeolocationToScreen(coordinates, out x, out y).WarnIfFailed("Failed to convert geo-coordinate to screen position");
+            this.GeolocationToScreen(coordinates, out x, out y).WarnIfFailed("Failed to convert geocoordinates to screen position");
             return new Point() { X = x, Y = y };
         }
     }
index 965ee38..d7a1d73 100755 (executable)
@@ -28,8 +28,8 @@ namespace Tizen.Maps
         /// <summary>
         /// Constructs rectangular area.
         /// </summary>
-        /// <param name="topLeft">Top left coordinate of the area</param>
-        /// <param name="bottomRight">Bottom left coordinate of the area</param>
+        /// <param name="topLeft">Top-left coordinates of the area</param>
+        /// <param name="bottomRight">Bottom-left coordinate of the area</param>
         /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
         /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid</exception>
         /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
@@ -41,7 +41,7 @@ namespace Tizen.Maps
         /// <summary>
         /// Constructs circular area.
         /// </summary>
-        /// <param name="center">Coordinate for center of the area</param>
+        /// <param name="center">Coordinates for center of the area</param>
         /// <param name="radius">Radius of the area</param>
         /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
         /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid</exception>
index f67e9be..43926fa 100755 (executable)
@@ -32,7 +32,7 @@ namespace Tizen.Maps
             startExecutionAction = new Action(() =>
             {
                 int requestID;
-                errMessage = $"Failed to get co-ordinates for given address {address}";
+                errMessage = $"Failed to get coordinates for given address {address}";
                 errorCode = _service.handle.Geocode(address, _service.Preferences.handle, _geocodeCallback, IntPtr.Zero, out requestID);
                 if (errorCode.IsFailed() && errorCode != Interop.ErrorCode.Canceled)
                 {
@@ -47,7 +47,7 @@ namespace Tizen.Maps
             startExecutionAction = new Action(() =>
             {
                 int requestID;
-                errMessage = $"Failed to get co-ordinates for given address {address}";
+                errMessage = $"Failed to get coordinates for given address {address}";
                 errorCode = _service.handle.GeocodeInsideArea(address, boundry.handle, _service.Preferences.handle, _geocodeCallback, IntPtr.Zero, out requestID);
                 if (errorCode.IsFailed() && errorCode != Interop.ErrorCode.Canceled)
                 {
@@ -62,7 +62,7 @@ namespace Tizen.Maps
             startExecutionAction = new Action(() =>
             {
                 int requestID;
-                errMessage = $"Failed to get co-ordinates for given address {address}";
+                errMessage = $"Failed to get coordinates for given address {address}";
                 errorCode = _service.handle.GeocodeByStructuredAddress(address.handle, _service.Preferences.handle, _geocodeCallback, IntPtr.Zero, out requestID);
                 if (errorCode.IsFailed() && errorCode != Interop.ErrorCode.Canceled)
                 {
index c2e4744..e6ba385 100755 (executable)
@@ -26,7 +26,7 @@ namespace Tizen.Maps
         internal Interop.CoordinatesHandle handle;
 
         /// <summary>
-        /// Constructs map coordinate object.
+        /// Constructs map coordinates object.
         /// </summary>
         /// <param name="latitude">Latitude value, must be between (-90.0 ~ 90.0) degrees</param>
         /// <param name="longitude">Longitude value, must be between (-180.0 ~ 180.0) degrees</param>
index c1f84cd..cfc9086 100755 (executable)
@@ -82,8 +82,8 @@ namespace Tizen.Maps
         /// <summary>
         /// Gets and sets a string representing keys for map service provider
         /// </summary>
-        /// <remark>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.</remark>
+        /// <remarks>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.</remarks>
         public string ProviderKey
         {
             get
index dc48cf0..dc8b587 100755 (executable)
@@ -200,10 +200,10 @@ namespace Tizen.Maps
         /// </summary>
         /// <param name="coordinates">Marker coordinates</param>
         /// <param name="imagePath">Image file path for Marker</param>
-        /// <remark>
+        /// <remarks>
         /// 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.
-        /// </remark>
+        /// </remarks>
         /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
         /// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
         /// <exception cref="System.ArgumentException">Thrown when input coordinates or imagePath are invalid.</exception>
@@ -235,10 +235,10 @@ namespace Tizen.Maps
         /// </summary>
         /// <param name="coordinates">Marker coordinates</param>
         /// <param name="imagePath">Image file path for Marker</param>
-        /// <remark>
+        /// <remarks>
         /// 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.
-        /// </remark>
+        /// </remarks>
         /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
         /// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
         /// <exception cref="System.ArgumentException">Thrown when input coordinates or imagePath are invalid.</exception>
index ef48b26..9e49461 100755 (executable)
@@ -80,9 +80,9 @@ Place search<br/>
    You can refine your search request by supplying keywords, Name of Points
    of Interests, or Proximity.<br/>
  - Category Search: search for popular places for the given location context and matching the category filter criteria.
-   You can refine your search request by specifying the categories of place you are searching for.<p/>
+   You can refine your search request by specifying the categories of place you are searching for.<br/>
 Result item type of searching<br/>
-- ID, name, location, distance, URI, rating, category.<p/>
+ - ID, name, location, distance, URI, rating, category.<br/>
 Place information allows to fetch details about a place. The following place content is supported:<br/>
  - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path,
    image content, review content, and editorial content.<br/>
index baa5ecc..f1a29d8 100755 (executable)
@@ -62,7 +62,7 @@ namespace Tizen.Maps
             startExecutionAction = new Action(() =>
             {
                 int requestID;
-                errMessage = $"Failed to get co-ordinates for address {address} in given boundary";
+                errMessage = $"Failed to get coordinates for address {address} in given boundary";
                 errorCode = _service.handle.SearchPlaceByAddress(address, boundary.handle, _service.PlaceSearchFilter.handle, _service.Preferences.handle, _placeCallback, IntPtr.Zero, out requestID);
                 if (errorCode.IsFailed() && errorCode != Interop.ErrorCode.Canceled)
                 {
index 3021cce..ab80b3f 100755 (executable)
@@ -53,7 +53,7 @@ namespace Tizen.Maps
             startExecutionAction = new Action(() =>
             {
                 int requestID;
-                errMessage = $"Failed to get co-ordinates for given Coordinate: {latitude}:{longitute}";
+                errMessage = $"Failed to get coordinates for given coordinates: {latitude}:{longitute}";
                 errorCode = _service.handle.ReverseGeocode(latitude, longitute, _service.Preferences.handle, _geocodeCallback, IntPtr.Zero, out requestID);
                 if (errorCode.IsFailed() && errorCode != Interop.ErrorCode.Canceled)
                 {
index da47189..377dd7a 100755 (executable)
@@ -19,9 +19,9 @@ namespace Tizen.Maps
     /// <summary>
     /// Allowed route optimization option used in route search requests
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// Depending on loaded maps plug-in using <paramref name="MapService"/>, some features may have no effect or differences with descriptions.
-    /// </remark>
+    /// </remarks>
     public enum RouteOptimization
     {
         /// <summary>