diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/MessagingCenter.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/MessagingCenter.xml | 122 |
1 files changed, 61 insertions, 61 deletions
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> |