From 2e61a0539fe0d15d0c2f9afead727472ec40f046 Mon Sep 17 00:00:00 2001 From: Younes ENNAJI Date: Fri, 16 Jan 2026 00:20:39 +0100 Subject: [PATCH] Simplify PHPDoc comments in core Prime classes Removes verbose documentation while preserving type annotations for array parameters and PHPStan type definitions. --- src/Prime/Configuration.php | 2 -- src/Prime/EventDispatcher/EventDispatcher.php | 3 -- src/Prime/Factory/FlasherFactory.php | 2 -- src/Prime/Notification/Type.php | 31 ------------------- 4 files changed, 38 deletions(-) diff --git a/src/Prime/Configuration.php b/src/Prime/Configuration.php index 58c1b7ab..1a97c7f2 100644 --- a/src/Prime/Configuration.php +++ b/src/Prime/Configuration.php @@ -5,8 +5,6 @@ declare(strict_types=1); namespace Flasher\Prime; /** - * Type-safe configuration for PHPFlasher. - * * @phpstan-type ConfigType array{ * default: string, * main_script?: string, diff --git a/src/Prime/EventDispatcher/EventDispatcher.php b/src/Prime/EventDispatcher/EventDispatcher.php index cf08cfd6..f05567ef 100644 --- a/src/Prime/EventDispatcher/EventDispatcher.php +++ b/src/Prime/EventDispatcher/EventDispatcher.php @@ -10,9 +10,6 @@ use Flasher\Prime\EventDispatcher\EventListener\AttachDefaultStampsListener; use Flasher\Prime\EventDispatcher\EventListener\EnvelopeRemovalListener; use Flasher\Prime\EventDispatcher\EventListener\EventListenerInterface; -/** - * Default implementation of the event dispatcher interface. - */ final class EventDispatcher implements EventDispatcherInterface { /** diff --git a/src/Prime/Factory/FlasherFactory.php b/src/Prime/Factory/FlasherFactory.php index 8edbc413..618b033e 100644 --- a/src/Prime/Factory/FlasherFactory.php +++ b/src/Prime/Factory/FlasherFactory.php @@ -8,8 +8,6 @@ use Flasher\Prime\Notification\FlasherBuilder; use Flasher\Prime\Notification\NotificationBuilderInterface; /** - * Default implementation of FlasherFactoryInterface. - * * @mixin \Flasher\Prime\Notification\FlasherBuilder */ final class FlasherFactory extends NotificationFactory implements FlasherFactoryInterface diff --git a/src/Prime/Notification/Type.php b/src/Prime/Notification/Type.php index e868279e..75c69db7 100644 --- a/src/Prime/Notification/Type.php +++ b/src/Prime/Notification/Type.php @@ -4,41 +4,10 @@ declare(strict_types=1); namespace Flasher\Prime\Notification; -/** - * Type - Constants for standard notification types. - * - * This class defines the standard notification types supported by PHPFlasher. - * Using these constants instead of string literals ensures consistency and - * prevents typos when specifying notification types. - */ final class Type { - /** - * Success notification type. - * - * Used for positive feedback, successful operations, or completed actions. - */ public const SUCCESS = 'success'; - - /** - * Error notification type. - * - * Used for failures, exceptions, or problems that prevented an operation from completing. - */ public const ERROR = 'error'; - - /** - * Info notification type. - * - * Used for neutral informational messages, status updates, or helpful tips. - */ public const INFO = 'info'; - - /** - * Warning notification type. - * - * Used for potential issues, alerts, or important notices that don't prevent - * an operation but deserve attention. - */ public const WARNING = 'warning'; }