docs: improved doc comment

pull/111/head
alestiago 4 years ago
parent 204aa4c0a9
commit 235a5b3a29

@ -73,8 +73,10 @@ class BallController extends ComponentController<Ball> {
/// Removes the [Ball] from a [PinballGame]; spawning a new [Ball] if /// Removes the [Ball] from a [PinballGame]; spawning a new [Ball] if
/// any are left. /// any are left.
/// ///
/// {@template ball_controller_lost}
/// Triggered by [BottomWallBallContactCallback] when the [Ball] falls into /// Triggered by [BottomWallBallContactCallback] when the [Ball] falls into
/// a [BottomWall]. /// a [BottomWall].
/// {@endtemplate}
void lost() { void lost() {
component.shouldRemove = true; component.shouldRemove = true;
} }
@ -87,6 +89,11 @@ class PlungerBallController extends BallController
PlungerBallController(Ball<Forge2DGame> ball) : super(ball); PlungerBallController(Ball<Forge2DGame> ball) : super(ball);
@override @override
/// Removes the [Ball] from a [PinballGame]; spawning a new [Ball] if
/// any are left.
///
/// {@macro ball_controller_lost}
void lost() { void lost() {
super.lost(); super.lost();
final bloc = gameRef.read<GameBloc>()..add(const BallLost()); final bloc = gameRef.read<GameBloc>()..add(const BallLost());

Loading…
Cancel
Save