From 82ad2b74f829e857a949cb607d77349d1b1bea6c Mon Sep 17 00:00:00 2001 From: Mathis Kirchner Date: Tue, 13 Jan 2026 21:16:59 +0100 Subject: [PATCH] refactor: enhance documentation and fix punctuation in localization strings --- lib/l10n/arb/app_de.arb | 2 +- lib/l10n/arb/app_en.arb | 2 +- lib/l10n/generated/app_localizations.dart | 2 +- lib/l10n/generated/app_localizations_de.dart | 2 +- lib/l10n/generated/app_localizations_en.dart | 2 +- .../buttons/animated_dialog_button.dart | 12 +++++------ .../widgets/custom_alert_dialog.dart | 20 +++++++++---------- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/lib/l10n/arb/app_de.arb b/lib/l10n/arb/app_de.arb index 6aee6ee..7091586 100644 --- a/lib/l10n/arb/app_de.arb +++ b/lib/l10n/arb/app_de.arb @@ -79,7 +79,7 @@ "stats": "Statistiken", "successfully_added_player": "Spieler:in {playerName} erfolgreich hinzugefügt", "there_is_no_group_matching_your_search": "Es gibt keine Gruppe, die deiner Suche entspricht", - "this_cannot_be_undone": "Dies kann nicht rückgängig gemacht werden", + "this_cannot_be_undone": "Dies kann nicht rückgängig gemacht werden.", "today_at": "Heute um", "undo": "Rückgängig", "unknown_exception": "Unbekannter Fehler (siehe Konsole)", diff --git a/lib/l10n/arb/app_en.arb b/lib/l10n/arb/app_en.arb index c311050..6eb7613 100644 --- a/lib/l10n/arb/app_en.arb +++ b/lib/l10n/arb/app_en.arb @@ -356,7 +356,7 @@ "stats": "Stats", "successfully_added_player": "Successfully added player {playerName}", "there_is_no_group_matching_your_search": "There is no group matching your search", - "this_cannot_be_undone": "This can't be undone", + "this_cannot_be_undone": "This can't be undone.", "today_at": "Today at", "undo": "Undo", "unknown_exception": "Unknown Exception (see console)", diff --git a/lib/l10n/generated/app_localizations.dart b/lib/l10n/generated/app_localizations.dart index 399dc85..e78d69b 100644 --- a/lib/l10n/generated/app_localizations.dart +++ b/lib/l10n/generated/app_localizations.dart @@ -575,7 +575,7 @@ abstract class AppLocalizations { /// Warning message for irreversible actions /// /// In en, this message translates to: - /// **'This can\'t be undone'** + /// **'This can\'t be undone.'** String get this_cannot_be_undone; /// Date format for today diff --git a/lib/l10n/generated/app_localizations_de.dart b/lib/l10n/generated/app_localizations_de.dart index f4d0f8c..8ecc0a7 100644 --- a/lib/l10n/generated/app_localizations_de.dart +++ b/lib/l10n/generated/app_localizations_de.dart @@ -262,7 +262,7 @@ class AppLocalizationsDe extends AppLocalizations { @override String get this_cannot_be_undone => - 'Dies kann nicht rückgängig gemacht werden'; + 'Dies kann nicht rückgängig gemacht werden.'; @override String get today_at => 'Heute um'; diff --git a/lib/l10n/generated/app_localizations_en.dart b/lib/l10n/generated/app_localizations_en.dart index 6c4ac74..b911676 100644 --- a/lib/l10n/generated/app_localizations_en.dart +++ b/lib/l10n/generated/app_localizations_en.dart @@ -261,7 +261,7 @@ class AppLocalizationsEn extends AppLocalizations { 'There is no group matching your search'; @override - String get this_cannot_be_undone => 'This can\'t be undone'; + String get this_cannot_be_undone => 'This can\'t be undone.'; @override String get today_at => 'Today at'; diff --git a/lib/presentation/widgets/buttons/animated_dialog_button.dart b/lib/presentation/widgets/buttons/animated_dialog_button.dart index 42104b2..c0ce560 100644 --- a/lib/presentation/widgets/buttons/animated_dialog_button.dart +++ b/lib/presentation/widgets/buttons/animated_dialog_button.dart @@ -4,18 +4,18 @@ import 'package:game_tracker/core/custom_theme.dart'; /// A custom animated button widget that provides a scaling and opacity effect /// when pressed. This widget is designed to be used in dialogs or other UI /// components where a visually appealing button is required. +/// +/// Parameters: +/// - [onPressed]: Callback function that is triggered when the button is pressed. +/// - [child]: The child widget to be displayed inside the button, typically a text or icon. class AnimatedDialogButton extends StatefulWidget { + const AnimatedDialogButton({super.key, required this.onPressed, required this.child}); + /// Callback function that is triggered when the button is pressed. final VoidCallback onPressed; - /// The child widget to be displayed inside the button, typically a text or icon. final Widget child; - /// Creates an instance of `AnimatedDialogButton`. - /// - /// The [onPressed] and [child] parameters are required. - const AnimatedDialogButton({super.key, required this.onPressed, required this.child}); - @override State createState() => _AnimatedDialogButtonState(); } diff --git a/lib/presentation/widgets/custom_alert_dialog.dart b/lib/presentation/widgets/custom_alert_dialog.dart index 5dc8b9a..832369a 100644 --- a/lib/presentation/widgets/custom_alert_dialog.dart +++ b/lib/presentation/widgets/custom_alert_dialog.dart @@ -5,17 +5,13 @@ import 'package:game_tracker/core/custom_theme.dart'; /// /// This widget provides a styled alternative to the default Flutter AlertDialog, /// with consistent colors, borders, and layout that match the app's custom theme. +/// +/// Parameters: +/// - [title]: The title text displayed at the top of the dialog. +/// - [content]: The main content text displayed in the body of the dialog. +/// - [actions]: A list of action widgets (typically buttons) displayed at the bottom +/// of the dialog. These actions are horizontally spaced around the dialog's width. class CustomAlertDialog extends StatelessWidget { - /// The title text displayed at the top of the dialog. - final String title; - - /// The main content text displayed in the body of the dialog. - final String content; - - /// A list of action widgets (typically buttons) displayed at the bottom of the dialog. - /// These actions are horizontally spaced around the dialog's width. - final List actions; - const CustomAlertDialog({ super.key, required this.title, @@ -23,6 +19,10 @@ class CustomAlertDialog extends StatelessWidget { required this.actions, }); + final String title; + final String content; + final List actions; + @override Widget build(BuildContext context) { return AlertDialog(