Skip to content

Commit

Permalink
Parameter complete drive and change to Trigger.xml (xamarin#992)
Browse files Browse the repository at this point in the history 
* Parameter complete drive and change to Trigger.xml

* update docs
  • Loading branch information
@MichaelNorman @jimmgarrido
MichaelNorman authored and jimmgarrido committed Jun 21, 2017
1 parent a516769 commit a133d52
Show file tree
Hide file tree
Showing 8 changed files with 140 additions and 139 deletions.
56 changes: 28 additions & 28 deletions docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml
View file
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -128,13 +128,13 @@
<Parameter Name="repeat" Type="System.Func&lt;System.Boolean&gt;" />
</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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
100 changes: 50 additions & 50 deletions docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml
View file
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -75,14 +75,14 @@
<Parameter Name="repeat" Type="System.Func&lt;System.Boolean&gt;" />
</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>
Expand Down Expand Up @@ -114,14 +114,14 @@
<Parameter Name="repeat" Type="System.Func&lt;System.Boolean&gt;" />
</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>
Expand Down Expand Up @@ -155,16 +155,16 @@
<Parameter Name="repeat" Type="System.Func&lt;System.Boolean&gt;" />
</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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml
View file
Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml
View file
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down

0 comments on commit a133d52

Please sign in to comment.