From 235a5b3a29507f523eb51ef77e8531d582258aaa Mon Sep 17 00:00:00 2001 From: alestiago Date: Wed, 30 Mar 2022 20:20:14 +0100 Subject: [PATCH] docs: improved doc comment --- lib/game/components/controlled_ball.dart | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/lib/game/components/controlled_ball.dart b/lib/game/components/controlled_ball.dart index 55b676ba..457cd309 100644 --- a/lib/game/components/controlled_ball.dart +++ b/lib/game/components/controlled_ball.dart @@ -73,8 +73,10 @@ class BallController extends ComponentController { /// Removes the [Ball] from a [PinballGame]; spawning a new [Ball] if /// any are left. /// + /// {@template ball_controller_lost} /// Triggered by [BottomWallBallContactCallback] when the [Ball] falls into /// a [BottomWall]. + /// {@endtemplate} void lost() { component.shouldRemove = true; } @@ -87,6 +89,11 @@ class PlungerBallController extends BallController PlungerBallController(Ball ball) : super(ball); @override + + /// Removes the [Ball] from a [PinballGame]; spawning a new [Ball] if + /// any are left. + /// + /// {@macro ball_controller_lost} void lost() { super.lost(); final bloc = gameRef.read()..add(const BallLost());