Fix documentation

lib/commons/box_decorations.dart

@@ -1,5 +1,8 @@
 import 'package:flutter/material.dart';
 
+/*
+ * These are generic methods, predefined to be able to used by whole app
+ */
 mixin BoxDecorations {
   static BoxDecoration circle(Color backgroundColor, [double width = 1]) {
     return BoxDecoration(

lib/commons/text_styles.dart

@@ -1,5 +1,8 @@
 import 'package:flutter/material.dart';
 
+/*
+ * These are generic methods, predefined to be able to used by whole app
+ */
 mixin TextStyles {
   static TextStyle weak() {
     return TextStyle(

lib/screens/speed_prototyping.dart

@@ -12,6 +12,10 @@ import 'package:bstevr_assessment/widgets/custom_app_bar.dart';
 import 'package:bstevr_assessment/widgets/custom_navigation_bar.dart';
 
 class SpeedPrototyping extends StatelessWidget {
+  /*
+   * The props, meaning these are not gonna change
+   * during lifetime of the component
+   */
   final List<dynamic> quickActionsEntries;
   final List<dynamic> favoriteScenesEntries;
   final List<dynamic> favoriteAccessoriesEntries;
@@ -25,6 +29,10 @@ class SpeedPrototyping extends StatelessWidget {
         bottomNavigationBarItems = getBottomNavigationBarItems(),
         super(key: key);
 
+  /*
+   * The rendering method, in which the component tells
+   * how it should show itself
+   */
   @override
   Widget build(BuildContext context) {
     return Container(

lib/utilities/custom_audio_player.dart

@@ -1,9 +1,12 @@
+/*
+ * These are the external dependencies
+ */
 import 'package:just_audio/just_audio.dart';
 
 /*
  * Singleton pattern is used for AudioPlayer instance,
  * because we don't need instances more than one and
- * we can access from anywhere across our application
+ * we can access from anywhere across our app
  */
 class CustomAudioPlayer {
   CustomAudioPlayer._privateConstructor();

lib/utilities/helper_methods.dart

@@ -5,6 +5,9 @@ import 'package:flutter/material.dart';
  */
 import 'package:bstevr_assessment/models/icon_entry.dart';
 
+/*
+ * These are helper logics potentially be used across whole project
+ */
 String getTimePassed(DateTime date) {
   Duration difference = DateTime.now().difference(date);
 

lib/widgets/circle_card.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 /*
- * These are the internal dependencies for the widget below
+ * These are the internal dependencies
  */
 import 'package:bstevr_assessment/commons/text_styles.dart';
 import 'package:bstevr_assessment/commons/box_decorations.dart';
@@ -34,11 +34,6 @@ class CircleCard extends StatefulWidget {
 }
 
 class _CircleCardState extends State<CircleCard> {
-  /*
-   * The state, basically data that changes over time
-   */
-  late bool _selected;
-
   /*
    * This is initializing logic
    */
@@ -48,6 +43,11 @@ class _CircleCardState extends State<CircleCard> {
     super.initState();
   }
 
+  /*
+   * The state, basically data that changes over time
+   */
+  late bool _selected;
+
   /*
    * These are inner logics that will change the state of the component
    */

lib/widgets/coin_card.dart

@@ -42,7 +42,7 @@ class _CoinCardState extends State<CoinCard> with TickerProviderStateMixin {
   late Animation<Offset> _animation;
 
   /*
-   * These are initializing and disposing logics
+   * These is initializing logic
    */
   @override
   void initState() {
@@ -63,6 +63,9 @@ class _CoinCardState extends State<CoinCard> with TickerProviderStateMixin {
     ));
   }
 
+  /*
+   * These is disposing logic
+   */
   @override
   void dispose() {
     _timer.cancel();

lib/widgets/loading_bar.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 /*
- * These are the internal dependencies for the widget below
+ * These are the internal dependencies
  */
 import 'package:bstevr_assessment/commons/text_styles.dart';
 

lib/widgets/quick_actions.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 /*
- * These are the internal dependencies for the widget below
+ * These are the internal dependencies
  */
 import 'package:bstevr_assessment/widgets/circle_card.dart';
 

lib/widgets/rectangle_card.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 /*
- * These are the internal dependencies for the widget below
+ * These are the internal dependencies
  */
 import 'package:bstevr_assessment/commons/text_styles.dart';
 import 'package:bstevr_assessment/commons/box_decorations.dart';
@@ -38,11 +38,6 @@ class RectangleCard extends StatefulWidget {
 }
 
 class _RectangleCardState extends State<RectangleCard> {
-  /*
-   * The state, basically data that changes over time
-   */
-  late bool _selected;
-
   /*
    * This is initializing logic
    */
@@ -53,7 +48,12 @@ class _RectangleCardState extends State<RectangleCard> {
   }
 
   /*
-   * These are inner logic that will change the state of the component
+   * The state, basically data that changes over time
+   */
+  late bool _selected;
+
+  /*
+   * These are inner logics that will change the state of the component
    */
   void _toggleButton() {
     setState(() {

lib/widgets/selectable_cards.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 /*
- * These are the internal dependencies for the widget below
+ * These are the internal dependencies
  */
 import 'package:bstevr_assessment/widgets/rectangle_card.dart';