Improve documentation around animations. (#42267)

This commit is contained in:
Ian Hickson 2019-10-09 16:31:29 -07:00 committed by Michael Goderbauer
parent ed482c3e09
commit 96276630bf
2 changed files with 6 additions and 2 deletions

View File

@ -673,6 +673,10 @@ class AnimationController extends Animation<double>
/// Drives the animation according to the given simulation.
///
/// The values from the simulation are clamped to the [lowerBound] and
/// [upperBound]. To avoid this, consider creating the [AnimationController]
/// using the [new AnimationController.unbounded] constructor.
///
/// Returns a [TickerFuture] that completes when the animation is complete.
///
/// The most recently returned [TickerFuture], if any, is marked as having been

View File

@ -122,8 +122,8 @@ class SpringSimulation extends Simulation {
String toString() => '$runtimeType(end: $_endPosition, $type)';
}
/// A SpringSimulation where the value of [x] is guaranteed to have exactly the
/// end value when the simulation isDone().
/// A [SpringSimulation] where the value of [x] is guaranteed to have exactly the
/// end value when the simulation [isDone].
class ScrollSpringSimulation extends SpringSimulation {
/// Creates a spring simulation from the provided spring description, start
/// distance, end distance, and initial velocity.