From f8f90df75e1264f2286c2467817e6affa507bef7 Mon Sep 17 00:00:00 2001
From: mhsdesign <85400359+mhsdesign@users.noreply.github.com>
Date: Wed, 27 Mar 2024 10:59:29 +0100
Subject: [PATCH] TASK: Adjust documentation of `#[Flow\Route]`

---
 Neos.Flow/Classes/Annotations/Route.php | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/Neos.Flow/Classes/Annotations/Route.php b/Neos.Flow/Classes/Annotations/Route.php
index 5875699867..4d9e8d86d3 100644
--- a/Neos.Flow/Classes/Annotations/Route.php
+++ b/Neos.Flow/Classes/Annotations/Route.php
@@ -27,7 +27,7 @@
  * @Target({"METHOD"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
-final class Route
+final readonly class Route
 {
     /**
      * Magic route values cannot be set as default nor be contained as segments like `{\@action}` or `{\@controller}` in the uriPattern.
@@ -36,16 +36,16 @@ final class Route
     private const PRESERVED_DEFAULTS = ['@package', '@subpackage', '@controller', '@action'];
 
     /**
-     * @param string $uriPattern The uri-pattern for the route without leading '/'.
-     * @param string $name (default null) The name ouf the route as it shows up in the route:list command
-     * @param array $httpMethods (default []) List of http verbs like 'GET', 'POST', 'PUT', 'DELETE', if not specified any will be matched
-     * @param array $defaults (default []) Values to set for this route.
+     * @param string $uriPattern The uri-pattern for the route without leading '/'. Might contain route values in the form of `path/{foo}`
+     * @param string $name The suffix of the route name as shown in `route:list` (defaults to the action name: "My.Package :: Site :: index")
+     * @param array $httpMethods List of uppercase http verbs like 'GET', 'POST', 'PUT', 'DELETE', if not specified any request method will be matched
+     * @param array $defaults Values to set for this route
      */
     public function __construct(
-        public readonly string $uriPattern,
-        public readonly string $name = '',
-        public readonly array $httpMethods = [],
-        public readonly array $defaults = [],
+        public string $uriPattern,
+        public string $name = '',
+        public array $httpMethods = [],
+        public array $defaults = [],
     ) {
         if ($uriPattern === '' || str_starts_with($uriPattern, '/')) {
             throw new \DomainException(sprintf('Uri pattern must not be empty or begin with a slash: "%s"', $uriPattern), 1711529592);