8000 minor #33019 Remove unneeded phpdocs (fabpot) · symfony/symfony@53b2c43 · GitHub
[go: up one dir, main page]
Skip to content

Commit 53b2c43

Browse files
nicolas-grekasnicolas-grekas
committed
minor #33019 Remove unneeded phpdocs (fabpot)
This PR was squashed before being merged into the 4.4 branch (closes #33019). Discussion ---------- Remove unneeded phpdocs | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | n/a | License | MIT | Doc PR | n/a Commits ------- 692a6e7 Remove unneeded phpdocs
2 parents 2273de0 + 692a6e7 commit 53b2c43

File tree

175 files changed

+266
-655
lines changed
  • Workflow

    • Some content is hidden

    Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

    175 files changed

    +266
    -655
    lines changed

    ‎src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -45,8 +45,7 @@ public function __construct(ManagerRegistry $registry)
    4545
    /**
    4646
    * Adds the stack logger for a connection.
    4747
    *
    48-
    * @param string $name
    49-
    * @param DebugStack $logger
    48+
    * @param string $name
    5049
    */
    5150
    public function addLogger($name, DebugStack $logger)
    5251
    {

    ‎src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php

    Lines changed: 7 additions & 11 deletions
    Original file line numberDiff line numberDiff line change
    @@ -171,8 +171,7 @@ protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \Re
    171171
    /**
    172172
    * Register all the collected mapping information with the object manager by registering the appropriate mapping drivers.
    173173
    *
    174-
    * @param array $objectManager
    175-
    * @param ContainerBuilder $container A ContainerBuilder instance
    174+
    * @param array $objectManager
    176175
    */
    177176
    protected function registerMappingDrivers($objectManager, ContainerBuilder $container)
    178177
    {
    @@ -251,8 +250,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, $object
    251250
    /**
    252251
    * Detects what metadata driver to use for the supplied directory.
    253252
    *
    254-
    * @param string $dir A directory path
    255-
    * @param ContainerBuilder $container A ContainerBuilder instance
    253+
    * @param string $dir A directory path
    256254
    *
    257255
    * @return string|null A metadata driver short name, if one can be detected
    258256
    */
    @@ -285,9 +283,8 @@ protected function detectMetadataDriver($dir, ContainerBuilder $container)
    285283
    /**
    286284
    * Loads a configured object manager metadata, query or result cache driver.
    287285
    *
    288-
    * @param array $objectManager A configured object manager
    289-
    * @param ContainerBuilder $container A ContainerBuilder instance
    290-
    * @param string $cacheName
    286+
    * @param array $objectManager A configured object manager
    287+
    * @param string $cacheName
    291288
    *
    292289
    * @throws \InvalidArgumentException in case of unknown driver type
    293290
    */
    @@ -299,10 +296,9 @@ protected function loadObjectManagerCacheDriver(array $objectManager, ContainerB
    299296
    /**
    300297
    * Loads a cache driver.
    301298
    *
    302-
    * @param string $cacheName The cache driver name
    303-
    * @param string $objectManagerName The object manager name
    304-
    * @param array $cacheDriver The cache driver mapping
    305-
    * @param ContainerBuilder $container The ContainerBuilder instance
    299+
    * @param string $cacheName The cache driver name
    300+
    * @param string $objectManagerName The object manager name
    301+
    * @param array $cacheDriver The cache driver mapping
    306302
    *
    307303
    * @return string
    308304
    *

    ‎src/Symfony/Bridge/Doctrine/Form/ChoiceList/DoctrineChoiceLoader.php

    Lines changed: 1 addition & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -40,10 +40,7 @@ class DoctrineChoiceLoader implements ChoiceLoaderInterface
    4040
    * passed which optimizes the object loading for one of the Doctrine
    4141
    * mapper implementations.
    4242
    *
    43-
    * @param ObjectManager $manager The object manager
    44-
    * @param string $class The class name of the loaded objects
    45-
    * @param IdReader|null $idReader The reader for the object IDs
    46-
    * @param EntityLoaderInterface|null $objectLoader The objects loader
    43+
    * @param string $class The class name of the loaded objects
    4744
    */
    4845
    public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
    4946
    {

    ‎src/Symfony/Bridge/Doctrine/Form/ChoiceList/ORMQueryBuilderLoader.php

    Lines changed: 0 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -32,11 +32,6 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
    3232
    */
    3333
    private $queryBuilder;
    3434

    35-
    /**
    36-
    * Construct an ORM Query Builder Loader.
    37-
    *
    38-
    * @param QueryBuilder $queryBuilder The query builder for creating the query builder
    39-
    */
    4035
    public function __construct(QueryBuilder $queryBuilder)
    4136
    {
    4237
    $this->queryBuilder = $queryBuilder;

    ‎src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php

    Lines changed: 2 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -265,9 +265,8 @@ public function configureOptions(OptionsResolver $resolver)
    265265
    /**
    266266
    * Return the default loader object.
    267267
    *
    268-
    * @param ObjectManager $manager
    269-
    * @param mixed $queryBuilder
    270-
    * @param string $class
    268+
    * @param mixed $queryBuilder
    269+
    * @param string $class
    271270
    *
    272271
    * @return EntityLoaderInterface
    273272
    */

    ‎src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php

    Lines changed: 2 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -46,9 +46,8 @@ public function configureOptions(OptionsResolver $resolver)
    4646
    /**
    4747
    * Return the default loader object.
    4848
    *
    49-
    * @param ObjectManager $manager
    50-
    * @param QueryBuilder $queryBuilder
    51-
    * @param string $class
    49+
    * @param QueryBuilder $queryBuilder
    50+
    * @param string $class
    5251
    *
    5352
    * @return ORMQueryBuilderLoader
    5453
    */

    ‎src/Symfony/Bridge/Doctrine/Test/DoctrineTestHelper.php

    Lines changed: 0 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -31,8 +31,6 @@ class DoctrineTestHelper
    3131
    /**
    3232
    * Returns an entity manager for testing.
    3333
    *
    34-
    * @param Configuration|null $config
    35-
    *
    3634
    * @return EntityManager
    3735
    */
    3836
    public static function createTestEntityManager(Configuration $config = null)

    ‎src/Symfony/Bridge/Doctrine/Validator/Constraints/UniqueEntityValidator.php

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -34,8 +34,7 @@ public function __construct(ManagerRegistry $registry)
    3434
    }
    3535

    3636
    /**
    37-
    * @param object $entity
    38-
    * @param Constraint $constraint
    37+
    * @param object $entity
    3938
    *
    4039
    * @throws UnexpectedTypeException
    4140
    * @throws ConstraintDefinitionException

    ‎src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -81,8 +81,7 @@ final protected function ignoreAutoloadException($class, \Exception $exception)
    8181
    }
    8282

    8383
    /**
    84-
    * @param string $cacheDir
    85-
    * @param ArrayAdapter $arrayAdapter
    84+
    * @param string $cacheDir
    8685
    *
    8786
    * @return bool false if there is nothing to warm-up
    8887
    */

    ‎src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TemplateFinder.php

    Lines changed: 1 addition & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -34,9 +34,7 @@ class TemplateFinder implements TemplateFinderInterface
    3434
    private $templates;
    3535

    3636
    /**
    37-
    * @param KernelInterface $kernel A KernelInterface instance
    38-
    * @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
    39-
    * @param string $rootDir The directory where global templates can be stored
    37+
    * @param string $rootDir The directory where global templates can be stored
    4038
    */
    4139
    public function __construct(KernelInterface $kernel, TemplateNameParserInterface $parser, string $rootDir)
    4240
    {

    ‎src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

    Lines changed: 2 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -133,7 +133,6 @@ abstract protected function describeContainerTags(ContainerBuilder $builder, arr
    133133
    *
    134134
    * @param Definition|Alias|object $service
    135135
    * @param array $options
    136-
    * @param ContainerBuilder|null $builder
    137136
    */
    138137
    abstract protected function describeContainerService($service, array $options = [], ContainerBuilder $builder = null);
    139138

    @@ -224,8 +223,7 @@ protected function formatParameter($value)
    224223
    }
    225224

    226225
    /**
    227-
    * @param ContainerBuilder $builder
    228-
    * @param string $serviceId
    226+
    * @param string $serviceId
    229227
    *
    230228
    * @return mixed
    231229
    */
    @@ -249,8 +247,7 @@ protected function resolveServiceDefinition(ContainerBuilder $builder, $serviceI
    249247
    }
    250248

    251249
    /**
    252-
    * @param ContainerBuilder $builder
    253-
    * @param bool $showHidden
    250+
    * @param bool $showHidden
    254251
    *
    255252
    * @return array
    256253
    */

    ‎src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php

    Lines changed: 0 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -46,7 +46,6 @@ public function __construct(UrlGeneratorInterface $router = null, int $httpPort
    4646
    * In case the route name is empty, the status code will be 404 when permanent is false
    4747
    * and 410 otherwise.
    4848
    *
    49-
    * @param Request $request The request instance
    5049
    * @param string $route The route name to redirect to
    5150
    * @param bool $permanent Whether the redirection is permanent
    5251
    * @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
    @@ -88,7 +87,6 @@ public function redirectAction(Request $request, string $route, bool $permanent
    8887
    * In case the path is empty, the status code will be 404 when permanent is false
    8988
    * and 410 otherwise.
    9089
    *
    91-
    * @param Request $request The request instance
    9290
    * @param string $path The absolute path or URL to redirect to
    9391
    * @param bool $permanent Whether the redirect is permanent or not
    9492
    * @param string|null $scheme The URL scheme (null to keep the current one)

    ‎src/Symfony/Bundle/FrameworkBundle/Kernel/MicroKernelTrait.php

    Lines changed: 0 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -29,8 +29,6 @@ trait MicroKernelTrait
    2929
    *
    3030
    * $routes->import('config/routing.yml');
    3131
    * $routes->add('/admin', 'App\Controller\AdminController::dashboard', 'admin_dashboard');
    32-
    *
    33-
    * @param RouteCollectionBuilder $routes
    3432
    */
    3533
    abstract protected function configureRoutes(RouteCollectionBuilder $routes);
    3634

    @@ -50,9 +48,6 @@ abstract protected function configureRoutes(RouteCollectionBuilder $routes);
    5048
    * Or parameters:
    5149
    *
    5250
    * $c->setParameter('halloween', 'lot of fun');
    53-
    *
    54-
    * @param ContainerBuilder $c
    55-
    * @param LoaderInterface $loader
    5651
    */
    5752
    abstract protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader);
    5853

    ‎src/Symfony/Bundle/FrameworkBundle/Templating/EngineInterface.php

    Lines changed: 2 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -28,9 +28,8 @@ interface EngineInterface extends BaseEngineInterface
    2828
    /**
    2929
    * Renders a view and returns a Response.
    3030
    *
    31-
    * @param string $view The view name
    32-
    * @param array $parameters An array of parameters to pass to the view
    33-
    * @param Response $response A Response instance
    31+
    * @param string $view The view name
    32+
    * @param array $parameters An array of parameters to pass to the view
    3433
    *
    3534
    * @return Response A Response instance
    3635
    *

    ‎src/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.php

    Lines changed: 10 additions & 21 deletions
    Original file line numberDiff line numberDiff line change
    @@ -47,7 +47,6 @@ public function getName()
    4747
    *
    4848
    * The theme format is "<Bundle>:<Controller>".
    4949
    *
    50-
    * @param FormView $view A FormView instance
    5150
    * @param string|array $themes A theme or an array of theme
    5251
    * @param bool $useDefaultThemes If true, will use default themes defined in the renderer
    5352
    */
    @@ -75,8 +74,7 @@ public function setTheme(FormView $view, $themes, $useDefaultThemes = true)
    7574
    * form individually. You can also create a custom form theme to adapt
    7675
    * the look of the form.
    7776
    *
    78-
    * @param FormView $view The view for which to render the form
    79-
    * @param array $variables Additional variables passed to the template
    77+
    * @param array $variables Additional variables passed to the template
    8078
    *
    8179
    * @return string The HTML markup
    8280
    */
    @@ -92,8 +90,7 @@ public function form(FormView $view, array $variables = [])
    9290
    *
    9391
    * <?php echo $view['form']->start($form) ?>>
    9492
    *
    95-
    * @param FormView $view The view for which to render the start tag
    96-
    * @param array $variables Additional variables passed to the template
    93+
    * @param array $variables Additional variables passed to the template
    9794
    *
    9895
    * @return string The HTML markup
    9996
    */
    @@ -109,8 +106,7 @@ public function start(FormView $view, array $variables = [])
    109106
    *
    110107
    * <?php echo $view['form']->end($form) ?>>
    111108
    *
    112-
    * @param FormView $view The view for which to render the end tag
    113-
    * @param array $variables Additional variables passed to the template
    109+
    * @param array $variables Additional variables passed to the template
    114110
    *
    115111
    * @return string The HTML markup
    116112
    */
    @@ -132,8 +128,7 @@ public function end(FormView $view, array $variables = [])
    132128
    *
    133129
    * <?php echo $view['form']->widget($form, ['separator' => '+++++']) ?>
    134130
    *
    135-
    * @param FormView $view The view for which to render the widget
    136-
    * @param array $variables Additional variables passed to the template
    131+
    * @param array $variables Additional variables passed to the template
    137132
    *
    138133
    * @return string The HTML markup
    139134
    */
    @@ -145,8 +140,7 @@ public function widget(FormView $view, array $variables = [])
    145140
    /**
    146141
    * Renders the entire form field "row".
    147142
    *
    148-
    * @param FormView $view The view for which to render the row
    149-
    * @param array $variables Additional variables passed to the template
    143+
    * @param array $variables Additional variables passed to the template
    150144
    *
    151145
    * @return string The HTML markup
    152146
    */
    @@ -158,9 +152,8 @@ public function row(FormView $view, array $variables = [])
    158152
    /**
    159153
    * Renders the label of the given view.
    160154
    *
    161-
    * @param FormView $view The view for which to render the label
    162-
    * @param string $label The label
    163-
    * @param array $variables Additional variables passed to the template
    155+
    * @param string $label The label
    156+
    * @param array $variables Additional variables passed to the template
    164157
    *
    165158
    * @return string The HTML markup
    166159
    */
    @@ -176,8 +169,6 @@ public function label(FormView $view, $label = null, array $variables = [])
    176169
    /**
    177170
    * Renders the help of the given view.
    178171
    *
    179-
    * @param FormView $view The parent view
    180-
    *
    181172
    * @return string The HTML markup
    182173
    */
    183174
    public function help(FormView $view): string
    @@ -198,8 +189,7 @@ public function errors(FormView $view)
    198189
    /**
    199190
    * Renders views which have not already been rendered.
    200191
    *
    201-
    * @param FormView $view The parent view
    202-
    * @param array $variables An array of variables
    192+
    * @param array $variables An array of variables
    203193
    *
    204194
    * @return string The HTML markup
    205195
    */
    @@ -211,9 +201,8 @@ public function rest(FormView $view, array $variables = [])
    211201
    /**
    212202
    * Renders a block of the template.
    213203
    *
    214-
    * @param FormView $view The view for determining the used themes
    215-
    * @param string $blockName The name of the block to render
    216-
    * @param array $variables The variable to pass to the template
    204+
    * @param string $blockName The name of the block to render
    205+
    * @param array $variables The variable to pass to the template
    217206
    *
    218207
    * @return string The HTML markup
    219208
    */

    ‎src/Symfony/Bundle/FrameworkBundle/Templating/Loader/TemplateLocator.php

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -31,8 +31,7 @@ class TemplateLocator implements FileLocatorInterface
    3131
    private $cacheHits = [];
    3232

    3333
    /**
    34-
    * @param FileLocatorInterface $locator A FileLocatorInterface instance
    35-
    * @param string $cacheDir The cache path
    34+
    * @param string $cacheDir The cache path
    3635
    */
    3736
    public function __construct(FileLocatorInterface $locator, string $cacheDir = null)
    3837
    {

    ‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AbstractFactory.php

    Lines changed: 3 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -98,10 +98,9 @@ final public function addOption($name, $default = null)
    9898
    * Subclasses must return the id of a service which implements the
    9999
    * AuthenticationProviderInterface.
    100100
    *
    101-
    * @param ContainerBuilder $container
    102-
    * @param string $id The unique id of the firewall
    103-
    * @param array $config The options array for this listener
    104-
    * @param string $userProviderId The id of the user provider
    101+
    * @param string $id The unique id of the firewall
    102+
    * @param array $config The options array for this listener
    103+
    * @param string $userProviderId The id of the user provider
    105104
    *
    106105
    * @return string never null, the id of the authentication provider
    107106
    */

    ‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php

    Lines changed: 4 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -24,11 +24,10 @@ interface SecurityFactoryInterface
    2424
    /**
    2525
    * Configures the container services required to use the authentication listener.
    2626
    *
    27-
    * @param ContainerBuilder $container
    28-
    * @param string $id The unique id of the firewall
    29-
    * @param array $config The options array for the listener
    30-
    * @param string $userProvider The service id of the user provider
    31-
    * @param string $defaultEntryPoint
    27+
    * @param string $id The unique id of the firewall
    28+
    * @param array $config The options array for the listener
    29+
    * @param string $userProvider The service id of the user provider
    30+
    * @param string $defaultEntryPoint
    3231
    *
    3332
    * @return array containing three values:
    3433
    * - the provider id

    ‎src/Symfony/Bundle/SecurityBundle/EventListener/VoteListener.php

    Lines changed: 0 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -33,8 +33,6 @@ public function __construct(TraceableAccessDecisionManager $traceableAccessDecis
    3333

    3434
    /**
    3535
    * Event dispatched by a voter during access manager decision.
    36-
    *
    37-
    * @param VoteEvent $event event with voter data
    3836
    */
    3937
    public function onVoterVote(VoteEvent $event)
    4038
    {

    ‎src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

    Lines changed: 4 additions & 6 deletions
    Original file line numberDiff line numberDiff line change
    @@ -36,8 +36,7 @@ class ExceptionController
    3636
    protected $debug;
    3737

    3838
    /**
    39-
    * @param Environment $twig
    40-
    * @param bool $debug Show error (false) or exception (true) pages by default
    39+
    * @param bool $debug Show error (false) or exception (true) pages by default
    4140
    */
    4241
    public function __construct(Environment $twig, bool $debug)
    4342
    {
    @@ -92,10 +91,9 @@ protected function getAndCleanOutputBuffering($startObLevel)
    9291
    }
    9392

    9493
    /**
    95-
    * @param Request $request
    96-
    * @param string $format
    97-
    * @param int $code An HTTP response status code
    98-
    * @param bool $showException
    94+
    * @param string $format
    95+
    * @param int $code An HTTP response status code
    96+
    * @param bool $showException
    9997
    *
    10098
    * @return string
    10199
    */

    0 commit comments

    Comments
     (0)
    0