chore: doc refactor

pull/87/head
RuiAlonso 4 years ago
parent 6cbf4b156f
commit 352ebdff9e

@ -11,10 +11,10 @@ import 'package:pinball_components/pinball_components.dart';
/// A [Blueprint] which creates the [JetpackRamp]. /// A [Blueprint] which creates the [JetpackRamp].
class Jetpack extends Forge2DBlueprint { class Jetpack extends Forge2DBlueprint {
/// Width between walls of the [Pathway]. /// Width between walls of the pathway.
static const width = 5.0; static const width = 5.0;
/// Size for the radius of the external wall [Pathway]. /// Size for the radius of the external wall pathway.
static const externalRadius = 18.0; static const externalRadius = 18.0;
@override @override

@ -11,10 +11,10 @@ import 'package:pinball_components/pinball_components.dart';
/// A [Blueprint] which creates the launcher ramp. /// A [Blueprint] which creates the launcher ramp.
class Launcher extends Forge2DBlueprint { class Launcher extends Forge2DBlueprint {
/// Width between walls of the [Pathway]. /// Width between walls of the pathway.
static const width = 5.0; static const width = 5.0;
/// Size for the radius of the external wall [Pathway]. /// Size for the radius of the external wall pathway.
static const externalRadius = 16.3; static const externalRadius = 16.3;
@override @override

@ -37,10 +37,10 @@ abstract class RampOpening extends BodyComponent with InitialPosition, Layered {
final Layer _pathwayLayer; final Layer _pathwayLayer;
final Layer _outsideLayer; final Layer _outsideLayer;
/// Mask of category bits for collision inside [Pathway]. /// Mask of category bits for collision inside pathway.
Layer get pathwayLayer => _pathwayLayer; Layer get pathwayLayer => _pathwayLayer;
/// Mask of category bits for collision outside [Pathway]. /// Mask of category bits for collision outside pathway.
Layer get outsideLayer => _outsideLayer; Layer get outsideLayer => _outsideLayer;
/// The [Shape] of the [RampOpening]. /// The [Shape] of the [RampOpening].
@ -65,7 +65,7 @@ abstract class RampOpening extends BodyComponent with InitialPosition, Layered {
} }
/// {@template ramp_opening_ball_contact_callback} /// {@template ramp_opening_ball_contact_callback}
/// Detects when a [Ball] enters or exits a [Pathway] ramp through a /// Detects when a [Ball] enters or exits a pathway ramp through a
/// [RampOpening]. /// [RampOpening].
/// ///
/// Modifies [Ball]'s [Layer] accordingly depending on whether the [Ball] is /// Modifies [Ball]'s [Layer] accordingly depending on whether the [Ball] is

Loading…
Cancel
Save