From 344568e91907d07769cd2863dd3c714bcbdac420 Mon Sep 17 00:00:00 2001 From: alestiago Date: Sun, 1 May 2022 22:09:01 +0100 Subject: [PATCH] docs: removed Blueprint references --- lib/game/components/launcher.dart | 3 +-- .../lib/src/components/boundaries.dart | 10 ++++++---- .../lib/src/components/dino_walls.dart | 2 +- .../lib/src/components/launch_ramp.dart | 12 +----------- .../lib/src/components/slingshot.dart | 3 +-- .../lib/src/components/spaceship_rail.dart | 2 +- .../lib/src/components/spaceship_ramp.dart | 2 +- 7 files changed, 12 insertions(+), 22 deletions(-) diff --git a/lib/game/components/launcher.dart b/lib/game/components/launcher.dart index 4cec4285..d656c718 100644 --- a/lib/game/components/launcher.dart +++ b/lib/game/components/launcher.dart @@ -3,8 +3,7 @@ import 'package:pinball/game/components/components.dart'; import 'package:pinball_components/pinball_components.dart' hide Assets; /// {@template launcher} -/// A [Blueprint] which creates the [Plunger], [RocketSpriteComponent] and -/// [LaunchRamp]. +/// Section where the ball is launched from. /// {@endtemplate} class Launcher extends Component { /// {@macro launcher} diff --git a/packages/pinball_components/lib/src/components/boundaries.dart b/packages/pinball_components/lib/src/components/boundaries.dart index 4a9909ee..90427eb0 100644 --- a/packages/pinball_components/lib/src/components/boundaries.dart +++ b/packages/pinball_components/lib/src/components/boundaries.dart @@ -4,8 +4,8 @@ import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; /// {@template boundaries} -/// A [Blueprint] which creates the [_BottomBoundary] and [_OuterBoundary]. -///{@endtemplate boundaries} +/// Pinball machine boundaring walls. +/// {@endtemplate} class Boundaries extends Component { /// {@macro boundaries} Boundaries() @@ -85,8 +85,10 @@ class _BottomBoundarySpriteComponent extends SpriteComponent with HasGameRef { } /// {@template outer_boundary} -/// Boundary enclosing the top and left side of the board. The right side of the -/// board is closed by the barrier the [LaunchRamp] creates. +/// Boundary enclosing the top and left side of the board. +/// +/// The right side of the board is closed by the barrier the [LaunchRamp] +/// creates. /// {@endtemplate outer_boundary} class _OuterBoundary extends BodyComponent with InitialPosition, Rendering { /// {@macro outer_boundary} diff --git a/packages/pinball_components/lib/src/components/dino_walls.dart b/packages/pinball_components/lib/src/components/dino_walls.dart index 97c4d468..e8ca672f 100644 --- a/packages/pinball_components/lib/src/components/dino_walls.dart +++ b/packages/pinball_components/lib/src/components/dino_walls.dart @@ -7,7 +7,7 @@ import 'package:pinball_components/pinball_components.dart' hide Assets; import 'package:pinball_flame/pinball_flame.dart'; /// {@template dinowalls} -/// A [Blueprint] which creates walls for the [ChromeDino]. +/// Walls near the [ChromeDino]. /// {@endtemplate} class DinoWalls extends Component { /// {@macro dinowalls} diff --git a/packages/pinball_components/lib/src/components/launch_ramp.dart b/packages/pinball_components/lib/src/components/launch_ramp.dart index 83583bd7..faa0afdf 100644 --- a/packages/pinball_components/lib/src/components/launch_ramp.dart +++ b/packages/pinball_components/lib/src/components/launch_ramp.dart @@ -8,8 +8,7 @@ import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; /// {@template launch_ramp} -/// A [Blueprint] which creates the [_LaunchRampBase] and -/// [_LaunchRampForegroundRailing]. +/// Ramp where the ball is launched from. /// {@endtemplate} class LaunchRamp extends Component { /// {@macro launch_ramp} @@ -24,11 +23,7 @@ class LaunchRamp extends Component { ); } -/// {@template launch_ramp_base} -/// Ramp the [Ball] is launched from at the beginning of each ball life. -/// {@endtemplate} class _LaunchRampBase extends BodyComponent with Layered, Rendering { - /// {@macro launch_ramp_base} _LaunchRampBase() : super( renderBody: false, @@ -140,12 +135,7 @@ class _LaunchRampBackgroundRailingSpriteComponent extends SpriteComponent } } -/// {@template launch_ramp_foreground_railing} -/// Foreground railing for the [_LaunchRampBase] to render in front of the -/// [Ball]. -/// {@endtemplate} class _LaunchRampForegroundRailing extends BodyComponent with Rendering { - /// {@macro launch_ramp_foreground_railing} _LaunchRampForegroundRailing() : super( children: [_LaunchRampForegroundRailingSpriteComponent()], diff --git a/packages/pinball_components/lib/src/components/slingshot.dart b/packages/pinball_components/lib/src/components/slingshot.dart index 31bf1ede..5ce36d7b 100644 --- a/packages/pinball_components/lib/src/components/slingshot.dart +++ b/packages/pinball_components/lib/src/components/slingshot.dart @@ -4,8 +4,7 @@ import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; /// {@template slingshots} -/// A [Blueprint] which creates the pair of [Slingshot]s on the right side of -/// the board. +/// A collection of [Slingshot]s. /// {@endtemplate} class Slingshots extends Component with Rendering { /// {@macro slingshots} diff --git a/packages/pinball_components/lib/src/components/spaceship_rail.dart b/packages/pinball_components/lib/src/components/spaceship_rail.dart index 9074146f..cf812b68 100644 --- a/packages/pinball_components/lib/src/components/spaceship_rail.dart +++ b/packages/pinball_components/lib/src/components/spaceship_rail.dart @@ -6,7 +6,7 @@ import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; /// {@template spaceship_rail} -/// A [Blueprint] for the rail exiting the [AndroidSpaceship]. +/// Rail exiting the [AndroidSpaceship]. /// {@endtemplate} class SpaceshipRail extends Component { /// {@macro spaceship_rail} diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp.dart b/packages/pinball_components/lib/src/components/spaceship_ramp.dart index ae3317b0..f91bfca3 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp.dart @@ -8,7 +8,7 @@ import 'package:pinball_components/pinball_components.dart' hide Assets; import 'package:pinball_flame/pinball_flame.dart'; /// {@template spaceship_ramp} -/// A [Blueprint] which creates the ramp leading into the [AndroidSpaceship]. +/// Raamp leading into the [AndroidSpaceship]. /// {@endtemplate} class SpaceshipRamp extends Component { /// {@macro spaceship_ramp}