From d91bb9c6c48139ddea87a4a891fe9036d94df91a Mon Sep 17 00:00:00 2001
From: alestiago <dev@alestiago.com>
Date: Wed, 27 Apr 2022 15:36:34 +0100
Subject: [PATCH] refactor: ignore public_member_api_docs for cubits

---
 .../components/alien_bumper/cubit/alien_bumper_cubit.dart | 8 ++------
 .../google_letter/cubit/google_letter_cubit.dart          | 8 ++------
 .../sparky_bumper/cubit/sparky_bumper_cubit.dart          | 8 ++------
 3 files changed, 6 insertions(+), 18 deletions(-)

diff --git a/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart b/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart
index 82478e10..d4319a3b 100644
--- a/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart
+++ b/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart
@@ -1,20 +1,16 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:bloc/bloc.dart';
 
 part 'alien_bumper_state.dart';
 
-// TODO(alestiago): Evaluate if there is any useful documentation that could
-// be added to this class.
-// ignore: public_member_api_docs
 class AlienBumperCubit extends Cubit<AlienBumperState> {
-  // ignore: public_member_api_docs
   AlienBumperCubit() : super(AlienBumperState.active);
 
-  /// Event added when the bumper contacts with a ball.
   void onBallContacted() {
     emit(AlienBumperState.inactive);
   }
 
-  /// Event added when the bumper finishes blinking.
   void onBlinked() {
     emit(AlienBumperState.active);
   }
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 79b3d6cc..a352e98d 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,20 +1,16 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:bloc/bloc.dart';
 
 part 'google_letter_state.dart';
 
-// TODO(alestiago): Evaluate if there is any useful documentation that could
-// be added to this class.
-// ignore: public_member_api_docs
 class GoogleLetterCubit extends Cubit<GoogleLetterState> {
-  // ignore: public_member_api_docs
   GoogleLetterCubit() : super(GoogleLetterState.inactive);
 
-  /// Event added when the letter contacts with a ball.
   void onBallContacted() {
     emit(GoogleLetterState.active);
   }
 
-  /// Event added when the letter should return to its initial configuration.
   void onReset() {
     emit(GoogleLetterState.inactive);
   }
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 183dc0ce..bbb9b63b 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,20 +1,16 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:bloc/bloc.dart';
 
 part 'sparky_bumper_state.dart';
 
-// TODO(alestiago): Evaluate if there is any useful documentation that could
-// be added to this class.
-// ignore: public_member_api_docs
 class SparkyBumperCubit extends Cubit<SparkyBumperState> {
-  // ignore: public_member_api_docs
   SparkyBumperCubit() : super(SparkyBumperState.active);
 
-  /// Event added when the bumper contacts with a ball.
   void onBallContacted() {
     emit(SparkyBumperState.inactive);
   }
 
-  /// Event added when the bumper finishes blinking.
   void onBlinked() {
     emit(SparkyBumperState.active);
   }