refactor(app): Обновить описание и структуру файлов конфигурации, улучшить документацию (#14)

Co-authored-by: PetrovY <y.petrov@friflex.com>
This commit is contained in:
Yuri Petrov
2025-06-20 16:50:48 +03:00
committed by GitHub
parent 427a821e5d
commit ba5fdba9be
26 changed files with 476 additions and 189 deletions

View File

@@ -2,18 +2,33 @@ import 'package:flutter/material.dart';
import 'package:friflex_starter/app/ui_kit/app_box.dart';
import 'package:friflex_starter/app/ui_kit/app_snackbar.dart';
/// {@template ComponentsScreen}
/// Экран для демонстрации компонентов приложения.
/// {@template components_screen}
/// Экран для демонстрации и тестирования компонентов приложения.
///
/// Отвечает за:
/// - Демонстрацию различных типов снекбаров (ошибка, успех, информация)
/// - Тестирование кастомных UI компонентов
/// - Предоставление примеров использования компонентов
/// - Валидацию корректности работы компонентов
/// {@endtemplate}
class ComponentsScreen extends StatefulWidget {
/// {@macro ComponentsScreen}
/// {@macro components_screen}
const ComponentsScreen({super.key});
@override
State<ComponentsScreen> createState() => _ComponentsScreenState();
}
/// {@template components_screen_state}
/// Состояние экрана компонентов.
///
/// Управляет отображением различных типов снекбаров
/// и демонстрирует их функциональность.
/// {@endtemplate}
class _ComponentsScreenState extends State<ComponentsScreen> {
/// {@macro components_screen_state}
_ComponentsScreenState();
@override
Widget build(BuildContext context) {
return Scaffold(

View File

@@ -2,11 +2,16 @@ import 'package:flutter/material.dart';
import 'package:friflex_starter/app/ui_kit/app_box.dart';
import 'package:friflex_starter/gen/assets.gen.dart';
/// {@template IconsScreen}
/// Экран для отрисовки иконок
/// {@template icons_screen}
/// Экран для отображения всех доступных иконок приложения.
///
/// Отвечает за:
/// - Отображение списка всех SVG иконок из assets/icons/
/// - Предоставление возможности просмотра иконок для разработчиков
/// - Демонстрацию использования системы генерации ресурсов
/// {@endtemplate}
class IconsScreen extends StatelessWidget {
/// {@macro IconsScreen}
/// {@macro icons_screen}
const IconsScreen({super.key});
@override
@@ -30,19 +35,20 @@ class IconsScreen extends StatelessWidget {
}
}
// Приватный класс для реализации элемента списка иконок
/// {@template item_icon}
/// Виджет для отображения отдельной иконки в списке.
///
/// Отображает SVG иконку вместе с её названием файла
/// для удобства идентификации в процессе разработки.
/// {@endtemplate}
class _ItemIcon extends StatelessWidget {
/// Создает экземпляр элемента списка иконок
///
/// Принимает:
/// - [icon] - иконка
/// - [name] - название иконки
/// {@macro item_icon}
const _ItemIcon({required this.icon, required this.name});
/// Иконка
/// SVG иконка для отображения
final Widget icon;
/// Название иконки
/// Название файла иконки для идентификации
final String name;
@override

View File

@@ -4,11 +4,17 @@ import 'package:friflex_starter/app/theme/app_colors_scheme.dart';
import 'package:friflex_starter/gen/assets.gen.dart';
import 'package:friflex_starter/gen/fonts.gen.dart';
/// {@template LangScreen}
/// Экран для отладки языков приложения
/// {@template lang_screen}
/// Экран для отладки и тестирования локализации приложения.
///
/// Отвечает за:
/// - Демонстрацию переключения между поддерживаемыми языками
/// - Отображение локализованных строк с разными шрифтами
/// - Тестирование системы локализации и шрифтов
/// - Показ текущего языка приложения
/// {@endtemplate}
class LangScreen extends StatelessWidget {
/// {@macro LangScreen}
/// {@macro lang_screen}
const LangScreen({super.key});
@override

View File

@@ -2,11 +2,17 @@ import 'package:flutter/material.dart';
import 'package:friflex_starter/app/app_context_ext.dart';
import 'package:friflex_starter/app/theme/app_colors_scheme.dart';
/// {@template ThemeScreen}
/// Экран для отладки темы приложения
/// {@template theme_screen}
/// Экран для отладки и тестирования темы приложения.
///
/// Отвечает за:
/// - Демонстрацию переключения между светлой и темной темами
/// - Отображение тестовых цветов из цветовой схемы
/// - Показ текущего режима темы
/// - Тестирование системы управления темами
/// {@endtemplate}
class ThemeScreen extends StatelessWidget {
/// {@macro ThemeScreen}
/// {@macro theme_screen}
const ThemeScreen({super.key});
@override

View File

@@ -1,10 +1,17 @@
import 'package:flutter/material.dart';
/// {@template TokensScreen}
/// Экран для отображения токенов
/// {@template tokens_screen}
/// Экран для отображения и управления токенами аутентификации.
///
/// Отвечает за:
/// - Отображение текущих токенов доступа и обновления
/// - Демонстрацию работы с токенами в приложении
/// - Тестирование функциональности аутентификации
///
/// В текущей реализации является заглушкой для будущей функциональности.
/// {@endtemplate}
class TokensScreen extends StatelessWidget {
/// {@macro TokensScreen}
/// {@macro tokens_screen}
const TokensScreen({super.key});
@override

View File

@@ -1,11 +1,18 @@
import 'package:flutter/material.dart';
/// {@template UiKitScreen}
/// Экран для отрисовки UI Kit
/// и тестирования его компонентов.
/// {@template ui_kit_screen}
/// Экран для демонстрации и тестирования компонентов UI Kit.
///
/// Отвечает за:
/// - Отображение всех доступных компонентов UI Kit
/// - Демонстрацию использования кастомных виджетов
/// - Тестирование стилей и тем оформления
/// - Предоставление примера использования UI компонентов
///
/// В текущей реализации является заглушкой для будущих компонентов.
/// {@endtemplate}
class UiKitScreen extends StatelessWidget {
/// {@macro UiKitScreen}
/// {@macro ui_kit_screen}
const UiKitScreen({super.key});
@override