Improve code documentation

lib/common/app_settings.dart

@@ -5,9 +5,11 @@
 
 import 'package:shared_preferences/shared_preferences.dart';
 
+/// Persistent app settings.
 class AppSettings {
   bool _counterTapMode = false;
 
+  /// The setting for whether counters are incremented by tapping the screen.
   bool get counterTapMode => _counterTapMode;
 
   set counterTapMode(bool value) {

lib/common/urls.dart

@@ -6,8 +6,11 @@
 // Url constants used throughout the app.
 library;
 
-const String feedbackURL = 'https://hellogramming.com/weekdaycounters/feedback/';
-
+/// The app's home page URL.
 const String aboutURL = 'https://hellogramming.com/weekdaycounters/';
 
+/// The URL to the source code repository of the app.
 const String viewSourceURL = 'https://github.com/Hellogramming/weekday_counters';
+
+/// The URL for sending feedback.
+const String feedbackURL = 'https://hellogramming.com/weekdaycounters/feedback/';

lib/main.dart

@@ -9,12 +9,12 @@ import 'common/strings.dart' as strings;
 import 'screens/home_screen.dart';
 
 void main() {
-  runApp(const CountersApp());
+  runApp(const WeekdayCountersApp());
 }
 
-/// The app widget.
-class CountersApp extends StatelessWidget {
-  const CountersApp({super.key});
+/// The main app widget for the Weekday Counters app.
+class WeekdayCountersApp extends StatelessWidget {
+  const WeekdayCountersApp({super.key});
 
   @override
   Widget build(BuildContext context) {

lib/screens/settings_screen.dart

@@ -8,12 +8,14 @@ import 'package:flutter/material.dart';
 import '../common/app_settings.dart';
 import '../common/strings.dart' as strings;
 
+/// The app settings screen.
 class SettingsScreen extends StatefulWidget {
   const SettingsScreen({
     super.key,
     required this.appSettings,
   });
 
+  /// The app settings that can be changed in this screen.
   final AppSettings appSettings;
 
   @override
@@ -28,7 +30,8 @@ class _SettingsScreenState extends State<SettingsScreen> {
         title: const Text(strings.settingsTitle),
       ),
       body: ListView(
-        children: [
+        children: <Widget>[
+          // Add the counter tap mode switch list tile
           SwitchListTile(
             activeColor: Colors.black,
             value: widget.appSettings.counterTapMode,

lib/utils/utils.dart

@@ -23,6 +23,9 @@ Future<void> launchUrlExternal(String url) async {
 /// Utility Color extension methods.
 extension ColorX on Color {
   /// Returns the contrast color for this color.
-  Color contrastOf() =>
-      ThemeData.estimateBrightnessForColor(this) == Brightness.light ? Colors.black : Colors.white;
+  Color contrastOf() {
+    return ThemeData.estimateBrightnessForColor(this) == Brightness.light
+        ? Colors.black
+        : Colors.white;
+  }
 }

lib/widgets/counters_drawer.dart

@@ -32,8 +32,9 @@ class CountersDrawer extends StatelessWidget {
   /// Called when the user taps a drawer list tile.
   final void Function(DrawerExtraActions value)? onExtraSelected;
 
+  /// Handles the tap event on an extra action.
   void _onExtraActionTap(BuildContext context, DrawerExtraActions action) {
-    Navigator.pop(context);
+    Navigator.pop(context); // Close the drawer
     onExtraSelected?.call(action);
   }
 
@@ -45,7 +46,10 @@ class CountersDrawer extends StatelessWidget {
         child: ListView(
           children: <Widget>[
             _buildDrawerHeader(context, counters.current.color),
+
+            // Add a list tile for each counter type
             ...CounterType.values.map((type) => _buildCounterListTile(context, type)),
+
             const Divider(),
             ListTile(
               leading: const Icon(Icons.settings),
@@ -74,6 +78,7 @@ class CountersDrawer extends StatelessWidget {
     );
   }
 
+  /// Builds the drawer header.
   Widget _buildDrawerHeader(BuildContext context, Color color) {
     return DrawerHeader(
       child: Center(
@@ -85,6 +90,7 @@ class CountersDrawer extends StatelessWidget {
     );
   }
 
+  /// Builds a list tile for the counter of the specified type.
   Widget _buildCounterListTile(BuildContext context, CounterType counterType) {
     return ColorListTile(
       color: Counter.colorOf(counterType),

test/widget_test.dart

@@ -13,7 +13,7 @@ import 'package:weekday_counters/main.dart';
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {
     // Build our app and trigger a frame.
-    await tester.pumpWidget(const CountersApp());
+    await tester.pumpWidget(const WeekdayCountersApp());
 
     // Verify that our counter starts at 0.
     expect(find.text('0'), findsOneWidget);