firka/flutter
firka/flutter
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc improvements for animations (#14892)

Browse Source 
* Doc improvements for animations
This commit is contained in:
David Shuckerow 2018-02-26 15:39:42 -08:00 committed by GitHub
parent a0ffe87bc3
commit 758c221dc3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
packages/flutter/lib/src/animation/animations.dart
View File

@ -545,9 +545,9 @@ class TrainHoppingAnimation extends Animation<double>
/// ///
/// For example, to create an animation that is the sum of two others, subclass /// For example, to create an animation that is the sum of two others, subclass
/// this class and define `T get value = first.value + second.value;` /// this class and define `T get value = first.value + second.value;`
/// ///
/// By default, the [status] of a [CompoundAnimation] is the status of the /// By default, the [status] of a [CompoundAnimation] is the status of the
/// [next] animation if [next] is moving, and the status of the [first] /// [next] animation if [next] is moving, and the status of the [first]
/// animation otherwise. /// animation otherwise.
abstract class CompoundAnimation<T> extends Animation<T> abstract class CompoundAnimation<T> extends Animation<T>
with AnimationLazyListenerMixin, AnimationLocalListenersMixin, AnimationLocalStatusListenersMixin { with AnimationLazyListenerMixin, AnimationLocalListenersMixin, AnimationLocalStatusListenersMixin {
@ -583,7 +583,7 @@ abstract class CompoundAnimation<T> extends Animation<T>
} }
/// Gets the status of this animation based on the [first] and [next] status. /// Gets the status of this animation based on the [first] and [next] status.
/// ///
/// The default is that if the [next] animation is moving, use its status. /// The default is that if the [next] animation is moving, use its status.
/// Otherwise, default to [first]. /// Otherwise, default to [first].
@override @override
@ -635,9 +635,13 @@ class AnimationMean extends CompoundAnimation<double> {
/// An animation that tracks the maximum of two other animations. /// An animation that tracks the maximum of two other animations.
/// ///
/// The [value] of this animation is the maximum of the values of /// The [value] of this animation is the maximum of the values of
/// [first] and [next]. /// [first] and [next].
class AnimationMax<T extends num> extends CompoundAnimation<T> { class AnimationMax<T extends num> extends CompoundAnimation<T> {
/// Creates an [AnimationMax].
///
/// Both arguments must be non-null. Either can be an [AnimationMax] itself
/// to combine multiple animations.
AnimationMax(Animation<T> first, Animation<T> next): super(first: first, next: next); AnimationMax(Animation<T> first, Animation<T> next): super(first: first, next: next);
@override @override
@ -646,9 +650,13 @@ class AnimationMax<T extends num> extends CompoundAnimation<T> {
/// An animation that tracks the minimum of two other animations. /// An animation that tracks the minimum of two other animations.
/// ///
/// The [value] of this animation is the maximum of the values of /// The [value] of this animation is the maximum of the values of
/// [first] and [next]. /// [first] and [next].
class AnimationMin<T extends num> extends CompoundAnimation<T> { class AnimationMin<T extends num> extends CompoundAnimation<T> {
/// Creates an [AnimationMin].
///
/// Both arguments must be non-null. Either can be an [AnimationMin] itself
/// to combine multiple animations.
AnimationMin(Animation<T> first, Animation<T> next): super(first: first, next: next); AnimationMin(Animation<T> first, Animation<T> next): super(first: first, next: next);
@override @override