Skip to content

Commit 812d5e0

Browse files
committed
minor #51996 [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties (alexandre-daubois)
This PR was merged into the 7.1 branch. Discussion ---------- [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | Part of symfony/symfony#51920 | License | MIT Commits ------- a1f43a94b7 [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties
2 parents a07ddd6 + 1ac1858 commit 812d5e0

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

Attribute/Route.php

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,21 @@ class Route
2424
private array $schemes;
2525

2626
/**
27-
* @param array<string|\Stringable> $requirements
28-
* @param string[]|string $methods
29-
* @param string[]|string $schemes
27+
* @param string|array<string,string>|null $path The route path (i.e. "/user/login")
28+
* @param string|null $name The route name (i.e. "app_user_login")
29+
* @param array<string|\Stringable> $requirements Requirements for the route attributes, @see https://symfony.com/doc/current/routing.html#parameters-validation
30+
* @param array<string, mixed> $options Options for the route (i.e. ['prefix' => '/api'])
31+
* @param array<string, mixed> $defaults Default values for the route attributes and query parameters
32+
* @param string|null $host The host for which this route should be active (i.e. "localhost")
33+
* @param string|string[] $methods The list of HTTP methods allowed by this route
34+
* @param string|string[] $schemes The list of schemes allowed by this route (i.e. "https")
35+
* @param string|null $condition An expression that must evaluate to true for the route to be matched, @see https://symfony.com/doc/current/routing.html#matching-expressions
36+
* @param int|null $priority The priority of the route if multiple ones are defined for the same path
37+
* @param string|null $locale The locale accepted by the route
38+
* @param string|null $format The format returned by the route (i.e. "json", "xml")
39+
* @param bool|null $utf8 Whether the route accepts UTF-8 in its parameters
40+
* @param bool|null $stateless Whether the route is defined as stateless or stateful, @see https://symfony.com/doc/current/routing.html#stateless-routes
41+
* @param string|null $env The env in which the route is defined (i.e. "dev", "test", "prod")
3042
*/
3143
public function __construct(
3244
string|array|null $path = null,

0 commit comments

Comments
 (0)