diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core')
22 files changed, 146 insertions, 147 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Accessibility.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Accessibility.xml index c18c73e6..fbcb7858 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Accessibility.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Accessibility.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Contains both abbreviated and detailed UI information that is supplied to accessibility services.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new <see cref="T:Xamarin.Forms.Accessibility" /> object with default values.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that contains the detailed description of the UI element and its behavior.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -53,7 +53,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that contains a Boolean value that tells whether the element is available to the accessible app.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -68,7 +68,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that holds a reference to the element that labels the element that is being made accessible.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -83,7 +83,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that contains the brief description of the UI element</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml index 0e789c9a..14449b13 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableObject.xml @@ -146,7 +146,7 @@ public static void OneWayDemo () </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Apply the bindings to <see cref="P:Xamarin.Forms.BindableObject.BindingContext" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -170,7 +170,7 @@ public static void OneWayDemo () </Parameters> <Docs> <param name="oldContext">The object that contains the properties that will be targeted by the bound properties that belong to this <see cref="T:Xamarin.Forms.BindableObject" />. This parameter is optional.</param> - <summary>Apply the bindings to <c>this</c><see cref="P:Xamarin.Forms.BindableObject.BindingContex" />.</summary> + <summary>Apply the bindings to <see cref="P:Xamarin.Forms.BindableObject.BindingContext" />.</summary> <remarks> <para>If an object is passed for the <paramref name="oldContext" /> argument, bindings are first unapplied from <paramref name="oldContext" />. This method removes any current bindings from the old context, and applies every binding to the current <see cref="P:Xamarin.Forms.BindableObject.BindingContex" />. Application developers could use this method to bind the UI from a new View to an existing ViewModel, while optionally removing the bindings from the old View. Application developers can omit the <paramref name="oldContext" /> argument in order to leave the old bindings in place.</para> </remarks> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml index fbf294b3..18a498de 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml @@ -32,7 +32,7 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The string "Android", representing the Android operating system.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -155,7 +155,7 @@ Device.BeginInvokeOnMainThread (() => { <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The string "iOS", representing the iOS operating system.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -170,7 +170,7 @@ Device.BeginInvokeOnMainThread (() => { <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The string "macOS", representing the macOS operating system.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -329,7 +329,7 @@ button.HeightRequest = Device.OnPlatform (20,30,30); <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Gets the kind of device that Xamarin.Forms is currently working on.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -372,7 +372,7 @@ button.HeightRequest = Device.OnPlatform (20,30,30); <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The string "Windows", representing the Windows operating system.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -387,7 +387,7 @@ button.HeightRequest = Device.OnPlatform (20,30,30); <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>The string "WinPhone", representing the Windows Mobile operating system.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Frame.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Frame.xml index 77677ad7..e251eb5d 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Frame.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Frame.xml @@ -102,7 +102,7 @@ MainPage = new ContentPage () { <ReturnType>System.Single</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Gets or sets the corner radius of the frame.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -118,7 +118,7 @@ MainPage = new ContentPage () { <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Frame.CornerRadius" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IButtonController.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IButtonController.xml index 6e4e1c20..bb8750a1 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IButtonController.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IButtonController.xml @@ -43,7 +43,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -59,7 +59,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IElementConfiguration`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IElementConfiguration`1.xml index a07abee9..61350c19 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IElementConfiguration`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IElementConfiguration`1.xml @@ -15,8 +15,8 @@ </TypeParameters> <Interfaces /> <Docs> - <typeparam name="TElement">To be added.</typeparam> - <summary>To be added.</summary> + <typeparam name="TElement">The element for which to return a platform-specific type.</typeparam> + <summary>Interface for returning the platform-specific instance of a Xamarin.Forms type.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -39,7 +39,7 @@ </TypeParameters> <Parameters /> <Docs> - <typeparam name="T">To be added.</typeparam> + <typeparam name="T">The platform for which to return an instance.</typeparam> <summary>Returns the platform-specific instance of this <see cref="T:Xamarin.Forms.IElementConfiguration`1" />, on which a platform-specific method may be called.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IMessagingCenter.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IMessagingCenter.xml index 1c16a996..07314ae9 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IMessagingCenter.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IMessagingCenter.xml @@ -33,10 +33,10 @@ <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="sender">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="sender">The instance that is sending the message. Typically, this is specified with the <see langword="this" /> keyword used within the sending object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <summary>Sends a named message that has no arguments.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -64,12 +64,12 @@ <Parameter Name="args" Type="TArgs" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="sender">To be added.</param> - <param name="message">To be added.</param> - <param name="args">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="sender">The instance that is sending the message. Typically, this is specified with the <see langword="this" /> keyword used within the sending object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="args">The arguments that will be passed to the listener's callback.</param> + <summary>Sends a named message with the specified arguments.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -97,12 +97,12 @@ <Parameter Name="source" Type="TSender" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <param name="callback">To be added.</param> - <param name="source">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="callback">A callback, which takes the sender and arguments as parameters, that is run when the message is received by the subscriber.</param> + <param name="source">The object that will send the messages.</param> + <summary>Run the <paramref name="callback" /> on <paramref name="subscriber" /> in response to messages that are named <paramref name="message" /> and that are created by <paramref name="source" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -131,13 +131,13 @@ <Parameter Name="source" Type="TSender" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <param name="callback">To be added.</param> - <param name="source">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="callback">A callback, which takes the sender and arguments as parameters, that is run when the message is received by the subscriber.</param> + <param name="source">The object that will send the messages.</param> + <summary>Run the <paramref name="callback" /> on <paramref name="subscriber" /> in response to parameterized messages that are named <paramref name="message" /> and that are created by <paramref name="source" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -163,10 +163,10 @@ <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <summary>Unsubscribes a subscriber from the specified messages that come from the specified sender.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -193,11 +193,11 @@ <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <summary>Unsubscribes from the specified parameterless subscriber messages.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/INavigationPageController.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/INavigationPageController.xml index 1fdf280e..3cb15b0a 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/INavigationPageController.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/INavigationPageController.xml @@ -37,7 +37,7 @@ <ReturnType>System.Collections.Generic.IEnumerable<Xamarin.Forms.Page></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -57,7 +57,7 @@ </Parameters> <Docs> <param name="depth">To be added.</param> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IPlatformElementConfiguration`2.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IPlatformElementConfiguration`2.xml index a595879a..163817e3 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IPlatformElementConfiguration`2.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IPlatformElementConfiguration`2.xml @@ -27,7 +27,7 @@ <Docs> <typeparam name="TPlatform">To be added.</typeparam> <typeparam name="TElement">To be added.</typeparam> - <summary>To be added.</summary> + <summary>Marker interface for returning platform-specific configuration elements.</summary> <remarks>To be added.</remarks> </Docs> <Members /> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ITableModel.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ITableModel.xml index 25bc52cc..5cca28b2 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ITableModel.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ITableModel.xml @@ -28,7 +28,6 @@ <Docs> <param name="section">To be added.</param> <param name="row">To be added.</param> - <summary>To be added.</summary> <summary>For internal use by platform renderers.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ITemplatedItemsView`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ITemplatedItemsView`1.xml index 4ab622cb..332413b7 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ITemplatedItemsView`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ITemplatedItemsView`1.xml @@ -19,7 +19,7 @@ </Interfaces> <Docs> <typeparam name="TItem">To be added.</typeparam> - <summary>To be added.</summary> + <summary>This interface is for internal use by platform renderers.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -34,7 +34,7 @@ <ReturnType>Xamarin.Forms.IListProxy</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -50,7 +50,7 @@ <ReturnType>System.ComponentModel.PropertyChangedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -65,7 +65,7 @@ <ReturnType>Xamarin.Forms.ITemplatedItemsList<TItem></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml index 32cd7f5e..925eedfd 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml @@ -407,7 +407,7 @@ indicator.BindingContext = image;]]></code> </Parameters> <Docs> <param name="isLoading">To be added.</param> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml index b6d44562..fe3a789d 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml @@ -35,7 +35,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new <see cref="T:Xamarin.Forms.ImageSource" /> with default values.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/MessagingCenter.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/MessagingCenter.xml index f87451e2..2c51567b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/MessagingCenter.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/MessagingCenter.xml @@ -53,7 +53,7 @@ Assert.AreEqual(2, subscriber.IntProperty); </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new <see cref="T:Xamarin.Forms.MessagingCenter" /> with default values.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -68,8 +68,8 @@ Assert.AreEqual(2, subscriber.IntProperty); <ReturnType>Xamarin.Forms.IMessagingCenter</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the singleton instance of the <see cref="T:Xamarin.Forms.MessagingCenter" />.</summary> + <value>The singleton instance of the <see cref="T:Xamarin.Forms.MessagingCenter" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -101,9 +101,9 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="sender">To be added.</param> - <param name="message">To be added.</param> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="sender">The instance that is sending the message. Typically, this is specified with the <see langword="this" /> keyword used within the sending object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> <summary>Sends a named message that has no arguments.</summary> <remarks>To be added.</remarks> </Docs> @@ -138,11 +138,11 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="args" Type="TArgs" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="sender">To be added.</param> - <param name="message">To be added.</param> - <param name="args">To be added.</param> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="sender">The instance that is sending the message. Typically, this is specified with the <see langword="this" /> keyword used within the sending object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="args">The arguments that will be passed to the listener's callback.</param> <summary>Sends a named message with the specified arguments.</summary> <remarks>To be added.</remarks> </Docs> @@ -177,11 +177,11 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="source" Type="TSender" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <param name="callback">To be added.</param> - <param name="source">To be added.</param> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="callback">A callback, which takes the sender and arguments as parameters, that is run when the message is received by the subscriber.</param> + <param name="source">The object that will send the messages.</param> <summary>Run the <paramref name="callback" /> on <paramref name="subscriber" /> in response to messages that are named <paramref name="message" /> and that are created by <paramref name="source" />.</summary> <remarks>To be added.</remarks> </Docs> @@ -217,12 +217,12 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="source" Type="TSender" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <param name="callback">To be added.</param> - <param name="source">To be added.</param> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="callback">A callback, which takes the sender and arguments as parameters, that is run when the message is received by the subscriber.</param> + <param name="source">The object that will send the messages.</param> <summary>Run the <paramref name="callback" /> on <paramref name="subscriber" /> in response to parameterized messages that are named <paramref name="message" /> and that are created by <paramref name="source" />.</summary> <remarks>To be added.</remarks> </Docs> @@ -251,9 +251,9 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> <summary>Unsubscribes a subscriber from the specified messages that come from the specified sender.</summary> <remarks>To be added.</remarks> </Docs> @@ -284,10 +284,10 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> <summary>Unsubscribes from the specified parameterless subscriber messages.</summary> <remarks>To be added.</remarks> </Docs> @@ -314,10 +314,10 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="sender">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="sender">The instance that is sending the message. Typically, this is specified with the <see langword="this" /> keyword used within the sending object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <summary>Sends the named parameterless message to objects that are listening for it on the type that is specified by <typeparamref name="TSender" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -345,12 +345,12 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="args" Type="TArgs" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="sender">To be added.</param> - <param name="message">To be added.</param> - <param name="args">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="sender">The instance that is sending the message. Typically, this is specified with the <see langword="this" /> keyword used within the sending object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="args">The arguments that will be passed to the listener's callback.</param> + <summary>Sends a message and arguments to objects that are listening for them on the type that is specified by <typeparamref name="TSender" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -378,12 +378,12 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="source" Type="TSender" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <param name="callback">To be added.</param> - <param name="source">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message to subscribe to from <paramref name="source" />.</param> + <param name="callback">A callback, which takes the sender and arguments as parameters, that is run when the message is received by the subscriber.</param> + <param name="source">The object that will send the messages.</param> + <summary>Subscribes to the specified <paramref name="message" /> from the specified <paramref name="source" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -412,13 +412,13 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="source" Type="TSender" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <param name="callback">To be added.</param> - <param name="source">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <param name="callback">A callback, which takes the sender and arguments as parameters, that is run when the message is received by the subscriber.</param> + <param name="source">The object that will send the messages.</param> + <summary>Subscribes to the specified <paramref name="message" /> from the specified <paramref name="source" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -444,10 +444,10 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <param name="subscriber">The object that is unsubscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <summary>Unsubscribes the specified <paramref name="subscriber" /> from the specified <paramref name="message" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -474,11 +474,11 @@ Assert.AreEqual(2, subscriber.IntProperty); <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <typeparam name="TSender">To be added.</typeparam> - <typeparam name="TArgs">To be added.</typeparam> - <param name="subscriber">To be added.</param> - <param name="message">To be added.</param> - <summary>To be added.</summary> + <typeparam name="TSender">The type of object that sends the message.</typeparam> + <typeparam name="TArgs">The type of the objects that are used as message arguments for the message.</typeparam> + <param name="subscriber">The object that is subscribing to the messages. Typically, this is specified with the <see langword="this" /> keyword used within the subscribing object.</param> + <param name="message">The message that will be sent to objects that are listening for the message from instances of type <typeparamref name="TSender" />.</param> + <summary>Unsubscribes the specified <paramref name="subscriber" /> from the specified <paramref name="message" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml index e6e1cba9..be75c122 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml @@ -891,7 +891,7 @@ public class MyPage : NavigationPage <ReturnType>System.Collections.Generic.IEnumerable<Xamarin.Forms.Page></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -911,7 +911,7 @@ public class MyPage : NavigationPage </Parameters> <Docs> <param name="depth">To be added.</param> - <summary>To be added.</summary> + <summary>For internal use by platform renderers.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml index 80d9d2b5..29a3d28c 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml @@ -15,7 +15,7 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> + <summary>Class that is used within <c>OnPlatform</c> tags in XAML when specifying values on platforms.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,7 +28,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new <see cref="T:Xamarin.Forms.On" /> with default values.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,7 +48,7 @@ <ReturnType>System.Collections.Generic.IList<System.String></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Gets or sets the list of specified platforms.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -64,7 +64,7 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Gets or sets the value on the current platform.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml index b7f8f47c..e703a917 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml @@ -139,7 +139,7 @@ <ReturnType>System.Collections.Generic.IList<Xamarin.Forms.On></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Gets a list of the available platforms.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ResourceDictionary.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ResourceDictionary.xml index 95690874..d0b6f33c 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/ResourceDictionary.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ResourceDictionary.xml @@ -259,8 +259,8 @@ <ReturnType>System.Type</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the type of object with which the resource dictionary is merged.</summary> + <value>The type of object with which the resource dictionary is merged, or null if the dictionary is not merged with another.</value> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml index d7efe60f..92b08dd8 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/TabbedPage.xml @@ -174,8 +174,8 @@ class TabbedPageDemoPage2 : TabbedPage <ReturnType>Xamarin.Forms.Color</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the background color of the bar.</summary> + <value>The background color of the bar.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -190,7 +190,7 @@ class TabbedPageDemoPage2 : TabbedPage <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.TabbedPage.BarBackgroundColor" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -205,8 +205,8 @@ class TabbedPageDemoPage2 : TabbedPage <ReturnType>Xamarin.Forms.Color</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the color of text on the bar.</summary> + <value>The color of text on the bar.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -221,7 +221,7 @@ class TabbedPageDemoPage2 : TabbedPage <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.TabbedPage.BarTextColor" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/TabsStyle.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/TabsStyle.xml index 7565a1f1..8c422d00 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/TabsStyle.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/TabsStyle.xml @@ -9,7 +9,7 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> + <summary>Enumerates tab styles for tabbed pages.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -24,7 +24,7 @@ <ReturnType>Xamarin.Forms.TabsStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Tabs are placed and displayed according to system defaults.</summary> </Docs> </Member> <Member MemberName="Hidden"> @@ -38,7 +38,7 @@ <ReturnType>Xamarin.Forms.TabsStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Tabs are hidden.</summary> </Docs> </Member> <Member MemberName="Icons"> @@ -52,7 +52,7 @@ <ReturnType>Xamarin.Forms.TabsStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Tabs are shown as icons.</summary> </Docs> </Member> <Member MemberName="OnBottom"> @@ -66,7 +66,7 @@ <ReturnType>Xamarin.Forms.TabsStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Tabs are displayed at the bottom of the page.</summary> </Docs> </Member> <Member MemberName="OnNavigation"> @@ -80,7 +80,7 @@ <ReturnType>Xamarin.Forms.TabsStyle</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Tabs are displayed when the user swipes from a screen edge.</summary> </Docs> </Member> </Members> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml index 9b28bf08..b2d0963c 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml @@ -302,7 +302,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Finalizer for visual elements.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/WebView.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/WebView.xml index ed614a33..931b4de0 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/WebView.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/WebView.xml @@ -302,7 +302,7 @@ namespace FormsGallery </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Method that is called when the binding context is changed.</summary> <remarks>To be added.</remarks> </Docs> </Member> |