diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core')
8 files changed, 140 insertions, 139 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml index 06f28675..0172988b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml @@ -64,11 +64,11 @@ <Parameter Name="finished" Type="System.Action" /> </Parameters> <Docs> - <param name="callback">To be added.</param> - <param name="start">To be added.</param> - <param name="end">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="start">The fraction into the current animation at which to start the animation.</param> + <param name="end">The fraction into the current animation at which to end the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> <summary>Creates a new <see cref="T:Xamarin.Forms.Animation" /> object with the specified parameters.</summary> <remarks>To be added.</remarks> </Docs> @@ -95,9 +95,9 @@ <Parameter Name="animation" Type="Xamarin.Forms.Animation" /> </Parameters> <Docs> - <param name="beginAt">To be added.</param> - <param name="finishAt">To be added.</param> - <param name="animation">To be added.</param> + <param name="beginAt">The fraction into this animation at which the added child animation will begin animating.</param> + <param name="finishAt">The fraction into this animation at which the added child animation will stop animating.</param> + <param name="animation">The animation to add.</param> <summary>Adds an <see cref="T:Xamarin.Forms.Animation" /> object to this <see cref="T:Xamarin.Forms.Animation" /> that begins at <paramref name="beginAt" /> and finishes at <paramref name="finishAt" />.</summary> <remarks>To be added.</remarks> </Docs> @@ -128,13 +128,13 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="owner">To be added.</param> - <param name="name">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="owner">The owning animation that will be animated.</param> + <param name="name">The name, or handle, that is used to access and track the animation and its state.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Runs the <paramref name="owner" /> animation with the supplied parameters.</summary> <remarks>To be added.</remarks> </Docs> @@ -207,9 +207,9 @@ <Parameter Name="animation" Type="Xamarin.Forms.Animation" /> </Parameters> <Docs> - <param name="beginAt">To be added.</param> - <param name="finishAt">To be added.</param> - <param name="animation">To be added.</param> + <param name="beginAt">The fraction into this animation at which the added child animation will begin animating.</param> + <param name="finishAt">The fraction into this animation at which the added child animation will stop animating.</param> + <param name="animation">The animation to add.</param> <summary>Adds an <see cref="T:Xamarin.Forms.Animation" /> object to this <see cref="T:Xamarin.Forms.Animation" /> that begins at <paramref name="beginAt" /> and finishes at <paramref name="finishAt" />.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> @@ -237,9 +237,9 @@ <Parameter Name="finishAt" Type="System.Double" /> </Parameters> <Docs> - <param name="animation">To be added.</param> - <param name="beginAt">To be added.</param> - <param name="finishAt">To be added.</param> + <param name="animation">The animation to add.</param> + <param name="beginAt">The fraction into this animation at which the added child animation will begin animating.</param> + <param name="finishAt">The fraction into this animation at which the added child animation will stop animating.</param> <summary>Adds <paramref name="animation" /> to the children of this <see cref="T:Xamarin.Forms.Animation" /> object and sets the start and end times of <paramref name="animation" /> to <paramref name="beginAt" /> and <paramref name="finishAt" />, respectively.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> @@ -270,13 +270,13 @@ <Parameter Name="finishAt" Type="System.Double" /> </Parameters> <Docs> - <param name="callback">To be added.</param> - <param name="start">To be added.</param> - <param name="end">To be added.</param> - <param name="easing">To be added.</param> - <param name="beginAt">To be added.</param> - <param name="finishAt">To be added.</param> - <summary>Creates a new <see cref="T:Xamarin.Forms.Animation" /> object with the specified parameters, and adds it to the children of this <see cref="T:Xamarin.Forms.Animation" /> object.</summary> + <param name="callback">An action that is called with successive animation values.</param> + <param name="start">The fraction into the current animation at which to start the animation.</param> + <param name="end">The fraction into the current animation at which to end the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="beginAt">The fraction into this animation at which the added child animation will begin animating.</param> + <param name="finishAt">The fraction into this animation at which the added child animation will stop animating.</param> + <summary>Creates a new <see cref="T:Xamarin.Forms.Animation" /> object with the specified <paramref name="callback" />, and adds it to the children of this <see cref="T:Xamarin.Forms.Animation" /> object.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml index 211f5e31..bbdd8563 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml @@ -16,7 +16,7 @@ </Base> <Interfaces /> <Docs> - <summary>Extension methods for <see cref="T:Xamarin.Forms.Animation" />.</summary> + <summary>Extension methods for <see cref="T:Xamarin.Forms.IAnimatable" /> objects.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -41,8 +41,8 @@ <Parameter Name="handle" Type="System.String" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="handle">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="handle">An animation key that must be unique among its sibling and parent animations for the duration of the animation.</param> <summary>Stops the animation.</summary> <returns>To be added.</returns> <remarks>If <paramref name="handle" /> refers to an animation that belongs to this <see cref="T:Xamarin.Forms.IAnimatable" /> instance, then its tweener handlers are removed, the tweener is stopped, the animation is removed from this <see cref="T:Xamarin.Forms.IAnimatable" /> instance, and it is marked as finished. If <paramref name="handle" /> refers to one of the kinetics that belong to this <see cref="T:Xamarin.Forms.IAnimatable" /> instance, then it and its ticker are removed.</remarks> @@ -75,14 +75,14 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="callback">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> <remarks>To be added.</remarks> </Docs> @@ -114,14 +114,14 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="animation">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="animation">The animation to run.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> <remarks>To be added.</remarks> </Docs> @@ -155,16 +155,16 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="callback">To be added.</param> - <param name="start">To be added.</param> - <param name="end">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="start">The fraction into the current animation at which to start the animation.</param> + <param name="end">The fraction into the current animation at which to stop the animation.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> <remarks>To be added.</remarks> </Docs> @@ -201,15 +201,15 @@ </Parameters> <Docs> <typeparam name="T">To be added.</typeparam> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="transform">To be added.</param> - <param name="callback">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="transform">A function that maps animation times to new time values.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> <remarks>To be added.</remarks> </Docs> @@ -239,12 +239,12 @@ <Parameter Name="finished" Type="System.Action" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="callback">To be added.</param> - <param name="velocity">To be added.</param> - <param name="drag">To be added.</param> - <param name="finished">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="velocity">The amount that the animation progresses in each animation step. For example, a velocity of <c>1</c> progresses at the default speed.</param> + <param name="drag">The amount that the progression speed is reduced per frame. Can be negative.</param> + <param name="finished">An action to call when the animation is finished.</param> <summary>Sets the specified parameters and starts the kinetic animation.</summary> <remarks>To be added.</remarks> </Docs> @@ -270,8 +270,8 @@ <Parameter Name="handle" Type="System.String" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="handle">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="handle">An animation key that must be unique among its sibling and parent animations for the duration of the animation.</param> <summary>Returns a Boolean value that indicates whether or not the animation that is specified by <paramref name="handle" /> is running.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> @@ -300,10 +300,10 @@ <Parameter Name="reverse" Type="System.Boolean" /> </Parameters> <Docs> - <param name="start">To be added.</param> - <param name="end">To be added.</param> - <param name="reverseVal">To be added.</param> - <param name="reverse">To be added.</param> + <param name="start">The fraction into the current animation at which to start the animation.</param> + <param name="end">The fraction into the current animation at which to stop the animation.</param> + <param name="reverseVal">The inverse scale factor to use if <paramref name="reverse" /> is <see langword="true" />.</param> + <param name="reverse">Whether to use the inverse scale factor in <paramref name="reverseVal" /> to deinterpolate.</param> <summary>Returns a function that performs a linear interpolation between <paramref name="start" /> and <paramref name="end" />.</summary> <returns>A function that performs a linear interpolation between <paramref name="start" /> and <paramref name="end" />. Application developers can pass values between 0.0f and 1.0f to this function in order to recieve a value that is offset from <paramref name="start" /> or <paramref name="end" />, depending on the value of <paramref name="reverse" />, by the passed value times the distance between <paramref name="start" /> and <paramref name="end" />.</returns> <remarks>If <paramref name="reverse" /> is <see langword="true" />, then the interpolation happens between <paramref name="start" /> and <paramref name="reverseVal" />.</remarks> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml index 3d816067..306f9fa4 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml @@ -112,7 +112,7 @@ <Parameter Name="uri" Type="System.Uri" /> </Parameters> <Docs> - <param name="uri">To be added.</param> + <param name="uri">A URI that can be parsed by the target appliction to recreate a specific state.</param> <summary>Creates and returns a new <see cref="T:Xamrin.Forms.AppLinkEntry" /> for the specified <paramref name="uri" />.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml index 0bb70fa3..c63cdb50 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml @@ -119,7 +119,7 @@ <Parameter Name="element" Type="Xamarin.Forms.Element" /> </Parameters> <Docs> - <param name="element">To be added.</param> + <param name="element">For internal use by the Xamarin.Forms platform.</param> <summary>For internal use by the Xamarin.Forms platform.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> @@ -471,7 +471,7 @@ <Parameter Name="uri" Type="System.Uri" /> </Parameters> <Docs> - <param name="uri">To be added.</param> + <param name="uri">For internal use by the Xamarin.Forms platform.</param> <summary>For internal use by the Xamarin.Forms platform.</summary> <remarks>To be added.</remarks> </Docs> @@ -559,7 +559,7 @@ <Parameter Name="provider" Type="Xamarin.Forms.IAppIndexingProvider" /> </Parameters> <Docs> - <param name="provider">To be added.</param> + <param name="provider">For internal use by the Xamarin.Forms platform.</param> <summary>For internal use by the Xamarin.Forms platform.</summary> <remarks>To be added.</remarks> </Docs> @@ -583,7 +583,7 @@ <Parameter Name="value" Type="Xamarin.Forms.Application" /> </Parameters> <Docs> - <param name="value">To be added.</param> + <param name="value">For internal use by the Xamarin.Forms platform.</param> <summary>For internal use by the Xamarin.Forms platform.</summary> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml index 123f2d0e..eb7a4309 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml @@ -56,7 +56,7 @@ <Parameter Name="bindable" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> + <param name="bindable">The bindable object to which the behavior was attached.</param> <summary>Application developers override this method to implement the behaviors that will be associated with <paramref name="bindable" />.</summary> <remarks>To be added.</remarks> </Docs> @@ -78,7 +78,7 @@ <Parameter Name="bindable" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> + <param name="bindable">The bindable object from which the behavior was detached.</param> <summary>Application developers override this method to remove the behaviors from <paramref name="bindable" /> that were implemented in a previous call to the <see cref="M:Xamarin.Forms.Behavior.OnAttachedTo" /> method.</summary> <remarks>To be added.</remarks> </Docs> @@ -100,8 +100,8 @@ <Parameter Name="bindable" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> - <summary>Attempts to attach to <paramref name="bindable" />. If successful, calls the <see cref="M:Xamarin.Forms.Behavior.OnAttachedTo" /> method.</summary> + <param name="bindable">For internal use by the Xamarin.Forms platform.</param> + <summary>AFor internal use by the Xamarin.Forms platform.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -122,8 +122,8 @@ <Parameter Name="bindable" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> - <summary>Detaches from <paramref name="bindable" />. Calls the <see cref="M:Xamarin.Forms.Behavior.OnDetachedFrom" /> method.</summary> + <param name="bindable">For internal use by the Xamarin.Forms platform.</param> + <summary>For internal use by the Xamarin.Forms platform.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml index e5a32feb..7e0a8b37 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml @@ -62,7 +62,7 @@ <Parameter Name="bindable" Type="T" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> + <param name="bindable">The bindable object to which the behavior was attached.</param> <summary>Application developers override this method to implement the behaviors that will be associated with <paramref name="bindable" />.</summary> <remarks>To be added.</remarks> </Docs> @@ -84,7 +84,7 @@ <Parameter Name="bindable" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> + <param name="bindable">The bindable object to which the behavior was attached.</param> <summary>Attaches to the superclass and then calls the <see cref="M:Xamarin.Forms.Behavior`1.OnAttachedTo(T)" /> method on this object.</summary> <remarks>To be added.</remarks> </Docs> @@ -106,7 +106,7 @@ <Parameter Name="bindable" Type="T" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> + <param name="bindable">The bindable object from which the behavior was detached.</param> <summary>Application developers override this method to remove the behaviors from <paramref name="bindable" /> that were implemented in a previous call to the <see cref="M:Xamarin.Forms.Behavior`1.OnAttachedTo" /> method.</summary> <remarks>To be added.</remarks> </Docs> @@ -128,7 +128,7 @@ <Parameter Name="bindable" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="bindable">To be added.</param> + <param name="bindable">The bindable object from which the behavior was detached.</param> <summary>Calls the <see cref="M:Xamarin.Forms.Behavior`1.OnDetachingFrom(T)" /> method and then detaches from the superclass.</summary> <remarks>To be added.</remarks> </Docs> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml index 1be2ca38..d6a7600b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml @@ -31,6 +31,7 @@ <example> <para>The XML example below prompts the user to type in the secret, which is, "The text color is red". When the user has typed the secret, the Entry text changes color to red. The code is turned back to the default color if the user then edits the text to differ from the secret. This example shows how to bind to the enclosing control with a trigger.</para> <code lang="XML"><![CDATA[ + <?xml version="1.0" encoding="utf-8"?> <ContentPage xmlns="http://xamarin.com/schemas/2014/forms" xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml" @@ -98,7 +99,7 @@ <altmember cref="T:Xamarin.Forms.Setter" /> <altmember cref="T:Xamarin.Forms.PropertyCondition" /> <altmember cref="T:Xamarin.Forms.DataTrigger" /> - <altmember cref="T:Xamarin.Forms.TriggerAction" /> + <altmember cref="T:Xamarin.Forms.TriggerAction{T}" /> </Docs> <Members> <Member MemberName=".ctor"> diff --git a/docs/Xamarin.Forms.Core/index.xml b/docs/Xamarin.Forms.Core/index.xml index e4341819..9f14fe7b 100644 --- a/docs/Xamarin.Forms.Core/index.xml +++ b/docs/Xamarin.Forms.Core/index.xml @@ -564,8 +564,8 @@ <Parameter Name="handle" Type="System.String" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="handle">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="handle">An animation key that must be unique among its sibling and parent animations for the duration of the animation.</param> <summary>Stops the animation.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.AbortAnimation(Xamarin.Forms.IAnimatable,System.String)" /> @@ -595,16 +595,16 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="callback">To be added.</param> - <param name="start">To be added.</param> - <param name="end">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="start">The fraction into the current animation at which to start the animation.</param> + <param name="end">The fraction into the current animation at which to stop the animation.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.Animate(Xamarin.Forms.IAnimatable,System.String,System.Action{System.Double},System.Double,System.Double,System.UInt32,System.UInt32,Xamarin.Forms.Easing,System.Action{System.Double,System.Boolean},System.Func{System.Boolean})" /> @@ -632,14 +632,14 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="callback">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.Animate(Xamarin.Forms.IAnimatable,System.String,System.Action{System.Double},System.UInt32,System.UInt32,Xamarin.Forms.Easing,System.Action{System.Double,System.Boolean},System.Func{System.Boolean})" /> @@ -667,14 +667,14 @@ <Parameter Name="repeat" Type="System.Func<System.Boolean>" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="animation">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="animation">The animation to run.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.Animate(Xamarin.Forms.IAnimatable,System.String,Xamarin.Forms.Animation,System.UInt32,System.UInt32,Xamarin.Forms.Easing,System.Action{System.Double,System.Boolean},System.Func{System.Boolean})" /> @@ -707,15 +707,15 @@ </Parameters> <Docs> <typeparam name="T">To be added.</typeparam> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="transform">To be added.</param> - <param name="callback">To be added.</param> - <param name="rate">To be added.</param> - <param name="length">To be added.</param> - <param name="easing">To be added.</param> - <param name="finished">To be added.</param> - <param name="repeat">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="transform">A function that maps animation times to new time values.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="rate">The time, in milliseconds, between frames.</param> + <param name="length">The number of milliseconds over which to interpolate the animation.</param> + <param name="easing">The easing function to use to transision in, out, or in and out of the animation.</param> + <param name="finished">An action to call when the animation is finished.</param> + <param name="repeat">A function that returns true if the animation should continue.</param> <summary>Sets the specified parameters and starts the animation.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.Animate``1(Xamarin.Forms.IAnimatable,System.String,System.Func{System.Double,``0},System.Action{``0},System.UInt32,System.UInt32,Xamarin.Forms.Easing,System.Action{``0,System.Boolean},System.Func{System.Boolean})" /> @@ -741,12 +741,12 @@ <Parameter Name="finished" Type="System.Action" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="name">To be added.</param> - <param name="callback">To be added.</param> - <param name="velocity">To be added.</param> - <param name="drag">To be added.</param> - <param name="finished">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="name">An animation key that should be unique among its sibling and parent animations for the duration of the animation.</param> + <param name="callback">An action that is called with successive animation values.</param> + <param name="velocity">The amount that the animation progresses in each animation step. For example, a velocity of <c>1</c> progresses at the default speed.</param> + <param name="drag">The amount that the progression speed is reduced per frame. Can be negative.</param> + <param name="finished">An action to call when the animation is finished.</param> <summary>Sets the specified parameters and starts the kinetic animation.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.AnimateKinetic(Xamarin.Forms.IAnimatable,System.String,System.Func{System.Double,System.Double,System.Boolean},System.Double,System.Double,System.Action)" /> @@ -768,8 +768,8 @@ <Parameter Name="handle" Type="System.String" /> </Parameters> <Docs> - <param name="self">To be added.</param> - <param name="handle">To be added.</param> + <param name="self">The object on which this method will be run.</param> + <param name="handle">An animation key that must be unique among its sibling and parent animations for the duration of the animation.</param> <summary>Returns a Boolean value that indicates whether or not the animation that is specified by <paramref name="handle" /> is running.</summary> </Docs> <Link Type="Xamarin.Forms.AnimationExtensions" Member="M:Xamarin.Forms.AnimationExtensions.AnimationIsRunning(Xamarin.Forms.IAnimatable,System.String)" /> |