Commit 96276630 authored by Ian Hickson's avatar Ian Hickson Committed by Michael Goderbauer

Improve documentation around animations. (#42267)

parent ed482c3e
...@@ -673,6 +673,10 @@ class AnimationController extends Animation<double> ...@@ -673,6 +673,10 @@ class AnimationController extends Animation<double>
/// Drives the animation according to the given simulation. /// 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. /// Returns a [TickerFuture] that completes when the animation is complete.
/// ///
/// The most recently returned [TickerFuture], if any, is marked as having been /// The most recently returned [TickerFuture], if any, is marked as having been
......
...@@ -122,8 +122,8 @@ class SpringSimulation extends Simulation { ...@@ -122,8 +122,8 @@ class SpringSimulation extends Simulation {
String toString() => '$runtimeType(end: $_endPosition, $type)'; String toString() => '$runtimeType(end: $_endPosition, $type)';
} }
/// A SpringSimulation where the value of [x] is guaranteed to have exactly the /// A [SpringSimulation] where the value of [x] is guaranteed to have exactly the
/// end value when the simulation isDone(). /// end value when the simulation [isDone].
class ScrollSpringSimulation extends SpringSimulation { class ScrollSpringSimulation extends SpringSimulation {
/// Creates a spring simulation from the provided spring description, start /// Creates a spring simulation from the provided spring description, start
/// distance, end distance, and initial velocity. /// distance, end distance, and initial velocity.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment