minor symfony#51971 [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties (alexandre-daubois)

This PR was merged into the 7.1 branch.

Discussion
----------

[DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties

| Q             | A
| ------------- | ---
| Branch?       | 7.1
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | Part of symfony#51920
| License       | MIT

Friendly ping `@GromNaN`, is that what you had in mind? 🙂

Commits
-------

a9030f1 [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties

Author: nicolas-grekas

src/Symfony/Component/DependencyInjection/Attribute/AsAlias.php

@@ -19,6 +19,10 @@
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
 final class AsAlias
 {
+    /**
+     * @param string|null $id     The id of the alias
+     * @param bool        $public Whether to declare the alias public
+     */
     public function __construct(
         public ?string $id = null,
         public bool $public = false,

src/Symfony/Component/DependencyInjection/Attribute/AsDecorator.php

@@ -13,9 +13,17 @@
 
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+/**
+ * Declares a decorating service.
+ */
 #[\Attribute(\Attribute::TARGET_CLASS)]
 class AsDecorator
 {
+    /**
+     * @param string $decorates The service id to decorate
+     * @param int    $priority  The priority of this decoration when multiple decorators are declared for the same service
+     * @param int    $onInvalid The behavior to adopt when the decoration is invalid; must be one of the {@see ContainerInterface} constants
+     */
     public function __construct(
         public string $decorates,
         public int $priority = 0,

src/Symfony/Component/DependencyInjection/Attribute/AsTaggedItem.php

@@ -19,6 +19,10 @@
 #[\Attribute(\Attribute::TARGET_CLASS)]
 class AsTaggedItem
 {
+    /**
+     * @param string|null $index    The property or method to use to index the item in the locator
+     * @param int|null    $priority The priority of the item; the higher the number, the earlier the tagged service will be located in the locator
+     */
     public function __construct(
         public ?string $index = null,
         public ?int $priority = null,

src/Symfony/Component/DependencyInjection/Attribute/Autoconfigure.php

@@ -19,6 +19,18 @@
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
 class Autoconfigure
 {
+    /**
+     * @param array<array-key, array<array-key, mixed>>|null $tags         The tags to add to the service
+     * @param array<string, array<array-key, mixed>>|null    $calls        The calls to be made when instantiating the service
+     * @param array<string, mixed>|null                      $bind         The bindings to declare for the service
+     * @param bool|string|null                               $lazy         Whether the service is lazy-loaded
+     * @param bool|null                                      $public       Whether to declare the service as public
+     * @param bool|null                                      $shared       Whether to declare the service as shared
+     * @param bool|null                                      $autowire     Whether to declare the service as autowired
+     * @param array<string, mixed>|null                      $properties   The properties to define when creating the service
+     * @param array<class-string, string>|string|null        $configurator A PHP function, reference or an array containing a class/Reference and a method to call after the service is fully initialized
+     * @param string|null                                    $constructor  The public static method to use to instantiate the service
+     */
     public function __construct(
         public ?array $tags = null,
         public ?array $calls = null,

src/Symfony/Component/DependencyInjection/Attribute/AutoconfigureTag.php

@@ -19,6 +19,10 @@
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
 class AutoconfigureTag extends Autoconfigure
 {
+    /**
+     * @param string|null             $name       The tag name to add
+     * @param array<array-key, mixed> $attributes The tag attributes to attach to the tag
+     */
     public function __construct(string $name = null, array $attributes = [])
     {
         parent::__construct(

src/Symfony/Component/DependencyInjection/Attribute/AutowireCallable.php

@@ -22,7 +22,10 @@
 class AutowireCallable extends Autowire
 {
     /**
-     * @param bool|class-string $lazy Whether to use lazy-loading for this argument
+     * @param string|array|null $callable The callable to autowire
+     * @param string|null       $service  The service containing the callable to autowire
+     * @param string|null       $method   The method name that will be autowired
+     * @param bool|class-string $lazy     Whether to use lazy-loading for this argument
      */
     public function __construct(
         string|array $callable = null,

src/Symfony/Component/DependencyInjection/Attribute/AutowireDecorated.php

@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\DependencyInjection\Attribute;
 
+/**
+ * Autowires the inner object of decorating services.
+ */
 #[\Attribute(\Attribute::TARGET_PARAMETER)]
 class AutowireDecorated
 {

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

@@ -20,7 +20,14 @@
 class AutowireIterator extends Autowire
 {
     /**
-     * @param string|string[] $exclude A service or a list of services to exclude
+     * @see ServiceSubscriberInterface::getSubscribedServices()
+     *
+     * @param string               $tag                   A tag name to search for to populate the iterator
+     * @param string|null          $indexAttribute        The name of the attribute that defines the key referencing each service in the tagged collection
+     * @param string|null          $defaultIndexMethod    The static method that should be called to get each service's key when their tag doesn't define the previous attribute
+     * @param string|null          $defaultPriorityMethod The static method that should be called to get each service's priority when their tag doesn't define the "priority" attribute
+     * @param string|array<string> $exclude               A service id or a list of service ids to exclude
+     * @param bool                 $excludeSelf           Whether to automatically exclude the referencing service from the iterator
      */
     public function __construct(
         string $tag,

src/Symfony/Component/DependencyInjection/Attribute/AutowireLocator.php

@@ -28,8 +28,12 @@ class AutowireLocator extends Autowire
     /**
      * @see ServiceSubscriberInterface::getSubscribedServices()
      *
-     * @param string|array<string|SubscribedService> $services An explicit list of services or a tag name
-     * @param string|string[]                        $exclude  A service or a list of services to exclude
+     * @param string|array<string|SubscribedService> $services              A tag name or an explicit list of service ids
+     * @param string|null                            $indexAttribute        The name of the attribute that defines the key referencing each service in the locator
+     * @param string|null                            $defaultIndexMethod    The static method that should be called to get each service's key when their tag doesn't define the previous attribute
+     * @param string|null                            $defaultPriorityMethod The static method that should be called to get each service's priority when their tag doesn't define the "priority" attribute
+     * @param string|array                           $exclude               A service id or a list of service ids to exclude
+     * @param bool                                   $excludeSelf           Whether to automatically exclude the referencing service from the locator
      */
     public function __construct(
         string|array $services,

src/Symfony/Component/DependencyInjection/Attribute/AutowireServiceClosure.php

@@ -20,6 +20,9 @@
 #[\Attribute(\Attribute::TARGET_PARAMETER)]
 class AutowireServiceClosure extends Autowire
 {
+    /**
+     * @param string $service The service id to wrap in the closure
+     */
     public function __construct(string $service)
     {
         parent::__construct(new ServiceClosureArgument(new Reference($service)));