summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core
diff options
context:
space:
mode:
authorMike Norman <mknorman@gmail.com>2017-06-06 16:05:24 (GMT)
committerGitHub <noreply@github.com>2017-06-06 16:05:24 (GMT)
commit0d3611ccce5db468bf0a6bbccd5ad4e96884bce0 (patch)
treecefc5d493a58bbc2eb7b93b4c52b9b62f8c45549 /docs/Xamarin.Forms.Core
parentf9c1989d0102866b6737a5924991490683d5f08b (diff)
downloadxamarin-forms-0d3611ccce5db468bf0a6bbccd5ad4e96884bce0.zip
xamarin-forms-0d3611ccce5db468bf0a6bbccd5ad4e96884bce0.tar.gz
xamarin-forms-0d3611ccce5db468bf0a6bbccd5ad4e96884bce0.tar.bz2
Bashing doc bugs. (#966)
* Bashing doc bugs. * Typo fix "developers" => "developers" * update docs
Diffstat (limited to 'docs/Xamarin.Forms.Core')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml2
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml2
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/ListViewCachingStrategy.xml5
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml18
4 files changed, 16 insertions, 11 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml
index 71ba76a..e4704d0 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml
@@ -425,7 +425,7 @@ button.HeightRequest = Device.OnPlatform (20,30,30);
<ReturnType>Xamarin.Forms.TargetPlatform</ReturnType>
</ReturnValue>
<Docs>
- <summary>Gets the <see cref="Xamarin.Forms.TargetPlatform" /> indicating the OS Xamarin.Forms is working on.</summary>
+ <summary>Gets the <see cref="T:Xamarin.Forms.TargetPlatform" /> indicating the OS Xamarin.Forms is working on.</summary>
<value>A <see cref="Xamarin.Forms.TargetPlatform" /> that indicates the current OS.</value>
<remarks>
</remarks>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml
index eecb359..11b2434 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml
@@ -237,7 +237,7 @@ class ListViewDemoPage : ContentPage
<remarks>
<para>For memory and performance reasons, application developers should strongly prefer <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" />, when possible. See <see cref="T:Xamarin.Forms.ListViewCachingStrategy" /> for more details.</para>
<para>
- <block type="note">When devolopers specify <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" />, <c>OnElementChanged</c> events are not raised when cells are recycled. Instead, the cell is retained and its property values change when the binding context is updated to that of an available cell, <c>OnElementPropertyChanged</c> events are raised. Application developers should remember to listen for the correct events, and should note that their renderers will need to be updated if the default behavior changes to <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" /> in a future release. </block>
+ <block type="note">When developers specify <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" />, <c>OnElementChanged</c> events are not raised when cells are recycled. Instead, the cell is retained and its property values change when the binding context is updated to that of an available cell, <c>OnElementPropertyChanged</c> events are raised. Application developers should remember to listen for the correct events, and should note that their renderers will need to be updated if the default behavior changes to <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" /> in a future release. </block>
</para>
</remarks>
</Docs>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ListViewCachingStrategy.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ListViewCachingStrategy.xml
index f783b45..4aca0cf 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ListViewCachingStrategy.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ListViewCachingStrategy.xml
@@ -25,7 +25,10 @@
</ListView.ItemTemplate>
</ListView>]]></code>
<para>
- <block type="note">When devolopers specify <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" />, <c>OnElementChanged</c> events are not raised when cells are recycled. Instead, the cell is retained and its property values change when the binding context is updated to that of an available cell, <c>OnElementPropertyChanged</c> events are raised. Application developers should remember to listen for the correct events, and should note that their renderers will need to be updated if the default behavior changes to <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" /> in a future release. </block>
+ <block type="note">When devolopers specify <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" />, <c>OnElementChanged</c> events are not raised when cells are recycled. Instead, the cell is retained and its property values change when the binding context is updated to that of an available cell, <c>OnElementPropertyChanged</c> events are raised. Application developers should remember to listen for the correct events, and should note that their renderers will need to be updated if the default behavior changes to <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" /> in a future release.</block>
+ </para>
+ <para>
+ <block type="note">The UWP platform ignores <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RetainElement" />, because it always uses caching to improve performance. Therefore, if the developer has opted not to use data bindings, they must use <see cref="M:Xamarin.Forms.ListView.OnBindingContextChanged" /> to update cell data on UWP, because it always behaves as if <see cref="F:Xamarin.Forms.ListViewCachingStrategy.RecycleElement" /> was specified.</block>
</para>
</remarks>
</Docs>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml
index 6f337aa..5e807d2 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml
@@ -449,8 +449,8 @@
<param name="heightConstraint">The available height that a parent element can allocated to a child. Value will be between 0 and double.PositiveInfinity.</param>
<summary>Returns the <see cref="T:Xamarin.Forms.SizeRequest" /> of the element. Calling this method begins the measure pass of a layout cycle.</summary>
<returns>A <see cref="T:Xamarin.Forms.SizeRequest" /> which contains a requested size and a minimum size.</returns>
- <remarks>Calling GetSizeRequest causes a measure pass to occur for the subtree of elements it is called on. It is ideal to only call GetSizeRequest when needed as excessive calls can negatively impact the performance of your app. Overriding GetSizeRequest should only be done if you want to ignore Width/HeightRequest. More likely a subclass would wish to override <see cref="M:Xamarin.Forms.VisualElement.OnSizeRequest (double, double)" />.</remarks>
- <altmember cref="M:Xamarin.Forms.OnSizeRequest (double, double)" />
+ <remarks>Calling GetSizeRequest causes a measure pass to occur for the subtree of elements it is called on. It is ideal to only call GetSizeRequest when needed as excessive calls can negatively impact the performance of your app. Overriding GetSizeRequest should only be done if you want to ignore Width/HeightRequest. More likely a subclass would wish to override <see cref="M:Xamarin.Forms.VisualElement.OnSizeRequest" />.</remarks>
+ <altmember cref="M:Xamarin.Forms.OnSizeRequest" />
</Docs>
</Member>
<Member MemberName="Height">
@@ -956,12 +956,14 @@
<Parameter Name="flags" Type="Xamarin.Forms.MeasureFlags" />
</Parameters>
<Docs>
- <param name="widthConstraint">To be added.</param>
- <param name="heightConstraint">To be added.</param>
- <param name="flags">To be added.</param>
- <summary>Measures a visual element for layout operations.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <param name="widthConstraint">The suggested maximum width constraint for the visual element to render.</param>
+ <param name="heightConstraint">The suggested maximum height constraint for the visual element to render.</param>
+ <param name="flags">A value that controls whether margins are included in the returned size.</param>
+ <summary>Returns the minimum size that a visual element needs in order to be displayed on the device.</summary>
+ <returns>The minimum size that a visual element needs in order to be displayed on the device.</returns>
+ <remarks>
+ <para>If the minimum sized that the visual element needs in order to be displayed on the device is larger than can be accommodated by <paramref name="widthConstraint" /> and <paramref name="heightConstraint" />, the return value may represent a rectangle that is larger in either or both of those parameters.</para>
+ </remarks>
</Docs>
</Member>
<Member MemberName="MeasureInvalidated">