fix: update descriptions

lib/game/view/widgets/pinball_button.dart

@@ -1,6 +1,8 @@
 import 'package:flutter/material.dart';
 import 'package:pinball/gen/gen.dart';
 
+// TODO(arturplaczek): move PinballButton to pinball_ui
+
 /// {@template pinball_button}
 /// Pinball button with onPressed [VoidCallback] and child [Widget].
 /// {@endtemplate}
@@ -8,20 +10,19 @@ class PinballButton extends StatelessWidget {
   /// {@macro pinball_button}
   const PinballButton({
     Key? key,
-    required this.child,
+    required Widget child,
-    this.onPressed,
+    VoidCallback? onPressed,
-  }) : super(key: key);
+  })  : _child = child,
-
+        _onPressed = onPressed,
-  /// Child displayed on button.
+        super(key: key);
-  final Widget child;
 
-  /// On pressed callback used for user integration.
+  final Widget _child;
-  final VoidCallback? onPressed;
+  final VoidCallback? _onPressed;
 
   @override
   Widget build(BuildContext context) {
     return InkWell(
-      onTap: onPressed,
+      onTap: _onPressed,
       child: DecoratedBox(
         decoration: BoxDecoration(
           image: DecorationImage(
@@ -36,7 +37,7 @@ class PinballButton extends StatelessWidget {
               horizontal: 32,
               vertical: 16,
             ),
-            child: child,
+            child: _child,
           ),
         ),
       ),

lib/game/view/widgets/widgets.dart

@@ -1,5 +1,6 @@
 export 'bonus_animation.dart';
 export 'game_hud.dart';
+export 'pinball_button.dart';
 export 'play_button_overlay.dart';
 export 'round_count_display.dart';
 export 'score_view.dart';

lib/select_character/widgets/character_icon.dart

@@ -1,17 +1,23 @@
-// ignore_for_file: public_member_api_docs
-
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:pinball/select_character/select_character.dart';
 import 'package:pinball_theme/pinball_theme.dart' hide Assets;
 
+/// {@template character_icon}
+/// Widget for displaying character icon.
+///
+/// On tap changes selected character in [CharacterThemeCubit].
+/// {@endtemplate}
 class CharacterIcon extends StatelessWidget {
+  /// {@macro character_icon}
+
   const CharacterIcon(
-    this.characterTheme, {
+    CharacterTheme characterTheme, {
     Key? key,
-  }) : super(key: key);
+  })  : _characterTheme = characterTheme,
+        super(key: key);
 
-  final CharacterTheme characterTheme;
+  final CharacterTheme _characterTheme;
 
   @override
   Widget build(BuildContext context) {
@@ -21,13 +27,14 @@ class CharacterIcon extends StatelessWidget {
     );
 
     return GestureDetector(
-      onTap: () =>
+      onTap: () => context
-          context.read<CharacterThemeCubit>().characterSelected(characterTheme),
+          .read<CharacterThemeCubit>()
+          .characterSelected(_characterTheme),
       child: Opacity(
-        opacity: currentCharacterTheme == characterTheme ? 1 : 0.5,
+        opacity: currentCharacterTheme == _characterTheme ? 1 : 0.5,
         child: Padding(
           padding: const EdgeInsets.all(8),
-          child: characterTheme.icon.image(
+          child: _characterTheme.icon.image(
             fit: BoxFit.contain,
           ),
         ),

lib/select_character/widgets/selected_character.dart

@@ -1,5 +1,3 @@
-// ignore_for_file: public_member_api_docs
-
 import 'package:flame/flame.dart';
 import 'package:flame/sprite.dart';
 import 'package:flutter/material.dart' hide Image;
@@ -9,7 +7,14 @@ import 'package:pinball/theme/theme.dart';
 import 'package:pinball_flame/pinball_flame.dart';
 import 'package:pinball_theme/pinball_theme.dart';
 
+/// {@template selected_character}
+/// Widget to display the selected character based on the [CharacterThemeCubit]
+/// state.
+///
+/// Displays a looped [SpriteAnimationWidget].
+/// {@endtemplate}
 class SelectedCharacter extends StatefulWidget {
+  /// {@macro selected_character}
   const SelectedCharacter({
     Key? key,
   }) : super(key: key);
@@ -17,6 +22,7 @@ class SelectedCharacter extends StatefulWidget {
   @override
   State<SelectedCharacter> createState() => _SelectedCharacterState();
 
+  /// Returns a list of assets to be loaded
   static List<Future> loadAssets() {
     Flame.images.prefix = '';
 

lib/select_character/widgets/star_animation.dart

@@ -1,20 +1,28 @@
-// ignore_for_file: public_member_api_docs
-
 import 'package:flame/flame.dart';
 import 'package:flame/sprite.dart';
 import 'package:flame/widgets.dart';
 import 'package:flutter/material.dart' hide Image;
 import 'package:pinball/gen/gen.dart';
 
+/// {@template star_animation}
+/// Widget to display a looped the star animation.
+///
+/// For animation is using [SpriteAnimationWidget].
+/// {@endtemplate}
 class StarAnimation extends StatelessWidget {
   const StarAnimation._({
     Key? key,
-    required this.imagePath,
+    required String imagePath,
-    required this.columns,
+    required int columns,
-    required this.rows,
+    required int rows,
-    required this.stepTime,
+    required double stepTime,
-  }) : super(key: key);
+  })  : _imagePath = imagePath,
+        _columns = columns,
+        _rows = rows,
+        _stepTime = stepTime,
+        super(key: key);
 
+  /// [Widget] that displays the star A animation.
   StarAnimation.starA({
     Key? key,
   }) : this._(
@@ -25,6 +33,7 @@ class StarAnimation extends StatelessWidget {
           stepTime: 1 / 18,
         );
 
+  /// [Widget] that displays the star B animation.
   StarAnimation.starB({
     Key? key,
   }) : this._(
@@ -35,6 +44,7 @@ class StarAnimation extends StatelessWidget {
           stepTime: 1 / 36,
         );
 
+  /// [Widget] that displays the star C animation.
   StarAnimation.starC({
     Key? key,
   }) : this._(
@@ -45,11 +55,12 @@ class StarAnimation extends StatelessWidget {
           stepTime: 1 / 24,
         );
 
-  final String imagePath;
+  final String _imagePath;
-  final int columns;
+  final int _columns;
-  final int rows;
+  final int _rows;
-  final double stepTime;
+  final double _stepTime;
 
+  /// Returns a list of assets to be loaded
   static Future<void> loadAssets() {
     Flame.images.prefix = '';
 
@@ -63,13 +74,13 @@ class StarAnimation extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     final spriteSheet = SpriteSheet.fromColumnsAndRows(
-      image: Flame.images.fromCache(imagePath),
+      image: Flame.images.fromCache(_imagePath),
-      columns: columns,
+      columns: _columns,
-      rows: rows,
+      rows: _rows,
     );
     final animation = spriteSheet.createAnimation(
       row: 0,
-      stepTime: stepTime,
+      stepTime: _stepTime,
       to: spriteSheet.rows * spriteSheet.columns,
     );