diff --git a/analysis_options.yaml b/analysis_options.yaml index f8155aa6..eb141d0e 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -2,3 +2,6 @@ include: package:very_good_analysis/analysis_options.2.4.0.yaml analyzer: exclude: - lib/**/*.gen.dart +linter: + rules: + public_member_api_docs: false \ No newline at end of file diff --git a/lib/app/view/app.dart b/lib/app/view/app.dart index ae3094e1..eccff7a6 100644 --- a/lib/app/view/app.dart +++ b/lib/app/view/app.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:authentication_repository/authentication_repository.dart'; import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; diff --git a/lib/bootstrap.dart b/lib/bootstrap.dart index c5e42951..f4028ee1 100644 --- a/lib/bootstrap.dart +++ b/lib/bootstrap.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'dart:async'; import 'dart:developer'; diff --git a/lib/game/behaviors/bumper_noise_behavior.dart b/lib/game/behaviors/bumper_noise_behavior.dart index 9c5da701..926fff96 100644 --- a/lib/game/behaviors/bumper_noise_behavior.dart +++ b/lib/game/behaviors/bumper_noise_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_audio/pinball_audio.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/lib/game/bloc/game_bloc.dart b/lib/game/bloc/game_bloc.dart index b22baa14..d00e5da1 100644 --- a/lib/game/bloc/game_bloc.dart +++ b/lib/game/bloc/game_bloc.dart @@ -1,4 +1,3 @@ -// ignore_for_file: public_member_api_docs import 'dart:math' as math; import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; diff --git a/lib/game/bloc/game_event.dart b/lib/game/bloc/game_event.dart index 6dba8056..a8e8593b 100644 --- a/lib/game/bloc/game_event.dart +++ b/lib/game/bloc/game_event.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'game_bloc.dart'; @immutable diff --git a/lib/game/bloc/game_state.dart b/lib/game/bloc/game_state.dart index d0311442..c45da958 100644 --- a/lib/game/bloc/game_state.dart +++ b/lib/game/bloc/game_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'game_bloc.dart'; /// Defines bonuses that a player can gain during a PinballGame. diff --git a/lib/game/pinball_game.dart b/lib/game/pinball_game.dart index 063f959e..c6ca8033 100644 --- a/lib/game/pinball_game.dart +++ b/lib/game/pinball_game.dart @@ -1,4 +1,3 @@ -// ignore_for_file: public_member_api_docs import 'dart:async'; import 'package:flame/components.dart'; diff --git a/lib/game/view/pinball_game_page.dart b/lib/game/view/pinball_game_page.dart index 354d61ed..c67b2d10 100644 --- a/lib/game/view/pinball_game_page.dart +++ b/lib/game/view/pinball_game_page.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/game.dart'; import 'package:flutter/foundation.dart'; import 'package:flutter/material.dart'; diff --git a/lib/how_to_play/widgets/how_to_play_dialog.dart b/lib/how_to_play/widgets/how_to_play_dialog.dart index 1fd26837..0113319e 100644 --- a/lib/how_to_play/widgets/how_to_play_dialog.dart +++ b/lib/how_to_play/widgets/how_to_play_dialog.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'dart:async'; import 'package:flutter/material.dart'; diff --git a/lib/l10n/l10n.dart b/lib/l10n/l10n.dart index 0945f30f..17c891b5 100644 --- a/lib/l10n/l10n.dart +++ b/lib/l10n/l10n.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flutter/widgets.dart'; import 'package:flutter_gen/gen_l10n/app_localizations.dart'; diff --git a/lib/select_character/cubit/character_theme_cubit.dart b/lib/select_character/cubit/character_theme_cubit.dart index 362db11a..2be3b88b 100644 --- a/lib/select_character/cubit/character_theme_cubit.dart +++ b/lib/select_character/cubit/character_theme_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; import 'package:pinball_theme/pinball_theme.dart'; diff --git a/lib/select_character/cubit/character_theme_state.dart b/lib/select_character/cubit/character_theme_state.dart index 2f0f22ea..eb4f1279 100644 --- a/lib/select_character/cubit/character_theme_state.dart +++ b/lib/select_character/cubit/character_theme_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'character_theme_cubit.dart'; class CharacterThemeState extends Equatable { diff --git a/packages/pinball_components/analysis_options.yaml b/packages/pinball_components/analysis_options.yaml index f8155aa6..eb141d0e 100644 --- a/packages/pinball_components/analysis_options.yaml +++ b/packages/pinball_components/analysis_options.yaml @@ -2,3 +2,6 @@ include: package:very_good_analysis/analysis_options.2.4.0.yaml analyzer: exclude: - lib/**/*.gen.dart +linter: + rules: + public_member_api_docs: false \ No newline at end of file diff --git a/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart b/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart index 7024f65c..5fd0c9fe 100644 --- a/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart +++ b/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart @@ -103,7 +103,6 @@ class AndroidBumper extends BodyComponent with InitialPosition, ZIndex { final double _minorRadius; - // ignore: public_member_api_docs final AndroidBumperCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/android_bumper/behaviors/android_bumper_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/android_bumper/behaviors/android_bumper_ball_contact_behavior.dart index d28aa39c..b89cf3cf 100644 --- a/packages/pinball_components/lib/src/components/android_bumper/behaviors/android_bumper_ball_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/android_bumper/behaviors/android_bumper_ball_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart b/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart index 3e75f890..61ad9e5a 100644 --- a/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart +++ b/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'android_bumper_state.dart'; diff --git a/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_state.dart b/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_state.dart index f101c3e9..a1177d23 100644 --- a/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_state.dart +++ b/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'android_bumper_cubit.dart'; enum AndroidBumperState { diff --git a/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart b/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart index c4cacc00..b3c721a1 100644 --- a/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart +++ b/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'dart:async'; import 'dart:math' as math; diff --git a/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart b/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart index 58a8b3c3..de5ed1ff 100644 --- a/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart +++ b/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_cubit.dart b/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_cubit.dart index ad9de251..334c9cc3 100644 --- a/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_cubit.dart +++ b/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'android_spaceship_state.dart'; diff --git a/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_state.dart b/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_state.dart index aae41c17..9375ebf2 100644 --- a/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_state.dart +++ b/packages/pinball_components/lib/src/components/android_spaceship/cubit/android_spaceship_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'android_spaceship_cubit.dart'; enum AndroidSpaceshipState { diff --git a/packages/pinball_components/lib/src/components/ball/cubit/ball_cubit.dart b/packages/pinball_components/lib/src/components/ball/cubit/ball_cubit.dart index e3054e33..7d5c7dda 100644 --- a/packages/pinball_components/lib/src/components/ball/cubit/ball_cubit.dart +++ b/packages/pinball_components/lib/src/components/ball/cubit/ball_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; import 'package:pinball_theme/pinball_theme.dart'; diff --git a/packages/pinball_components/lib/src/components/ball/cubit/ball_state.dart b/packages/pinball_components/lib/src/components/ball/cubit/ball_state.dart index 17a7aa9d..ea6009ab 100644 --- a/packages/pinball_components/lib/src/components/ball/cubit/ball_state.dart +++ b/packages/pinball_components/lib/src/components/ball/cubit/ball_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'ball_cubit.dart'; class BallState extends Equatable { diff --git a/packages/pinball_components/lib/src/components/board_background_sprite_component.dart b/packages/pinball_components/lib/src/components/board_background_sprite_component.dart index e42c2aca..f1e3354c 100644 --- a/packages/pinball_components/lib/src/components/board_background_sprite_component.dart +++ b/packages/pinball_components/lib/src/components/board_background_sprite_component.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/components.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/chrome_dino/chrome_dino.dart b/packages/pinball_components/lib/src/components/chrome_dino/chrome_dino.dart index b7358767..1de7b684 100644 --- a/packages/pinball_components/lib/src/components/chrome_dino/chrome_dino.dart +++ b/packages/pinball_components/lib/src/components/chrome_dino/chrome_dino.dart @@ -43,7 +43,6 @@ class ChromeDino extends BodyComponent required this.bloc, }); - // ignore: public_member_api_docs final ChromeDinoCubit bloc; /// Angle to rotate the dino up or down from the starting horizontal position. diff --git a/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_cubit.dart b/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_cubit.dart index 06e34199..551633e8 100644 --- a/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_cubit.dart +++ b/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; import 'package:pinball_components/pinball_components.dart'; diff --git a/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_state.dart b/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_state.dart index 8ed6fa8c..c96d7406 100644 --- a/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_state.dart +++ b/packages/pinball_components/lib/src/components/chrome_dino/cubit/chrome_dino_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'chrome_dino_cubit.dart'; enum ChromeDinoStatus { diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart index 829229e4..934adef6 100644 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart index 8fc6b157..04d511a4 100644 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'dash_nest_bumper_state.dart'; diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart index b203d1f3..d657c485 100644 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart @@ -98,7 +98,6 @@ class DashNestBumper extends BodyComponent with InitialPosition { final double _majorRadius; final double _minorRadius; - // ignore: public_member_api_docs final DashNestBumperCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/flapper/behaviors/flapper_spinning_behavior.dart b/packages/pinball_components/lib/src/components/flapper/behaviors/flapper_spinning_behavior.dart index 9a4e2a99..f6fea680 100644 --- a/packages/pinball_components/lib/src/components/flapper/behaviors/flapper_spinning_behavior.dart +++ b/packages/pinball_components/lib/src/components/flapper/behaviors/flapper_spinning_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; diff --git a/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart index c3f0423e..84a210ef 100644 --- a/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart index 9ef219ff..99b15702 100644 --- a/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart +++ b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'google_letter_state.dart'; diff --git a/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart index 1e5a29e8..12c7edd0 100644 --- a/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart +++ b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'google_letter_cubit.dart'; enum GoogleLetterState { diff --git a/packages/pinball_components/lib/src/components/google_letter/google_letter.dart b/packages/pinball_components/lib/src/components/google_letter/google_letter.dart index f447f6af..9d678e30 100644 --- a/packages/pinball_components/lib/src/components/google_letter/google_letter.dart +++ b/packages/pinball_components/lib/src/components/google_letter/google_letter.dart @@ -73,7 +73,6 @@ class GoogleLetter extends BodyComponent with InitialPosition { required this.bloc, }); - // ignore: public_member_api_docs final GoogleLetterCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/kicker/behaviors/kicker_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/kicker/behaviors/kicker_ball_contact_behavior.dart index d5d2eb6c..d05f61ae 100644 --- a/packages/pinball_components/lib/src/components/kicker/behaviors/kicker_ball_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/kicker/behaviors/kicker_ball_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/kicker/cubit/kicker_cubit.dart b/packages/pinball_components/lib/src/components/kicker/cubit/kicker_cubit.dart index 488f4683..23282a22 100644 --- a/packages/pinball_components/lib/src/components/kicker/cubit/kicker_cubit.dart +++ b/packages/pinball_components/lib/src/components/kicker/cubit/kicker_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'kicker_state.dart'; diff --git a/packages/pinball_components/lib/src/components/kicker/cubit/kicker_state.dart b/packages/pinball_components/lib/src/components/kicker/cubit/kicker_state.dart index 08d52709..590eb3dd 100644 --- a/packages/pinball_components/lib/src/components/kicker/cubit/kicker_state.dart +++ b/packages/pinball_components/lib/src/components/kicker/cubit/kicker_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'kicker_cubit.dart'; enum KickerState { diff --git a/packages/pinball_components/lib/src/components/kicker/kicker.dart b/packages/pinball_components/lib/src/components/kicker/kicker.dart index 7bddd9eb..611f6032 100644 --- a/packages/pinball_components/lib/src/components/kicker/kicker.dart +++ b/packages/pinball_components/lib/src/components/kicker/kicker.dart @@ -57,7 +57,6 @@ class Kicker extends BodyComponent with InitialPosition { required BoardSide side, }) : _side = side; - // ignore: public_member_api_docs final KickerCubit bloc; @override @@ -172,7 +171,6 @@ class _KickerSpriteGroupComponent extends SpriteGroupComponent @override Future onLoad() async { await super.onLoad(); - // ignore: public_member_api_docs parent.bloc.stream.listen((state) => current = state); final sprites = { diff --git a/packages/pinball_components/lib/src/components/layer_sensor/behaviors/layer_filtering_behavior.dart b/packages/pinball_components/lib/src/components/layer_sensor/behaviors/layer_filtering_behavior.dart index 06dca4b6..24148848 100644 --- a/packages/pinball_components/lib/src/components/layer_sensor/behaviors/layer_filtering_behavior.dart +++ b/packages/pinball_components/lib/src/components/layer_sensor/behaviors/layer_filtering_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/layer_sensor/layer_sensor.dart b/packages/pinball_components/lib/src/components/layer_sensor/layer_sensor.dart index 68e0f076..6e0807f6 100644 --- a/packages/pinball_components/lib/src/components/layer_sensor/layer_sensor.dart +++ b/packages/pinball_components/lib/src/components/layer_sensor/layer_sensor.dart @@ -1,5 +1,3 @@ -// ignore_for_file: avoid_renaming_method_parameters, public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_components/src/components/layer_sensor/behaviors/layer_filtering_behavior.dart'; diff --git a/packages/pinball_components/lib/src/components/multiball/cubit/multiball_cubit.dart b/packages/pinball_components/lib/src/components/multiball/cubit/multiball_cubit.dart index 9d943c9d..78e3aeb8 100644 --- a/packages/pinball_components/lib/src/components/multiball/cubit/multiball_cubit.dart +++ b/packages/pinball_components/lib/src/components/multiball/cubit/multiball_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; diff --git a/packages/pinball_components/lib/src/components/multiball/cubit/multiball_state.dart b/packages/pinball_components/lib/src/components/multiball/cubit/multiball_state.dart index bbc66fd5..d1ce03d0 100644 --- a/packages/pinball_components/lib/src/components/multiball/cubit/multiball_state.dart +++ b/packages/pinball_components/lib/src/components/multiball/cubit/multiball_state.dart @@ -1,8 +1,5 @@ -// ignore_for_file: comment_references, public_member_api_docs - part of 'multiball_cubit.dart'; -/// Indicates the different sprite states for [MultiballSpriteGroupComponent]. enum MultiballLightState { lit, dimmed, diff --git a/packages/pinball_components/lib/src/components/multiball/multiball.dart b/packages/pinball_components/lib/src/components/multiball/multiball.dart index 8f75a901..38150aea 100644 --- a/packages/pinball_components/lib/src/components/multiball/multiball.dart +++ b/packages/pinball_components/lib/src/components/multiball/multiball.dart @@ -80,7 +80,6 @@ class Multiball extends Component { required this.bloc, }); - // ignore: public_member_api_docs final MultiballCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart index 1d265b2e..370fc572 100644 --- a/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart +++ b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; import 'package:pinball_components/pinball_components.dart'; diff --git a/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart index e3adde70..4dc404b1 100644 --- a/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart +++ b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'multiplier_cubit.dart'; enum MultiplierSpriteState { diff --git a/packages/pinball_components/lib/src/components/multiplier/multiplier.dart b/packages/pinball_components/lib/src/components/multiplier/multiplier.dart index f749f912..64e64375 100644 --- a/packages/pinball_components/lib/src/components/multiplier/multiplier.dart +++ b/packages/pinball_components/lib/src/components/multiplier/multiplier.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/components.dart'; import 'package:flutter/material.dart'; import 'package:pinball_components/gen/assets.gen.dart'; diff --git a/packages/pinball_components/lib/src/components/score_component.dart b/packages/pinball_components/lib/src/components/score_component.dart index 5f95878a..0b9940aa 100644 --- a/packages/pinball_components/lib/src/components/score_component.dart +++ b/packages/pinball_components/lib/src/components/score_component.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'dart:async'; import 'package:flame/components.dart'; diff --git a/packages/pinball_components/lib/src/components/shapes/arc_shape.dart b/packages/pinball_components/lib/src/components/shapes/arc_shape.dart index 59519f0d..d58bdf1e 100644 --- a/packages/pinball_components/lib/src/components/shapes/arc_shape.dart +++ b/packages/pinball_components/lib/src/components/shapes/arc_shape.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:geometry/geometry.dart'; diff --git a/packages/pinball_components/lib/src/components/shapes/bezier_curve_shape.dart b/packages/pinball_components/lib/src/components/shapes/bezier_curve_shape.dart index 0b4e8fef..5fcf9e08 100644 --- a/packages/pinball_components/lib/src/components/shapes/bezier_curve_shape.dart +++ b/packages/pinball_components/lib/src/components/shapes/bezier_curve_shape.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/extensions.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:geometry/geometry.dart'; diff --git a/packages/pinball_components/lib/src/components/shapes/ellipse_shape.dart b/packages/pinball_components/lib/src/components/shapes/ellipse_shape.dart index 92898cad..488d3d6f 100644 --- a/packages/pinball_components/lib/src/components/shapes/ellipse_shape.dart +++ b/packages/pinball_components/lib/src/components/shapes/ellipse_shape.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/extensions.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:geometry/geometry.dart'; diff --git a/packages/pinball_components/lib/src/components/signpost/cubit/signpost_cubit.dart b/packages/pinball_components/lib/src/components/signpost/cubit/signpost_cubit.dart index f94feebe..dc5bce9c 100644 --- a/packages/pinball_components/lib/src/components/signpost/cubit/signpost_cubit.dart +++ b/packages/pinball_components/lib/src/components/signpost/cubit/signpost_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'signpost_state.dart'; diff --git a/packages/pinball_components/lib/src/components/signpost/cubit/signpost_state.dart b/packages/pinball_components/lib/src/components/signpost/cubit/signpost_state.dart index 72173bf1..3962207f 100644 --- a/packages/pinball_components/lib/src/components/signpost/cubit/signpost_state.dart +++ b/packages/pinball_components/lib/src/components/signpost/cubit/signpost_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'signpost_cubit.dart'; enum SignpostState { diff --git a/packages/pinball_components/lib/src/components/signpost/signpost.dart b/packages/pinball_components/lib/src/components/signpost/signpost.dart index a8fffe79..115f1845 100644 --- a/packages/pinball_components/lib/src/components/signpost/signpost.dart +++ b/packages/pinball_components/lib/src/components/signpost/signpost.dart @@ -41,7 +41,6 @@ class Signpost extends BodyComponent with InitialPosition { required this.bloc, }); - // ignore: public_member_api_docs final SignpostCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/skill_shot/behaviors/skill_shot_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/skill_shot/behaviors/skill_shot_ball_contact_behavior.dart index 62e4185f..0227acf9 100644 --- a/packages/pinball_components/lib/src/components/skill_shot/behaviors/skill_shot_ball_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/skill_shot/behaviors/skill_shot_ball_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; diff --git a/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_cubit.dart b/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_cubit.dart index b9491385..453b2706 100644 --- a/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_cubit.dart +++ b/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; diff --git a/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_state.dart b/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_state.dart index 1e040db6..a1fdd424 100644 --- a/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_state.dart +++ b/packages/pinball_components/lib/src/components/skill_shot/cubit/skill_shot_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'skill_shot_cubit.dart'; enum SkillShotSpriteState { diff --git a/packages/pinball_components/lib/src/components/skill_shot/skill_shot.dart b/packages/pinball_components/lib/src/components/skill_shot/skill_shot.dart index 3daed592..a3ea2af2 100644 --- a/packages/pinball_components/lib/src/components/skill_shot/skill_shot.dart +++ b/packages/pinball_components/lib/src/components/skill_shot/skill_shot.dart @@ -43,7 +43,6 @@ class SkillShot extends BodyComponent with ZIndex { required this.bloc, }); - // ignore: public_member_api_docs final SkillShotCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart b/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart index 2d0aad7c..57895c45 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_cubit.dart b/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_cubit.dart index d27a7a2c..c3dc9e3e 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_cubit.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_state.dart b/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_state.dart index 7fae894f..2979f05f 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_state.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'spaceship_ramp_cubit.dart'; class SpaceshipRampState extends Equatable { diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart b/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart index 8fb5200e..02095652 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart @@ -66,7 +66,6 @@ class SpaceshipRamp extends Component { required this.bloc, }) : super(); - // ignore: public_member_api_docs final SpaceshipRampCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart index 57db300c..bfdba4a0 100644 --- a/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart index 2f7ba7c4..980aea43 100644 --- a/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart +++ b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'sparky_bumper_state.dart'; diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart index 096af299..423d977c 100644 --- a/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart +++ b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'sparky_bumper_cubit.dart'; enum SparkyBumperState { diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart b/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart index c4cb672a..b0e1b0c8 100644 --- a/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart +++ b/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart @@ -102,7 +102,6 @@ class SparkyBumper extends BodyComponent with InitialPosition, ZIndex { final double _majorRadius; final double _minorRadius; - // ignore: public_member_api_docs final SparkyBumperCubit bloc; @override @@ -148,7 +147,6 @@ class _SparkyBumperSpriteGroupComponent @override Future onLoad() async { await super.onLoad(); - // ignore: public_member_api_docs parent.bloc.stream.listen((state) => current = state); final sprites = { diff --git a/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_cubit.dart b/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_cubit.dart index e86defcd..49948961 100644 --- a/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_cubit.dart +++ b/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_cubit.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; part 'sparky_computer_state.dart'; diff --git a/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_state.dart b/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_state.dart index 372f1d15..0d5713b1 100644 --- a/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_state.dart +++ b/packages/pinball_components/lib/src/components/sparky_computer/cubit/sparky_computer_state.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - part of 'sparky_computer_cubit.dart'; enum SparkyComputerState { diff --git a/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart b/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart index c96e3f45..c96c5007 100644 --- a/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart +++ b/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart @@ -37,7 +37,6 @@ class SparkyComputer extends BodyComponent { Iterable? children, }) : super(children: children); - // ignore: public_member_api_docs final SparkyComputerCubit bloc; @override diff --git a/packages/pinball_components/lib/src/components/z_indexes.dart b/packages/pinball_components/lib/src/components/z_indexes.dart index e9fb68c9..2fbcc3af 100644 --- a/packages/pinball_components/lib/src/components/z_indexes.dart +++ b/packages/pinball_components/lib/src/components/z_indexes.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - /// Z-Indexes for the component rendering order in the pinball game. abstract class ZIndexes { static const _base = 0; diff --git a/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart b/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart index b6b99f32..52e196dc 100644 --- a/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart +++ b/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart @@ -44,7 +44,6 @@ void main() { expect(game.contains(androidBumper), isTrue); }); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockAndroidBumperCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart b/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart index 7e456a47..fff69b0a 100644 --- a/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart +++ b/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart @@ -70,7 +70,6 @@ void main() { }, ); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockAndroidSpaceshipCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/chrome_dino/chrome_dino_test.dart b/packages/pinball_components/test/src/components/chrome_dino/chrome_dino_test.dart index 603f6ca0..a2e1c933 100644 --- a/packages/pinball_components/test/src/components/chrome_dino/chrome_dino_test.dart +++ b/packages/pinball_components/test/src/components/chrome_dino/chrome_dino_test.dart @@ -71,7 +71,6 @@ void main() { }, ); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockChromeDinoCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart b/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart index 0ee1d6b9..baf2132f 100644 --- a/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart +++ b/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart @@ -46,7 +46,6 @@ void main() { expect(game.contains(bumper), isTrue); }); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockDashNestBumperCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart b/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart index 3a459ddb..1ef5e7a7 100644 --- a/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart +++ b/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart @@ -102,7 +102,6 @@ void main() { expect(() => GoogleLetter(6), throwsA(isA())); }); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockGoogleLetterCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/kicker_test.dart b/packages/pinball_components/test/src/components/kicker_test.dart index c91046ba..e347032a 100644 --- a/packages/pinball_components/test/src/components/kicker_test.dart +++ b/packages/pinball_components/test/src/components/kicker_test.dart @@ -61,7 +61,6 @@ void main() { }, ); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockKickerCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/skill_shot/skill_shot_test.dart b/packages/pinball_components/test/src/components/skill_shot/skill_shot_test.dart index 4ec42a4b..beb159b8 100644 --- a/packages/pinball_components/test/src/components/skill_shot/skill_shot_test.dart +++ b/packages/pinball_components/test/src/components/skill_shot/skill_shot_test.dart @@ -29,7 +29,6 @@ void main() { expect(game.contains(skillShot), isTrue); }); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockSkillShotCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart b/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart index 65f0c647..45c55790 100644 --- a/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart +++ b/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart @@ -44,7 +44,6 @@ void main() { expect(game.contains(sparkyBumper), isTrue); }); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockSparkyBumperCubit(); whenListen( diff --git a/packages/pinball_components/test/src/components/sparky_computer/sparky_computer_test.dart b/packages/pinball_components/test/src/components/sparky_computer/sparky_computer_test.dart index dcbccd3e..d15f8056 100644 --- a/packages/pinball_components/test/src/components/sparky_computer/sparky_computer_test.dart +++ b/packages/pinball_components/test/src/components/sparky_computer/sparky_computer_test.dart @@ -47,7 +47,6 @@ void main() { }, ); - // ignore: public_member_api_docs flameTester.test('closes bloc when removed', (game) async { final bloc = _MockSparkyComputerCubit(); whenListen( diff --git a/packages/pinball_flame/lib/src/canvas/canvas_wrapper.dart b/packages/pinball_flame/lib/src/canvas/canvas_wrapper.dart index 883527d2..3abe8c1c 100644 --- a/packages/pinball_flame/lib/src/canvas/canvas_wrapper.dart +++ b/packages/pinball_flame/lib/src/canvas/canvas_wrapper.dart @@ -1,9 +1,11 @@ -// ignore_for_file: public_member_api_docs - import 'dart:typed_data'; import 'dart:ui'; +/// {@template canvas_wrapper} +/// Custom [Canvas] implementation for Pinball +/// {@endtemplate} class CanvasWrapper implements Canvas { + /// [Canvas] used for painting operations late Canvas canvas; @override diff --git a/packages/pinball_flame/lib/src/flame_provider.dart b/packages/pinball_flame/lib/src/flame_provider.dart index 85a1004c..dcc6a5ae 100644 --- a/packages/pinball_flame/lib/src/flame_provider.dart +++ b/packages/pinball_flame/lib/src/flame_provider.dart @@ -1,21 +1,28 @@ -// ignore_for_file: public_member_api_docs - import 'package:bloc/bloc.dart'; import 'package:flame/components.dart'; import 'package:flame_bloc/flame_bloc.dart'; +/// {@template flame_provider} +/// Provider-style component, similar to Provider in Flutter, but used to +/// retrieve [Component] objects previously provided +/// {@endtemplate} class FlameProvider extends Component { + //// {@macro flame_provider} FlameProvider.value( this.provider, { Iterable? children, - }) : super( - children: children, - ); + }) : super(children: children); + /// The object that needs to be provided final T provider; } +//// {@template multi_flame_provider} +/// MultiProvider-style component, similar to MultiProvider in Flutter, +/// but used to retrieve more than one [Component] object previously provided +/// {@endtemplate} class MultiFlameProvider extends Component { + /// {@macro multi_flame_provider} MultiFlameProvider({ required List> providers, Iterable? children, @@ -54,7 +61,9 @@ class MultiFlameProvider extends Component { } } +/// Extended API on [Component] extension ReadFlameProvider on Component { + /// Retrieve an object of type [T] that was previously provided T readProvider() { final providers = ancestors().whereType>(); assert( @@ -64,9 +73,8 @@ extension ReadFlameProvider on Component { return providers.first.provider; } -} -extension ReadFlameBlocProvider on Component { + /// Retrieve a bloc [B] with state [S] previously provided B readBloc, S>() { final providers = ancestors().whereType>(); assert( diff --git a/packages/pinball_flame/lib/src/sprite_animation.dart b/packages/pinball_flame/lib/src/sprite_animation.dart index de39849f..60fd1c8b 100644 --- a/packages/pinball_flame/lib/src/sprite_animation.dart +++ b/packages/pinball_flame/lib/src/sprite_animation.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'dart:math'; import 'package:flame/components.dart'; @@ -20,6 +18,7 @@ class SpriteAnimationWidget extends StatelessWidget { /// The positioning [Anchor]. final Anchor anchor; + /// Controller in charge of the sprite animations final SpriteAnimationController controller; @override @@ -38,7 +37,11 @@ class SpriteAnimationWidget extends StatelessWidget { } } +/// {@template sprite_animation_controller} +/// Custom [AnimationController] that manages sprite assets +/// {@endtemplate} class SpriteAnimationController extends AnimationController { + /// {@macro sprite_animation_controller} SpriteAnimationController({ required TickerProvider vsync, required this.animation, @@ -46,6 +49,7 @@ class SpriteAnimationController extends AnimationController { duration = Duration(seconds: animation.totalDuration().ceil()); } + /// [SpriteAnimation] associated to this controller final SpriteAnimation animation; double? _lastUpdated; @@ -61,7 +65,11 @@ class SpriteAnimationController extends AnimationController { } } +/// {@template sprite_painter} +/// [CustomPainter] specialized in [Sprite] assets. +/// {@endtemplate} class SpritePainter extends CustomPainter { + /// {@macro sprite_painter} SpritePainter( this._sprite, this._anchor, { diff --git a/packages/pinball_ui/lib/src/theme/pinball_colors.dart b/packages/pinball_ui/lib/src/theme/pinball_colors.dart index d6029422..eb920129 100644 --- a/packages/pinball_ui/lib/src/theme/pinball_colors.dart +++ b/packages/pinball_ui/lib/src/theme/pinball_colors.dart @@ -1,17 +1,40 @@ -// ignore_for_file: public_member_api_docs import 'package:flutter/material.dart'; +/// Colors used in the application abstract class PinballColors { + /// Color: 0xFFFFFFFF static const Color white = Color(0xFFFFFFFF); + + /// Color: 0xFF0C32A4 static const Color darkBlue = Color(0xFF0C32A4); + + /// Color: 0xFFFFEE02 static const Color yellow = Color(0xFFFFEE02); + + /// Color: 0xFFE5AB05 static const Color orange = Color(0xFFE5AB05); + + /// Color: 0xFFF03939 static const Color red = Color(0xFFF03939); + + /// Color: 0xFF4B94F6 static const Color blue = Color(0xFF4B94F6); + + /// Color: 0x00000000 static const Color transparent = Color(0x00000000); + + /// Color: 0xFFE33B2D static const Color loadingDarkRed = Color(0xFFE33B2D); + + /// Color: 0xFFEC5E2B static const Color loadingLightRed = Color(0xFFEC5E2B); + + /// Color: 0xFF4087F8 static const Color loadingDarkBlue = Color(0xFF4087F8); + + /// Color: 0xFF6CCAE4 static const Color loadingLightBlue = Color(0xFF6CCAE4); + + /// Color: 0xFF274E54 static const Color crtBackground = Color(0xFF274E54); } diff --git a/packages/pinball_ui/lib/src/theme/pinball_text_style.dart b/packages/pinball_ui/lib/src/theme/pinball_text_style.dart index 18968680..8319fc1c 100644 --- a/packages/pinball_ui/lib/src/theme/pinball_text_style.dart +++ b/packages/pinball_ui/lib/src/theme/pinball_text_style.dart @@ -1,5 +1,3 @@ -// ignore_for_file: public_member_api_docs - import 'package:flutter/widgets.dart'; import 'package:pinball_ui/gen/fonts.gen.dart'; import 'package:pinball_ui/pinball_ui.dart'; @@ -7,7 +5,9 @@ import 'package:pinball_ui/pinball_ui.dart'; const _fontPackage = 'pinball_components'; const _primaryFontFamily = FontFamily.pixeloidSans; +/// Different [TextStyle] used in the game abstract class PinballTextStyle { + /// Font size: 28 | Color: white static const headline1 = TextStyle( fontSize: 28, package: _fontPackage, @@ -15,6 +15,7 @@ abstract class PinballTextStyle { color: PinballColors.white, ); + /// Font size: 24 | Color: white static const headline2 = TextStyle( fontSize: 24, package: _fontPackage, @@ -22,6 +23,7 @@ abstract class PinballTextStyle { color: PinballColors.white, ); + /// Font size: 20 | Color: darkBlue static const headline3 = TextStyle( color: PinballColors.darkBlue, fontSize: 20, @@ -30,6 +32,7 @@ abstract class PinballTextStyle { fontWeight: FontWeight.bold, ); + /// Font size: 16 | Color: white static const headline4 = TextStyle( color: PinballColors.white, fontSize: 16, @@ -37,6 +40,7 @@ abstract class PinballTextStyle { fontFamily: _primaryFontFamily, ); + /// Font size: 214| Color: white static const headline5 = TextStyle( color: PinballColors.white, fontSize: 14, @@ -44,13 +48,7 @@ abstract class PinballTextStyle { fontFamily: _primaryFontFamily, ); - static const subtitle2 = TextStyle( - color: PinballColors.white, - fontSize: 16, - package: _fontPackage, - fontFamily: _primaryFontFamily, - ); - + /// Font size: 12 | Color: white static const subtitle1 = TextStyle( fontSize: 12, fontFamily: _primaryFontFamily, diff --git a/packages/pinball_ui/lib/src/theme/pinball_theme.dart b/packages/pinball_ui/lib/src/theme/pinball_theme.dart index 43322391..cc08ec9d 100644 --- a/packages/pinball_ui/lib/src/theme/pinball_theme.dart +++ b/packages/pinball_ui/lib/src/theme/pinball_theme.dart @@ -18,7 +18,6 @@ class PinballTheme { headline4: PinballTextStyle.headline4, headline5: PinballTextStyle.headline5, subtitle1: PinballTextStyle.subtitle1, - subtitle2: PinballTextStyle.subtitle2, ); } } diff --git a/packages/pinball_ui/test/src/theme/pinball_text_style_test.dart b/packages/pinball_ui/test/src/theme/pinball_text_style_test.dart index 72cd66a6..ed1f1cb6 100644 --- a/packages/pinball_ui/test/src/theme/pinball_text_style_test.dart +++ b/packages/pinball_ui/test/src/theme/pinball_text_style_test.dart @@ -31,11 +31,5 @@ void main() { expect(style.fontSize, 12); expect(style.color, PinballColors.yellow); }); - - test('subtitle2 has fontSize 16 and white color', () { - const style = PinballTextStyle.subtitle2; - expect(style.fontSize, 16); - expect(style.color, PinballColors.white); - }); }); } diff --git a/packages/pinball_ui/test/src/theme/pinball_theme_test.dart b/packages/pinball_ui/test/src/theme/pinball_theme_test.dart index 915927f8..7eda2c1d 100644 --- a/packages/pinball_ui/test/src/theme/pinball_theme_test.dart +++ b/packages/pinball_ui/test/src/theme/pinball_theme_test.dart @@ -78,21 +78,6 @@ void main() { PinballTextStyle.subtitle1.fontFamily, ); }); - - test('subtitle2 matches PinballTextStyle#subtitle2', () { - expect( - PinballTheme.standard.textTheme.subtitle2!.fontSize, - PinballTextStyle.subtitle2.fontSize, - ); - expect( - PinballTheme.standard.textTheme.subtitle2!.color, - PinballTextStyle.subtitle2.color, - ); - expect( - PinballTheme.standard.textTheme.subtitle2!.fontFamily, - PinballTextStyle.subtitle2.fontFamily, - ); - }); }); }); }