summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Maps
diff options
context:
space:
mode:
authorMike Norman <mknorman@gmail.com>2017-06-27 13:12:32 (GMT)
committerGitHub <noreply@github.com>2017-06-27 13:12:32 (GMT)
commit2b333daafdda34267feda077f1d6826ad017e58e (patch)
tree5bbdedbbec3aac398e1c1abcdbe76f916ecd6fa1 /docs/Xamarin.Forms.Maps
parentd308479def3a3e74974fc6fdf16ea7580b5ce198 (diff)
downloadxamarin-forms-2b333daafdda34267feda077f1d6826ad017e58e.zip
xamarin-forms-2b333daafdda34267feda077f1d6826ad017e58e.tar.gz
xamarin-forms-2b333daafdda34267feda077f1d6826ad017e58e.tar.bz2
Docs param push 2 (#1018)
* More parameter descriptions in parameter-complete push. * More paremeter descriptions. * Remainder of parameter docs for Xamarin.Forms namespace * Straggler paramter complete file. * Marked all internal parameters as internal in docs. * Parameter summary complete * Update Docs
Diffstat (limited to 'docs/Xamarin.Forms.Maps')
-rw-r--r--docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Geocoder.xml4
-rw-r--r--docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Map.xml2
-rw-r--r--docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/MapSpan.xml12
-rw-r--r--docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Pin.xml2
-rw-r--r--docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Position.xml2
5 files changed, 11 insertions, 11 deletions
diff --git a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Geocoder.xml b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Geocoder.xml
index 2b3bf7d..075873d 100644
--- a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Geocoder.xml
+++ b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Geocoder.xml
@@ -56,7 +56,7 @@
<Parameter Name="position" Type="Xamarin.Forms.Maps.Position" />
</Parameters>
<Docs>
- <param name="position">To be added.</param>
+ <param name="position">The position near which to search.</param>
<summary>Returns the addresses near <paramref name="position" />, asynchronously.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
@@ -81,7 +81,7 @@
<Parameter Name="address" Type="System.String" />
</Parameters>
<Docs>
- <param name="address">To be added.</param>
+ <param name="address">The address for which to return positions.</param>
<summary>Returns a list of positions for <paramref name="address" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
diff --git a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Map.xml b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Map.xml
index 2776d0b..6f7c2db 100644
--- a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Map.xml
+++ b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Map.xml
@@ -77,7 +77,7 @@ var cp = new ContentPage {
<Parameter Name="region" Type="Xamarin.Forms.Maps.MapSpan" />
</Parameters>
<Docs>
- <param name="region">To be added.</param>
+ <param name="region">The region to show.</param>
<summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Map" /> object with that shows the region that is specified by <paramref name="region" />.</summary>
<remarks>To be added.</remarks>
</Docs>
diff --git a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/MapSpan.xml b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/MapSpan.xml
index a8031e0..47f1ac6 100644
--- a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/MapSpan.xml
+++ b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/MapSpan.xml
@@ -37,9 +37,9 @@
<Parameter Name="longitudeDegrees" Type="System.Double" />
</Parameters>
<Docs>
- <param name="center">To be added.</param>
- <param name="latitudeDegrees">To be added.</param>
- <param name="longitudeDegrees">To be added.</param>
+ <param name="center">The center of the new span.</param>
+ <param name="latitudeDegrees">The latitude of the span.</param>
+ <param name="longitudeDegrees">The longitude of the span.</param>
<summary>Returns a <see cref="T:Xamarin.Forms.Maps.MapSpan" /> that is centered on <paramref name="center" /> and extends to <paramref name="latitudeDegress" /> and <paramref name="longitudeDegress" />.</summary>
<remarks>To be added.</remarks>
</Docs>
@@ -111,7 +111,7 @@
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
- <param name="obj">To be added.</param>
+ <param name="obj">The object with which to compare.</param>
<summary>Whether <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.MapsSpan" /> with identical position and radius values as this <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</summary>
<returns>
<see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.MapsSpan" /> with identical position and radius values as this <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</returns>
@@ -138,8 +138,8 @@
<Parameter Name="radius" Type="Xamarin.Forms.Maps.Distance" />
</Parameters>
<Docs>
- <param name="center">To be added.</param>
- <param name="radius">To be added.</param>
+ <param name="center">The center of the span.</param>
+ <param name="radius">The radius to include in the span.</param>
<summary>Returns a <see cref="T:Xamarin.Forms.Maps.MapSpan" /> that displays the area that is defined by <paramref name="center" /> and <paramref name="radius" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
diff --git a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Pin.xml b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Pin.xml
index 7bacb8f..83c174e 100644
--- a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Pin.xml
+++ b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Pin.xml
@@ -139,7 +139,7 @@ public static Page GetMapPage ()
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
- <param name="obj">To be added.</param>
+ <param name="obj">The object to compare with.</param>
<summary>Whether <paramref name="obj" /> with equivalent <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" />.</summary>
<returns>
<see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.Maps.Pin" /> with equivalent <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> values.</returns>
diff --git a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Position.xml b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Position.xml
index 0d09974..55316c9 100644
--- a/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Position.xml
+++ b/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Position.xml
@@ -61,7 +61,7 @@
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
- <param name="obj">To be added.</param>
+ <param name="obj">The object to compare with.</param>
<summary>Returns a Boolean value that indicates whether or not <paramref name="obj" /> is another <see cref="T:Xamarin.Forms.Position" /> structure and represents exactly the same latitude and longitude as <see langword="this" /> one.</summary>
<returns>
<see langword="true" /> if <paramref name="obj" /> is another <see cref="T:Xamarin.Forms.Position" /> structure and represents exactly the same latitude and longitude as <see langword="this" /> one. Otherwise, <see langword="false" />.</returns>