diff options
author | Mike Norman <mike.norman@xamarin.com> | 2016-03-24 18:02:50 -0500 |
---|---|---|
committer | Mike Norman <mike.norman@xamarin.com> | 2016-03-24 18:02:50 -0500 |
commit | c7081b10f8fd9a7b8e54b1b00f7f29a0fbc0c4ad (patch) | |
tree | 01ea5012cf28a43d7a7b72c46b878fa3e82333af /docs | |
parent | ab1472de45fe7991af7ddd0fddf84b66d2efad14 (diff) | |
download | xamarin-forms-c7081b10f8fd9a7b8e54b1b00f7f29a0fbc0c4ad.tar.gz xamarin-forms-c7081b10f8fd9a7b8e54b1b00f7f29a0fbc0c4ad.tar.bz2 xamarin-forms-c7081b10f8fd9a7b8e54b1b00f7f29a0fbc0c4ad.zip |
Doc bug fixes
Diffstat (limited to 'docs')
7 files changed, 14 insertions, 13 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml index c72e0948..ebfa93f9 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml @@ -346,7 +346,7 @@ stack.BindingContext = new {Jane = new {Name = "Jane Doe"}, John = new {Name = " <returns>The value that is contained the <see cref="T:Xamarin.Forms.BindableProperty" />.</returns> <remarks> <para> - <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> and <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> are used to access the values of properties that are implemented by a <see cref="T:Xamarin.Forms.BindableProperty" />. That is, application developers typically provide an interface for a bound property by defining <see langword="public" /> property whose <see langword="get" /> accessor casts the result of <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> to the appropriate type and returns it, and whose <see langword="get" /> accessor uses <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> to set the value on the correct property. Application developers should perform no other steps in the public property that defines the interface of the bound property.</para> + <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> and <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> are used to access the values of properties that are implemented by a <see cref="T:Xamarin.Forms.BindableProperty" />. That is, application developers typically provide an interface for a bound property by defining <see langword="public" /> property whose <see langword="get" /> accessor casts the result of <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> to the appropriate type and returns it, and whose <see langword="set" /> accessor uses <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> to set the value on the correct property. Application developers should perform no other steps in the public property that defines the interface of the bound property.</para> <example> <para>The following example shows how to create a bindable property interface for an implementation that will be provided in the target property when the binding is made at run time.</para> <code lang="C#"><![CDATA[ @@ -612,7 +612,7 @@ label.SetBinding (Label.TextProperty, new Binding ("Name")); <summary>Sets the value of the specified property.</summary> <remarks> <para> - <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> and <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> are used to access the values of properties that are implemented by a <see cref="T:Xamarin.Forms.BindableProperty" />. That is, application developers typically provide an interface for a bound property by defining <see langword="public" /> property whose <see langword="get" /> accessor casts the result of <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> to the appropriate type and returns it, and whose <see langword="get" /> accessor uses <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> to set the value on the correct property. Application developers should perform no other steps in the public property that defines the interface of the bound property.</para> + <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> and <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> are used to access the values of properties that are implemented by a <see cref="T:Xamarin.Forms.BindableProperty" />. That is, application developers typically provide an interface for a bound property by defining <see langword="public" /> property whose <see langword="get" /> accessor casts the result of <see cref="M:Xamarin.Forms.BindableObject.GetValue" /> to the appropriate type and returns it, and whose <see langword="set" /> accessor uses <see cref="M:Xamarin.Forms.BindableObject.SetValue" /> to set the value on the correct property. Application developers should perform no other steps in the public property that defines the interface of the bound property.</para> <example> <para>The following example shows how to create a bindable property interface for an implementation that will be provided in the target property when the binding is made at run time.</para> <code lang="C#"><![CDATA[ diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml index 3e2d4ecf..e8ad13ea 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml @@ -20,7 +20,7 @@ </Interface> </Interfaces> <Docs> - <summary>Defines an <see cref="T:System.Windows.Input.ICommand" /> implementation wrapping an <see cref="System.Action" />.</summary> + <summary>Defines an <see cref="T:System.Windows.Input.ICommand" /> implementation that wraps a <see cref="T:System.Action" />.</summary> <remarks> <para> The following example creates a new Command and set it to a button. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml index ba37658e..2b545909 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ListView.xml @@ -692,7 +692,7 @@ ListView CreateListView() <para>Application developers will find that the easiest and least error-prone way to set all rows to a constant size is to first set <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> to <see langword="false" />, and then either: leave <see cref="P:Xamarin.Forms.ListView.RowHeight" /> at its default value of -1 (or set it back to that value if it has been changed) in order to get the default height for the system; or set the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property to the desired uniform row height.</para> <para>A more detailed discussion follows, below.</para> <para>When the app developer sets the <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> property to <see langword="false" />, the behavior of the list view depends on the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property. First, if the developer sets the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property to a positive value, then all rows in the <see cref="T:Xamarin.Forms.ListView" />, irrespective of the height of their content, will be as tall as the specified <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property value. Second, if the develper instead does not set the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property, or sets it to a nonpositive value, then all rows in the <see cref="T:Xamarin.Forms.ListView" />, irrespective of the height of their content, will have the default row height for the system.</para> - <para>When the app developer sets the <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> property to <see langword="true" />, the behavior of the list view still depends on the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property. First, if the developer either does not set the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property or sets it to -1, list view items are autosized to fit their contents. This is the desired behavior and the intended use case for a <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> value of <see langword="true" />, as noted above. Second, if the developer sets the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property to 0 or to a negative value other than -1, then all rows in the <see cref="T:Xamarin.Forms.ListView" /> will, irrespective of the height of their content, have the default height for the system. Third, and finally, if the developer sets <see cref="P:Xamarin.Forms.ListView.RowHeight" /> to a positive value, then all rows in the <see cref="T:Xamarin.Forms.ListView" /> will, irrespective of the height of their content, be as tall as <see cref="P:Xamarin.Forms.ListView.RowHeight" />, as if <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> had been set to <see langword="true" />. + <para>When the app developer sets the <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> property to <see langword="true" />, the behavior of the list view still depends on the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property. First, if the developer either does not set the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property or sets it to -1, list view items are autosized to fit their contents. This is the desired behavior and the intended use case for a <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> value of <see langword="true" />, as noted above. Second, if the developer sets the <see cref="P:Xamarin.Forms.ListView.RowHeight" /> property to 0 or to a negative value other than -1, then all rows in the <see cref="T:Xamarin.Forms.ListView" /> will, irrespective of the height of their content, have the default height for the system. Third, and finally, if the developer sets <see cref="P:Xamarin.Forms.ListView.RowHeight" /> to a positive value, then all rows in the <see cref="T:Xamarin.Forms.ListView" /> will, irrespective of the height of their content, be as tall as <see cref="P:Xamarin.Forms.ListView.RowHeight" />, as if <see cref="P:Xamarin.Forms.ListView.HasUnevenRows" /> had been set to <see langword="false" />. </para> </remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml index 2c12d59c..386d81d4 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml @@ -68,7 +68,7 @@ namespace MyFirstFormsApp </example> <para>While a <see cref="T:Xamarin.Forms.ContentPage" /> object was returned in the example above, note that any class that extends <see cref="T:Xamarin.Forms.Page" /> could have been passed, instead. For example, by using conditional compilation or by checking the platform, the developr can pass a <see cref="T:Xamarin.Forms.CarouselPage" /> to Windows Phone applications, in order to better match the style of the user interface on that platform, while passing <see cref="T:Xamarin.Forms.ContentPage" /> objects or other Page types to the other platforms.</para> <para>The other projects in the solution that target the Windows Phone, iOS, and Android platforms can call the GetMainPage method to obtain the <see cref="T:Xamarin.Forms.Page" /> descendant that describes the portable user interface. This object can then be used with platform-specific static methods or extension methods to incorporate it into the native UI for each platform.</para> - <note>On all platforms, Application developers must call the <see cref="M:Xamarin.Forms.Forms.Init" /> method before they get or create any <see cref="N:Xamarin.Forms" /> elements.</note> + <note>In each platform-specific project, Application developers must call the <c>Xamarin.Forms.Forms.Init()</c> method, with platform-specific parameters, before they get or create any <see cref="N:Xamarin.Forms" /> elements.</note> <para>Each targeted platform uses the returned page in a different way. The <c>Xamarin.Forms.Platform.iOS</c> library provides <c>Xamarin.Forms.Page.CreateViewController()</c> extension method, which returns a UIViewController that application developers can assign to the <c>UIWindow.RootViewController</c> property of the top-level UI. This code is typically placed inside the <c>UIApplicationDelegate.FinishedLaunching</c> override for the main application class. A typical example is shown below:</para> <example> <code lang="C#"> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/PlatformEffect`2.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/PlatformEffect`2.xml index 25fda9a6..07d05dbd 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/PlatformEffect`2.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/PlatformEffect`2.xml @@ -29,8 +29,9 @@ <list type="bullet"> <item><term><c>Xamarin.Forms.Platform.Android.PlatformEffect</c>,</term></item> <item><term><c>Xamarin.Forms.Platform.iOS.PlatformEffect</c>,</term></item> - <item><term><c>Xamarin.Forms.Platform.UWP.PlatformEffect</c>, or</term></item> - <item><term><c>Xamarin.Forms.Platform.WinPhone.PlatformEffect</c></term></item> + <item><term><c>Xamarin.Forms.Platform.UWP.PlatformEffect</c></term></item> + <item><term><c>Xamarin.Forms.Platform.WinPhone.PlatformEffect</c>, or</term></item> +<item><term><c>Xamarin.Forms.Platform.WinRT.PlatformEffect,</c></term></item> </list> classes to implement effects on the respective platforms.</para></remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml index 4d2945ca..aee2d899 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml @@ -28,7 +28,7 @@ <see cref="T:Xamarin.Forms.MultiPage`1" /> that displays an array of tabs across the top of the screen, each of which loads content onto the screen.</summary> <remarks> <para>The user interface of a tabbed page consists of a list of tabs and a larger detail area. On iOS, the list of tabs appears at the bottom of the screen, and the detail area is above. On Android and Windows phones, the tabs appear across the top of the screen. The user can scroll the collection of tabs that are across the top of the screen if that collection is too large to fit on one screen.</para> - <para>App developers can create tabbed pages in either of two ways. First, application developers can assign a list of objects of a single class, or its subclasses, to the <see cref="P:Xamarin.Forms.TabbedPage.ItemsSource" /> property and assign a <see cref="T:Xamarin.Forms.DataTemplate" /> to the <see cref="P:Xamarin.Forms.MultiPage{T}.ItemTemplate" /> property to return pages for objects of the least derived type. Second, app developers can add a succession of <see cref="T:Xamarin.Forms.Page" /> objects to the <see cref="P:Xamarin.Forms.MultiPage{T}.Children" /> property. Both methods are shown in the code examples below.</para> + <para>App developers can create tabbed pages in either of two ways. First, application developers can assign a list of objects of a single class, or its subclasses, to the <see cref="P:Xamarin.Forms.MultiPage.ItemsSource" /> property and assign a <see cref="T:Xamarin.Forms.DataTemplate" /> to the <see cref="P:Xamarin.Forms.MultiPage{T}.ItemTemplate" /> property to return pages for objects of the least derived type. Second, app developers can add a succession of <see cref="T:Xamarin.Forms.Page" /> objects to the <see cref="P:Xamarin.Forms.MultiPage{T}.Children" /> property. Both methods are shown in the code examples below.</para> <example> <para>The following example code, adapted for brevity from the FormsGallery sample that can be found on the <format type="text/html"><a href="http://developer.xamarin.com/samples/tag/Xamarin.Forms/" target="_blank">Sample Applications</a></format> page, shows how to display data of a specific type by assigning a <see cref="T:Xamarin.Forms.DataTemplate" /> to the <see cref="P:Xamarin.Forms.MultiPage{T}.ItemTemplate" /> property. Note how <c>NamedColorPage</c> gets its color by binding its <see cref="F:Xamarin.Forms.BoxView.ColorProperty" /> field.</para> <code lang="C#"><![CDATA[ diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/TextAlignment.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/TextAlignment.xml index 1030ae2b..55f4e24b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/TextAlignment.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/TextAlignment.xml @@ -15,8 +15,8 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>Represents vertical and horizontal text alignement.</summary> - <remarks>This affects the way the text is diaplayed inside of its control bounds.</remarks> + <summary>Enumerates values that control text alignment.</summary> + <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName="Center"> @@ -36,7 +36,7 @@ <ReturnType>Xamarin.Forms.TextAlignment</ReturnType> </ReturnValue> <Docs> - <summary>Center-aligned text.</summary> + <summary>Indicates that text will be aligned in the middle of either horizontally or vertically aligned text.</summary> </Docs> </Member> <Member MemberName="End"> @@ -56,7 +56,7 @@ <ReturnType>Xamarin.Forms.TextAlignment</ReturnType> </ReturnValue> <Docs> - <summary>End-flushed text. It means right-aligned (resp: bottom-aligned) for horizontal (resp vertical) alignemnt.</summary> + <summary>Indicates that text will be aligned to the right or bottom of horizontally or vertically aligned text, respectively.</summary> </Docs> </Member> <Member MemberName="Start"> @@ -76,7 +76,7 @@ <ReturnType>Xamarin.Forms.TextAlignment</ReturnType> </ReturnValue> <Docs> - <summary>Start-flushed text. It means left-aligned (resp: top-aligned) for horizontal (resp vertical) alignemnt.</summary> + <summary>Indicates that text will be aligned to the left or top of horizontally or vertically aligned text, respectively.</summary> </Docs> </Member> </Members> |