improve docs

lib/month_picker_dialog.dart

@@ -1,4 +1,4 @@
-// Copyright 2023 Gianluca & Lorenzo. All rights reserved.
+// Copyright 2024 Gianluca & Lorenzo. All rights reserved.
 // Use of this source code is governed by a license that can be
 // found in the LICENSE file.
 

lib/src/month_picker_dialog.dart

@@ -1,6 +1,8 @@
 import 'package:flutter/material.dart';
 import '/month_picker_dialog.dart';
 
+///The main dialog widget class.
+///It needs a `MonthpickerController` controller to be created.
 class MonthPickerDialog extends StatefulWidget {
   const MonthPickerDialog({required this.controller});
   final MonthpickerController controller;
@@ -121,6 +123,7 @@ class MonthPickerDialogState extends State<MonthPickerDialog> {
     );
   }
 
+  ///Function to change the grid to the year selector.
   void _onSelectYear() => setState(
         () => _selector = YearSelector(
           key: widget.controller.yearSelectorState,
@@ -129,6 +132,7 @@ class MonthPickerDialogState extends State<MonthPickerDialog> {
         ),
       );
 
+  ///Function to be executed when a year is selected.
   void _onYearSelected(final int year) {
     setState(
       () {
@@ -142,6 +146,7 @@ class MonthPickerDialogState extends State<MonthPickerDialog> {
     );
   }
 
+  ///Function to be executed when a month is selected.
   void _onMonthSelected(final DateTime date) => setState(
         () {
           widget.controller.selectedDate = date;

lib/src/month_picker_widgets/button_bar.dart

@@ -1,6 +1,7 @@
 import 'package:flutter/material.dart';
 import '/month_picker_dialog.dart';
 
+///The actions button bar. Where confirmation and cancel button are.
 class PickerButtonBar extends StatelessWidget {
   const PickerButtonBar({
     super.key,

lib/src/month_picker_widgets/header/header.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 
 import '/month_picker_dialog.dart';
 
+///The widget that will hold all of the Header widgets.
 class PickerHeader extends StatelessWidget {
   const PickerHeader({
     super.key,

lib/src/month_picker_widgets/header/header_arrows.dart

@@ -1,5 +1,6 @@
 import 'package:flutter/material.dart';
 
+///The arrows that are used on the header to change between the pages of the grid.
 class HeaderArrows extends StatelessWidget {
   const HeaderArrows({
     super.key,

lib/src/month_picker_widgets/header/header_row.dart

@@ -3,6 +3,7 @@ import 'package:intl/intl.dart';
 import 'package:provider/provider.dart';
 import '/month_picker_dialog.dart';
 
+///The main part of the header. Where arrows and current interval are presented.
 class HeaderRow extends StatelessWidget {
   const HeaderRow({
     super.key,

lib/src/month_picker_widgets/header/header_selected_date.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:intl/intl.dart';
 import '/month_picker_dialog.dart';
 
+///The widget that presents the current selected date on the header.
 class HeaderSelectedDate extends StatelessWidget {
   const HeaderSelectedDate({
     super.key,

lib/src/month_picker_widgets/pager.dart

@@ -11,6 +11,7 @@ class PickerPager extends StatelessWidget {
   final Widget selector;
   final ThemeData theme;
   final MonthpickerController controller;
+
   @override
   Widget build(BuildContext context) {
     return SizedBox(

lib/src/month_selector/month_button.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:intl/intl.dart';
 import '/month_picker_dialog.dart';
 
+///The button to be used on the grid of months.
 class MonthButton extends StatelessWidget {
   const MonthButton({
     super.key,

lib/src/month_selector/month_selector.dart

@@ -3,6 +3,7 @@ import 'package:provider/provider.dart';
 
 import '/month_picker_dialog.dart';
 
+///The widget that will hold the month grid selector.
 class MonthSelector extends StatefulWidget {
   const MonthSelector({
     super.key,
@@ -36,6 +37,7 @@ class MonthSelectorState extends State<MonthSelector> {
     );
   }
 
+  ///Function to check if the page has reached the limit of the month list.
   void _onPageChange(final int page) {
     _blocked =
         !(page - 1 > 0 && page + 1 < widget.controller.monthPageCount - 1);
@@ -56,6 +58,7 @@ class MonthSelectorState extends State<MonthSelector> {
     initialize();
   }
 
+  ///Function to go to the next page of the grid.
   void goDown() {
     widget.controller.monthPageController?.animateToPage(
       widget.controller.monthPageController!.page!.toInt() + 1,
@@ -64,6 +67,7 @@ class MonthSelectorState extends State<MonthSelector> {
     );
   }
 
+  ///Function to go to the previous page of the grid.
   void goUp() {
     widget.controller.monthPageController?.animateToPage(
       widget.controller.monthPageController!.page!.toInt() - 1,
@@ -72,6 +76,7 @@ class MonthSelectorState extends State<MonthSelector> {
     );
   }
 
+  ///Function to initialize the grid.
   void initialize() {
     widget.controller.monthPageController = PageController(
       initialPage: widget.controller.localFirstDate == null

lib/src/month_selector/month_year_grid.dart

@@ -1,6 +1,7 @@
 import 'package:flutter/material.dart';
 import '/month_picker_dialog.dart';
 
+///The month grid. It has all of the avaliable options to be selected.
 class MonthYearGridBuilder extends StatelessWidget {
   const MonthYearGridBuilder({
     super.key,

lib/src/year_selector/year_button.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:intl/intl.dart';
 import '/month_picker_dialog.dart';
 
+///The button to be used on the grid of years.
 class YearButton extends StatelessWidget {
   const YearButton({
     super.key,

lib/src/year_selector/year_grid.dart

@@ -1,6 +1,7 @@
 import 'package:flutter/material.dart';
 import '/month_picker_dialog.dart';
 
+///The year grid. It has all of the avaliable options to be selected.
 class YearGrid extends StatelessWidget {
   const YearGrid({
     super.key,

lib/src/year_selector/year_selector.dart

@@ -3,6 +3,7 @@ import 'package:provider/provider.dart';
 
 import '/month_picker_dialog.dart';
 
+///The widget that will hold the year grid selector.
 class YearSelector extends StatefulWidget {
   const YearSelector({
     super.key,
@@ -36,6 +37,7 @@ class YearSelectorState extends State<YearSelector> {
     );
   }
 
+  ///Function to check if the page has reached the limit of the year list.
   void _onPageChange(final int page) {
     _blocked =
         !(page - 1 > 0 && page + 1 < widget.controller.yearPageCount - 1);
@@ -57,6 +59,7 @@ class YearSelectorState extends State<YearSelector> {
     initialize();
   }
 
+  ///Function to go to the next page of the grid.
   void goDown() {
     widget.controller.yearPageController?.animateToPage(
       widget.controller.yearPageController!.page!.toInt() + 1,
@@ -65,6 +68,7 @@ class YearSelectorState extends State<YearSelector> {
     );
   }
 
+  ///Function to go to the previous page of the grid.
   void goUp() {
     widget.controller.yearPageController?.animateToPage(
       widget.controller.yearPageController!.page!.toInt() - 1,
@@ -73,6 +77,7 @@ class YearSelectorState extends State<YearSelector> {
     );
   }
 
+  ///Function to initialize the grid.
   void initialize() {
     widget.controller.yearPageController = PageController(
       initialPage: widget.controller.localFirstDate == null