diff options
22 files changed, 255 insertions, 251 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/Application.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/Application.xml index 82e404cc..6200f513 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/Application.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/Application.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The application instance that Xamarin.Forms created on the Android platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that tells whether the soft input mode of the provided <paramref name="element" /> pans or resizes its content to allow the display of the on-screen input UI.</summary> + <returns>A value that tells whether the soft input mode of the provided <paramref name="element" /> pans or resizes its content to allow the display of the on-screen input UI.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,9 +48,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Android,Xamarin.Forms.Application>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that tells whether the soft input mode of the provided platform configuration pans or resizes its content to allow the display of the on-screen input UI.</summary> + <returns>A value that tells whether the soft input mode of the provided platform configuration pans or resizes its content to allow the display of the on-screen input UI.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,9 +69,9 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.AndroidSpecific.WindowSoftInputModeAdjust" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether the soft input mode of the provided <paramref name="element" /> pans or resizes its content to allow the display of the on-screen input UI.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -90,10 +90,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.AndroidSpecific.WindowSoftInputModeAdjust" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether the soft input mode of the provided platform configuration pans or resizes its content to allow the display of the on-screen input UI.</summary> + <returns>A value that controls whether the soft input mode of the provided platform configuration pans or resizes its content to allow the display of the on-screen input UI.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -108,7 +108,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The backing store for the attached property that controls whether the soft input mode pans or resizes content to allow the display of the on-screen input UI.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/TabbedPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/TabbedPage.xml index 6ab33705..3d4d4fd1 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/TabbedPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/TabbedPage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The tabbed page instance that Xamarin.Forms created on the Android platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Android,Xamarin.Forms.TabbedPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Disables swiped paging.</summary> + <returns>The updated element on the Android platform.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,9 +48,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Android,Xamarin.Forms.TabbedPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Enables swiped paging.</summary> + <returns>The updated element on the Android platform.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -68,9 +68,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a Boolean value that tells whether swiped paging is enabled.</summary> + <returns>A Boolean value that tells whether swipe paging is enabled.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -88,9 +88,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns the number of offscreen pages are cached in memory.</summary> + <returns>The number of offscreen pages are cached in memory.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -108,9 +108,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Android,Xamarin.Forms.TabbedPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Gets a Boolean value that controls whether swipe paging is enabled.</summary> + <returns><see langword="true" /> if swiped paging is enabled. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -125,7 +125,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.PlatformConfiguration.AndroidSpecific.TabbedPage.IsSwipePagingEnabled" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -143,9 +143,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Android,Xamarin.Forms.TabbedPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the number of offscreen pages are cached in memory.</summary> + <returns>The number of offscreen pages are cached in memory.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -160,7 +160,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached offscreen page limit property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -179,9 +179,9 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether page swiping is enabled to the provided <paramref name="value" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -200,10 +200,10 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether page swiping is enabled to the provided <paramref name="value" />.</summary> + <returns>The configuration that was updated.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -222,9 +222,9 @@ <Parameter Name="value" Type="System.Int32" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets the number of off-screen pages that are stored in memory to the provided <paramref name="value" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -243,10 +243,10 @@ <Parameter Name="value" Type="System.Int32" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets the number of off-screen pages that are stored in memory to the provided <paramref name="value" />.</summary> + <returns>The configuration that was updated.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/WindowSoftInputModeAdjust.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/WindowSoftInputModeAdjust.xml index 7422f567..aacb2b91 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/WindowSoftInputModeAdjust.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.AndroidSpecific/WindowSoftInputModeAdjust.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates values that control how an on-screen input interface is visually accommodated.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.AndroidSpecific.WindowSoftInputModeAdjust</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the content of the control will pan, possibly off of the screen, to accommodate the input interface.</summary> </Docs> </Member> <Member MemberName="Resize"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.AndroidSpecific.WindowSoftInputModeAdjust</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the content of the control will resize to accommodate the input interface.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/CollapseStyle.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/CollapseStyle.xml index 7970fd42..5080f823 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/CollapseStyle.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/CollapseStyle.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates collapse styles for master-detail pages.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.WindowsSpecific.CollapseStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that panes should fully collapse.</summary> </Docs> </Member> <Member MemberName="Partial"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.WindowsSpecific.CollapseStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that panes should partially collapse.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/MasterDetailPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/MasterDetailPage.xml index 57d8a4e4..1b4f1fda 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/MasterDetailPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/MasterDetailPage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The master-detail page instance that Xamarin.Forms created on the Windows platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Windows,Xamarin.Forms.MasterDetailPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the width of the master pane when it is collapsed.</summary> + <returns>The width of a pane when it is collapsed.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -49,10 +49,10 @@ <Parameter Name="value" Type="System.Double" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets the width of a pane when it is collapsed.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -67,7 +67,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The backing store for the attached property that controls the width of a pane when it is collapsed..</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -82,7 +82,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls whether panes collapse fully or partially.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -100,9 +100,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns the width of collapsed panes.</summary> + <returns>The width of collapsed panes.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -120,9 +120,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that controls whether panes collapses fully or partially.</summary> + <returns>A value that controls whether panes collapses fully or partially.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -140,9 +140,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Windows,Xamarin.Forms.MasterDetailPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that controls whether panes collapses fully or partially.</summary> + <returns>A value that controls whether panes collapses fully or partially.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -161,9 +161,9 @@ <Parameter Name="collapsedPaneWidth" Type="System.Double" /> </Parameters> <Docs> - <param name="element">To be added.</param> + <param name="element">The platform specific element on which to perform the operation.</param> <param name="collapsedPaneWidth">To be added.</param> - <summary>To be added.</summary> + <summary>Sets the width of collapsed panes.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -182,9 +182,9 @@ <Parameter Name="collapseStyle" Type="Xamarin.Forms.PlatformConfiguration.WindowsSpecific.CollapseStyle" /> </Parameters> <Docs> - <param name="element">To be added.</param> + <param name="element">The platform specific element on which to perform the operation.</param> <param name="collapseStyle">To be added.</param> - <summary>To be added.</summary> + <summary>Sets a value that controls whether panes collapses fully or partially.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -203,10 +203,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.WindowsSpecific.CollapseStyle" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether panes collapses fully or partially.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -224,9 +224,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Windows,Xamarin.Forms.MasterDetailPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Causes the master detail page to partially collapse panes.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/Page.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/Page.xml index fecd773c..72cf8a20 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/Page.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/Page.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The page instance that Xamarin.Forms created on the Windows platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that controls the placement of the toolbar.</summary> + <returns>A value that controls the placement of the toolbar.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,9 +48,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.Windows,Xamarin.Forms.Page>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that controls the placement of the toolbar.</summary> + <returns>A value that controls the placement of the toolbar.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,9 +69,9 @@ <Parameter Name="toolbarPlacement" Type="Xamarin.Forms.PlatformConfiguration.WindowsSpecific.ToolbarPlacement" /> </Parameters> <Docs> - <param name="element">To be added.</param> + <param name="element">The platform specific element on which to perform the operation.</param> <param name="toolbarPlacement">To be added.</param> - <summary>To be added.</summary> + <summary>Sets a value that controls the placement of the toolbar.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -90,10 +90,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.WindowsSpecific.ToolbarPlacement" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls the placement of the toolbar.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -108,7 +108,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls the placement of the toolbar.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/ToolbarPlacement.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/ToolbarPlacement.xml index 5c571c93..f071d797 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/ToolbarPlacement.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.WindowsSpecific/ToolbarPlacement.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates toolbar positions for pages on the Windows platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.WindowsSpecific.ToolbarPlacement</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the toolbar should be placed at the bottom of the screen.</summary> </Docs> </Member> <Member MemberName="Default"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.WindowsSpecific.ToolbarPlacement</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the toolbar should be placed at the system default location on the screen.</summary> </Docs> </Member> <Member MemberName="Top"> @@ -52,7 +52,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.WindowsSpecific.ToolbarPlacement</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the toolbar should be placed at the top of the screen.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/BlurEffectStyle.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/BlurEffectStyle.xml index 1d72c88f..e2fee53b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/BlurEffectStyle.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/BlurEffectStyle.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates blur effect styles.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.BlurEffectStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates a dark blur.</summary> </Docs> </Member> <Member MemberName="ExtraLight"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.BlurEffectStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates an extra light blur.</summary> </Docs> </Member> <Member MemberName="Light"> @@ -52,7 +52,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.BlurEffectStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates a light blur.</summary> </Docs> </Member> <Member MemberName="None"> @@ -66,7 +66,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.BlurEffectStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates no blur.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Entry.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Entry.xml index 1671146f..57378daa 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Entry.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Entry.xml @@ -10,8 +10,8 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>The entry instance that Xamarin.Forms created on the iOS platform.</summary> + <remarks><para>Developers can use this platform-specific instance to control whether text in the entry instance will be resized to fit the available width. If font size adjustment is turned on, the control will progressively reduce the font sized down to a minimum value as the user enters text.</para></remarks> </Docs> <Members> <Member MemberName="AdjustsFontSizeToFitWidth"> @@ -45,7 +45,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls whether the entry control automatically adjusts the font size.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -63,9 +63,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.Entry>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Disables automatic font size adjustment on the platform-specific element.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -83,9 +83,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.Entry>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Enables automatic font size adjustment on the platform-specific element.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -103,9 +103,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a Boolean value that tells whether the entry control automatically adjusts the font size of text that the user enters.</summary> + <returns>A Boolean value that tells whether the entry control automatically adjusts the font size of text that the user enters.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -124,9 +124,9 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a Boolean value that tells whether the entry control automatically adjusts the font size of text that the user enters.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -145,10 +145,10 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a Boolean value that tells whether automatic font size adjusmtent is enabled on the element.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/NavigationPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/NavigationPage.xml index 5625bfd5..503cbd4b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/NavigationPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/NavigationPage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The navigation page instance that Xamarin.Forms created on the iOS platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.NavigationPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Makes the navigation bar opaque on the platform-specific element.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,9 +48,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.NavigationPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Makes the navigation bar translucent on the platform-specific element.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -68,9 +68,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a Boolean value that tells whether the navigation bar on the platform-specific navigation page is translucent.</summary> + <returns>A Boolean value that tells whether the navigation bar on the platform-specific navigation page is translucent.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -88,9 +88,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</summary> + <returns>A value that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -108,9 +108,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.NavigationPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</summary> + <returns>A value that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -128,9 +128,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.NavigationPage>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a Boolean value that tells whether the navigation bar on the platform-specific navigation page is translucent.</summary> + <returns>A Boolean value that tells whether the navigation bar on the platform-specific navigation page is translucent.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -145,7 +145,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.PlatformConfiguration.iOSSpecific.NavigationPage.IsNavigationBarTranslucent" /> property</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -164,9 +164,9 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a Boolean value that controls whether the navigation bar on the platform-specific navigation page is translucent.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -185,10 +185,10 @@ <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a Boolean value that controls whether the navigation bar on the platform-specific navigation page is translucent.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -207,9 +207,9 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarTextColorMode" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -228,10 +228,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarTextColorMode" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Returns a value that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -246,7 +246,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls whether the status bar text color is adjusted to match the luminosity of the navigation bar for the platform-specific navigation page.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Page.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Page.xml index d3481434..4a399324 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Page.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Page.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The page instance that Xamarin.Forms created on the iOS platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that tells whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</summary> + <returns>A value that tells whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,9 +48,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that tells whether it is preferred that the status bar is shown, hidden, or relies on the system default.</summary> + <returns>A value that tells whether it is preferred that the status bar is shown, hidden, or relies on the system default.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -68,9 +68,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.Page>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that tells whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</summary> + <returns>A value that tells whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -85,7 +85,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -103,9 +103,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.Page>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.</summary> + <returns>A value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -120,7 +120,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -139,9 +139,9 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -160,10 +160,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether the preferred animation style to use when updating the status bar is <c>None</c>, <c>Slide</c>, or <c>Fade</c>.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -182,9 +182,9 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -203,10 +203,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Picker.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Picker.xml index 9ea460a7..0694c0e9 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Picker.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/Picker.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The picker instance that Xamarin.Forms created on the iOS platform.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -25,7 +25,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -43,9 +43,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that tells whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</summary> + <returns>A value that tells whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -64,9 +64,9 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.UpdateMode" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -84,9 +84,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.Picker>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that tells whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</summary> + <returns>A value that tells whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -105,10 +105,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.UpdateMode" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls whether elements in the picker are continuously updated while scrolling or updated once after scrolling has completed.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarHiddenMode.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarHiddenMode.xml index c75e044e..b5c6c42c 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarHiddenMode.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarHiddenMode.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates status bar hiding behavior preferences.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the default behavior on the system should be used.</summary> </Docs> </Member> <Member MemberName="False"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the status bar should not be hidden.</summary> </Docs> </Member> <Member MemberName="True"> @@ -52,7 +52,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the status bar should not be hidden.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarTextColorMode.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarTextColorMode.xml index 9390697e..9693dc80 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarTextColorMode.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/StatusBarTextColorMode.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates text color adjustment options for the status bar.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarTextColorMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the text color should not be adjusted.</summary> </Docs> </Member> <Member MemberName="MatchNavigationBarTextLuminosity"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.StatusBarTextColorMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that the status bar text should match the luminosity of the navigation bar.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UIStatusBarAnimation.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UIStatusBarAnimation.xml index bdef4fff..bc01df12 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UIStatusBarAnimation.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UIStatusBarAnimation.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates animation styles for status bar updates.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that it is preferred that updates should fade in.</summary> </Docs> </Member> <Member MemberName="None"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that no animation is preferred.</summary> </Docs> </Member> <Member MemberName="Slide"> @@ -52,7 +52,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Indicates that it is preferred that updates should slide in.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UpdateMode.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UpdateMode.xml index c5b01cad..2d88a51a 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UpdateMode.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/UpdateMode.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates values that control whether elements in a picker are continuously updated while scrolling or updated once after scrolling has completed.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.UpdateMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Bound properties on picker elements should be updated after scrolling is finished.</summary> </Docs> </Member> <Member MemberName="Immediately"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.PlatformConfiguration.iOSSpecific.UpdateMode</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Bound properties on picker elements should be continuously updated while the user scrolls.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/VisualElement.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/VisualElement.xml index 4150d5bf..3d7caa69 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/VisualElement.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.iOSSpecific/VisualElement.xml @@ -10,8 +10,8 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>A visual element instance that Xamarin.Forms created on the iOS platform.</summary> + <remarks><para>Developers use this type to set iOS-specific blur effects on visual elements.</para></remarks> </Docs> <Members> <Member MemberName="BlurEffectProperty"> @@ -25,7 +25,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that controls which, if any, blur effect is applied.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -43,9 +43,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns a value that controls which, if any, blur effect is applied.</summary> + <returns>A value that controls which, if any, blur effect is applied.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -63,9 +63,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.iOS,Xamarin.Forms.VisualElement>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns a value that tells which, if any, blur effect is applied.</summary> + <returns>A value that tells which, if any, blur effect is applied.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -84,9 +84,9 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.BlurEffectStyle" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets a value that controls which, if any, blur effect is applied.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -105,10 +105,10 @@ <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.iOSSpecific.BlurEffectStyle" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">The new property value to assign.</param> + <summary>Sets the blur effect to use.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Android.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Android.xml index 02ceb3cd..6132ecdb 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Android.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Android.xml @@ -14,8 +14,8 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>Marker class that identifies the Android platform.</summary> + <remarks><para>Developers specify the type name of this marker class to the <see cref="M:Xamarin.Forms.IPlatformElementConfiguration{T,TElement}.On{T}" /> method to specify the underlying Android control on which to run a platform-specific effect.</para></remarks> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,7 +27,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new Android marker class.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Tizen.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Tizen.xml index de0e8faa..02ddffb2 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Tizen.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Tizen.xml @@ -14,8 +14,8 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>Marker class that identifies the Tizen platform.</summary> + <remarks><para>Developers specify the type name of this marker class to the <see cref="M:Xamarin.Forms.IPlatformElementConfiguration{T,TElement}.On{T}" /> method to specify the underlying Tizen control on which to run a platform-specific effect.</para></remarks> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,7 +27,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new Tizen marker class.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Windows.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Windows.xml index 43b77cb0..d4def6f0 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Windows.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/Windows.xml @@ -14,8 +14,8 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>Marker class that identifies the Windows platform.</summary> + <remarks><para>Developers specify the type name of this marker class to the <see cref="M:Xamarin.Forms.IPlatformElementConfiguration{T,TElement}.On{T}" /> method to specify the underlying Windows control on which to run a platform-specific effect.</para></remarks> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,7 +27,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new Windows marker class.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/iOS.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/iOS.xml index ecdf7252..e60636d5 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/iOS.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration/iOS.xml @@ -14,8 +14,8 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>Marker class that identifies the iOS platform.</summary> + <remarks><para>Developers specify the type name of this marker class to the <see cref="M:Xamarin.Forms.IPlatformElementConfiguration{T,TElement}.On{T}" /> method to specify the underlying iOS control on which to run a platform-specific effect.</para></remarks> </Docs> <Members> <Member MemberName=".ctor"> @@ -27,7 +27,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new iOS marker class.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IConfigPlatform.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IConfigPlatform.xml index 550913f9..1ab1b9c4 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IConfigPlatform.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IConfigPlatform.xml @@ -7,8 +7,12 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <summary>Base interface for marker classes that identify target platforms for platform specific effects.</summary> + <remarks><para>Developers pass the type name of a predefined platform-specific implementation of this marker class to the <see cref="M:Xamarin.Forms.IPlatformElementConfiguration{T,TElement}.On{T}" /> method to specify the underlying control on which to run a platform-specific effect.</para></remarks> + <altmember cref="T:Xamarin.Forms.PlatformConfiguration.Android" /> + <altmember cref="T:Xamarin.Forms.PlatformConfiguration.iOS" /> + <altmember cref="T:Xamarin.Forms.PlatformConfiguration.Tizen" /> + <altmember cref="T:Xamarin.Forms.PlatformConfiguration.Windows" /> </Docs> <Members /> </Type> |