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,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