8000 removed uneeded docblocks · symfony/symfony@7f455f4 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7f455f4

Browse files
fabpotfabpot
committed
removed uneeded docblocks
1 parent 8e8ee09 commit 7f455f4

File tree

211 files changed

+615
-1362
lines changed
  • ResourceBundle
  • Tests/DateFormatter
  • Process
  • PropertyAccess/Tests/Fixtures
  • Routing
  • Security
  • Serializer
  • Templating
  • Translation
  • Validator
  • VarDumper/Cloner
  • Yaml

    • Some content is hidden

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

    211 files changed

    +615
    -1362
    lines changed

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

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -40,8 +40,7 @@ public function __construct(ManagerRegistry $registry)
    4040
    /**
    4141
    * Adds the stack logger for a connection.
    4242
    *
    43-
    * @param string $name
    44-
    * @param DebugStack $logger
    43+
    * @param string $name
    4544
    */
    4645
    public function addLogger($name, DebugStack $logger)
    4746
    {

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

    Lines changed: 13 additions & 27 deletions
    Original file line numberDiff line numberDiff line change
    @@ -36,10 +36,8 @@ abstract class AbstractDoctrineExtension extends Extension
    3636
    protected $drivers = array();
    3737

    3838
    /**
    39-
    * @param array $objectManager A configured object manager
    40-
    * @param ContainerBuilder $container A ContainerBuilder instance
    41-
    *
    42-
    * @throws \InvalidArgumentException
    39+
    * @param array $objectManager A configured object manager
    40+
    * @throws InvalidArgumentException
    4341
    */
    4442
    protected function loadMappingInformation(array $objectManager, ContainerBuilder $container)
    4543
    {
    @@ -118,10 +116,8 @@ protected function setMappingDriverAlias($mappingConfig, $mappingName)
    118116
    /**
    119117
    * Register the mapping driver configuration for later use with the object managers metadata driver chain.
    120118
    *
    121-
    * @param array $mappingConfig
    122119
    * @param string $mappingName
    123-
    *
    124-
    * @throws \InvalidArgumentException
    120+
    * @throws InvalidArgumentException
    125121
    */
    126122
    protected function setMappingDriverConfig(array $mappingConfig, $mappingName)
    127123
    {
    @@ -173,8 +169,7 @@ protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \Re
    173169
    /**
    174170
    * Register all the collected mapping information with the object manager by registering the appropriate mapping drivers.
    175171
    *
    176-
    * @param array $objectManager
    177-
    * @param ContainerBuilder $container A ContainerBuilder instance
    172+
    10000 * @param array $objectManager
    178173
    */
    179174
    protected function registerMappingDrivers($objectManager, ContainerBuilder $container)
    180175
    {
    @@ -226,10 +221,8 @@ protected function registerMappingDrivers($objectManager, ContainerBuilder $cont
    226221
    /**
    227222
    * Assertion if the specified mapping information is valid.
    228223
    *
    229-
    * @param array $mappingConfig
    230224
    * @param string $objectManagerName
    231-
    *
    232-
    * @throws \InvalidArgumentException
    225+
    * @throws InvalidArgumentException
    233226
    */
    234227
    protected function assertValidMappingConfiguration(array $mappingConfig, $objectManagerName)
    235228
    {
    @@ -253,9 +246,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, $object
    253246
    /**
    254247
    * Detects what metadata driver to use for the supplied directory.
    255248
    *
    256-
    * @param string $dir A directory path
    257-
    * @param ContainerBuilder $container A ContainerBuilder instance
    258-
    *
    249+
    * @param string $dir A directory path
    259250
    * @return string|null A metadata driver short name, if one can be detected
    260251
    */
    261252
    protected function detectMetadataDriver($dir, ContainerBuilder $container)
    @@ -289,11 +280,9 @@ protected function detectMetadataDriver($dir, ContainerBuilder $container)
    289280
    /**
    290281
    * Loads a configured object manager metadata, query or result cache driver.
    291282
    *
    292-
    * @param array $objectManager A configured object manager
    293-
    * @param ContainerBuilder $container A ContainerBuilder instance
    294-
    * @param string $cacheName
    295-
    *
    296-
    * @throws \InvalidArgumentException in case of unknown driver type
    283+
    * @param array $objectManager A configured object manager
    284+
    * @param string $cacheName
    285+
    * @throws InvalidArgumentException in case of unknown driver type
    297286
    */
    298287
    protected function loadObjectManagerCacheDriver(array $objectManager, ContainerBuilder $container, $cacheName)
    299288
    {
    @@ -303,14 +292,11 @@ protected function loadObjectManagerCacheDriver(array $objectManager, ContainerB
    303292
    /**
    304293
    * Loads a cache driver.
    305294
    *
    306-
    * @param string $cacheName The cache driver name
    307-
    * @param string $objectManagerName The object manager name
    308-
    * @param array $cacheDriver The cache driver mapping
    309-
    * @param ContainerBuilder $container The ContainerBuilder instance
    310-
    *
    295+
    * @param string $cacheName The cache driver name
    296+
    * @param string $objectManagerName The object manager name
    297+
    * @param array $cacheDriver The cache driver mapping
    311298
    * @return string
    312-
    *
    313-
    * @throws \InvalidArgumentException
    299+
    * @throws InvalidArgumentException
    314300
    */
    315301
    protected function loadCacheDriver($cacheName, $objectManagerName, array $cacheDriver, ContainerBuilder $container)
    316302
    {

    ‎src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/DoctrineValidationPass.php

    Lines changed: 2 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -45,9 +45,8 @@ public function process(ContainerBuilder $container)
    4545
    * Gets the validation mapping files for the format and extends them with
    4646
    * files matching a doctrine search pattern (Resources/config/validation.orm.xml).
    4747
    *
    48-
    * @param ContainerBuilder $container
    49-
    * @param string $mapping
    50-
    * @param string $extension
    48+
    * @param string $mapping
    49+
    * @param string $extension
    5150
    */
    5251
    private function updateValidatorMappingFiles(ContainerBuilder $container, $mapping, $extension)
    5352
    {

    ‎src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterEventListenersAndSubscribersPass.php

    Lines changed: 1 addition & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -134,10 +134,7 @@ private function getEventManagerDef(ContainerBuilder $container, $name)
    134134
    *
    135135
    * @see https://bugs.php.net/bug.php?id=53710
    136136
    * @see https://bugs.php.net/bug.php?id=60926
    137-
    *
    138-
    * @param string $tagName
    139-
    * @param ContainerBuilder $container
    140-
    *
    137+
    * @param string $tagName
    141138
    * @return array
    142139
    */
    143140
    private function findAndSortTags($tagName, ContainerBuilder $container)

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

    Lines changed: 0 additions & 6 deletions
    Original file line numberDiff line numberDiff line change
    @@ -303,10 +303,7 @@ public function getValuesForChoices(array $entities)
    303303
    /**
    304304
    * Returns the indices corresponding to the given entities.
    305305
    *
    306-
    * @param array $entities
    307-
    *
    308306
    * @return array
    309-
    *
    310307
    * @see ChoiceListInterface
    311308
    * @deprecated since version 2.4, to be removed in 3.0.
    312309
    */
    @@ -346,10 +343,7 @@ public function getIndicesForChoices(array $entities)
    346343
    /**
    347344
    * Returns the entities corresponding to the given values.
    348345
    *
    349-
    * @param array $values
    350-
    *
    351346
    * @return array
    352-
    *
    353347
    * @see ChoiceListInterface
    354348
    * @deprecated since version 2.4, to be removed in 3.0.
    355349
    */

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

    Lines changed: 2 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -327,10 +327,8 @@ public function configureOptions(OptionsResolver $resolver)
    327327
    /**
    328328
    * Return the default loader object.
    329329
    *
    330-
    * @param ObjectManager $manager
    331-
    * @param mixed $queryBuilder
    332-
    * @param string $class
    333-
    *
    330+
    * @param mixed $queryBuilder
    331+
    * @param string $class
    334332
    * @return EntityLoaderInterface
    335333
    */
    336334
    abstract public function getLoader(ObjectManager $manager, $queryBuilder, $class);

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

    Lines changed: 2 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -46,10 +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
    52-
    *
    49+
    * @param QueryBuilder $queryBuilder
    50+
    * @param string $class
    5351
    * @return ORMQueryBuilderLoader
    5452
    */
    5553
    public function getLoader(ObjectManager $manager, $queryBuilder, $class)

    ‎src/Symfony/Bridge/Doctrine/HttpFoundation/DbalSessionHandler.php

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -54,8 +54,7 @@ class DbalSessionHandler implements \SessionHandlerInterface
    5454
    private $timeCol = 'sess_time';
    5555

    5656
    /**
    57-
    * @param Connection $con A connection
    58-
    * @param string $tableName Table name
    57+
    * @param string $tableName Table name
    5958
    */
    6059
    public function __construct(Connection $con, $tableName = 'sessions')
    6160
    {

    ‎src/Symfony/Bridge/Doctrine/Tests/DependencyInjection/DoctrineExtensionTest.php

    Lines changed: 0 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -187,8 +187,6 @@ public function providerBasicDrivers()
    187187

    188188
    /**
    189189
    * @param string $class
    190-
    * @param array $config
    191-
    *
    192190
    * @dataProvider providerBasicDrivers
    193191
    */
    194192
    public function testLoadBasicCacheDriver($class, array $config, array $expectedCalls = array())

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

    Lines changed: 1 addition & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -33,9 +33,7 @@ public function __construct(ManagerRegistry $registry)
    3333
    }
    3434

    3535
    /**
    36-
    * @param object $entity
    37-
    * @param Constraint $constraint
    38-
    *
    36+
    * @param object $entity
    3937
    * @throws UnexpectedTypeException
    4038
    * @throws ConstraintDefinitionException
    4139
    */

    ‎src/Symfony/Bridge/ProxyManager/Tests/LazyProxy/PhpDumper/ProxyDumperTest.php

    Lines changed: 1 addition & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -37,9 +37,7 @@ protected function setUp()
    3737

    3838
    /**
    3939
    * @dataProvider getProxyCandidates
    40-
    *
    41-
    * @param Definition $definition
    42-
    * @param bool $expected
    40+
    * @param bool $expected
    4341
    */
    4442
    public function testIsProxyCandidate(Definition $definition, $expected)
    4543
    {

    ‎src/Symfony/Bridge/Swiftmailer/DataCollector/MessageDataCollector.php

    Lines changed: 1 addition & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -34,8 +34,7 @@ class MessageDataCollector extends DataCollector
    3434
    * We don't inject the message logger and mailer here
    3535
    * to avoid the creation of these objects when no emails are sent.
    3636
    *
    37-
    * @param ContainerInterface $container A ContainerInterface instance
    38-
    * @param bool $isSpool
    37+
    * @param bool $isSpool
    3938
    */
    4039
    public function __construct(ContainerInterface $container, $isSpool)
    4140
    {

    ‎src/Symfony/Bridge/Twig/NodeVisitor/TranslationNodeVisitor.php

    Lines changed: 1 addition & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -104,9 +104,7 @@ public function getPriority()
    104104
    }
    105105

    106106
    /**
    107-
    * @param Node $arguments
    108-
    * @param int $index
    109-
    *
    107+
    * @param int $index
    110108
    * @return string|null
    111109
    */
    112110
    private function getReadDomainFromArguments(Node $arguments, $index)

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

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

    3131
    /**
    32-
    * @param KernelInterface $kernel A KernelInterface instance
    33-
    * @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
    34-
    * @param string $rootDir The directory where global templates can be stored
    32+
    * @param string $rootDir The directory where global templates can be stored
    3533
    */
    3634
    public function __construct(KernelInterface $kernel, TemplateNameParserInterface $parser, $rootDir)
    3735
    {

    ‎src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php

    Lines changed: 3 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -173,11 +173,9 @@ protected function warmup($warmupDir, $realCacheDir, $enableOptionalWarmers = tr
    173173
    }
    174174

    175175
    /**
    176-
    * @param KernelInterface $parent
    177-
    * @param string $namespace
    178-
    * @param string $parentClass
    179-
    * @param string $warmupDir
    180-
    *
    176+
    * @param string $namespace
    177+
    * @param string $parentClass
    178+
    * @param string $warmupDir
    181179
    * @return KernelInterface
    182180
    */
    183181
    protected function getTempKernel(KernelInterface $parent, $namespace, $parentClass, $warmupDir)

    ‎src/Symfony/Bundle/FrameworkBundle/Command/ServerStartCommand.php

    Lines changed: 5 additions & 9 deletions
    Original file line numberDiff line numberDiff line change
    @@ -171,10 +171,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
    171171
    * Determine the absolute file path for the router script, using the environment to choose a standard script
    172172
    * if no custom router script is specified.
    173173
    *
    174-
    * @param string|null $router File path of the custom router script, if set by the user; otherwise null
    175-
    * @param string $env The application environment
    176-
    * @param OutputInterface $output An OutputInterface instance
    177-
    *
    174+
    * @param string|null $router File path of the custom router script, if set by the user; otherwise null
    175+
    * @param string $env The application environment
    178176
    * @return string|bool The absolute file path of the router script, or false on failure
    179177
    */
    180178
    private function determineRouterScript($router, $env, OutputInterface $output)
    @@ -199,11 +197,9 @@ private function determineRouterScript($router, $env, OutputInterface $output)
    199197
    /**
    200198
    * Creates a process to start PHP's built-in web server.
    201199
    *
    202-
    * @param OutputInterface $output A OutputInterface instance
    203-
    * @param string $address IP address and port to listen to
    204-
    * @param string $documentRoot The application's document root
    205-
    * @param string $router The router filename
    206-
    *
    200+
    * @param string $address IP address and port to listen to
    201+
    * @param string $documentRoot The application's document root
    202+
    * @param string $router The router filename
    207203
    * @return Process The process
    208204
    */
    209205
    private function createServerProcess(OutputInterface $output, $address, $documentRoot, $router)

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

    Lines changed: 4 additions & 11 deletions
    Original file line numberDiff line numberDiff line change
    @@ -104,8 +104,7 @@ protected function write($content, $decorated = false)
    104104
    /**
    105105
    * Writes content to output.
    106106
    *
    107-
    * @param Table $table
    108-
    * @param bool $decorated
    107+
    * @param bool $decorated
    109108
    */
    110109
    protected function renderTable(Table $table, $decorated = false)
    111110
    {
    @@ -144,8 +143,7 @@ abstract protected function describeContainerTags(ContainerBuilder $builder, arr
    144143
    * Common options are:
    145144
    * * name: name of described service
    146145
    *
    147-
    * @param Definition|Alias|object $service
    148-
    * @param array $options
    146+
    * @param Definition|\Alias|object $service
    149147
    */
    150148
    abstract protected function describeContainerService($service, array $options = array());
    151149

    @@ -184,7 +182,6 @@ abstract protected function describeEventDispatcherListeners(EventDispatcherInte
    184182
    * Describes a callable.
    185183
    *
    186184
    * @param callable $callable
    187-
    * @param array $options
    188185
    */
    189186
    abstract protected function describeCallable($callable, array $options = array());
    190187

    @@ -231,9 +228,7 @@ protected function formatParameter($value)
    231228
    }
    232229

    233230
    /**
    234-
    * @param ContainerBuilder $builder
    235-
    * @param string $serviceId
    236-
    *
    231+
    * @param string $serviceId
    237232
    * @return mixed
    238233
    */
    239234
    protected function resolveServiceDefinition(ContainerBuilder $builder, $serviceId)
    @@ -256,9 +251,7 @@ protected function resolveServiceDefinition(ContainerBuilder $builder, $serviceI
    256251
    }
    257252

    258253
    /**
    259-
    * @param ContainerBuilder $builder
    260-
    * @param bool $showPrivate
    261-
    *
    254+
    * @param bool $showPrivate
    262255
    * @return array
    263256
    */
    264257
    protected function findDefinitionsByTag(ContainerBuilder $builder, $showPrivate)

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

    Lines changed: 2 additions & 8 deletions
    Original file line numberDiff line numberDiff line change
    @@ -199,9 +199,7 @@ protected function getRouteData(Route $route)
    199199
    }
    200200

    201201
    /**
    202-
    * @param Definition $definition
    203-
    * @param bool $omitTags
    204-
    *
    202+
    * @param bool $omitTags
    205203
    * @return array
    206204
    */
    207205
    private function getContainerDefinitionData(Definition $definition, $omitTags = false)
    @@ -274,9 +272,7 @@ private function getContainerAliasData(Alias $alias)
    274272
    }
    275273

    276274
    /**
    277-
    * @param EventDispatcherInterface $eventDispatcher
    278-
    * @param string|null $event
    279-
    *
    275+
    * @param string|null $event
    280276
    * @return array
    281277
    */
    282278
    private function getEventDispatcherListenersData(EventDispatcherInterface $eventDispatcher, $event = null)
    @@ -303,8 +299,6 @@ private function getEventDispatcherListenersData(EventDispatcherInterface $event
    303299

    304300
    /**
    305301
    * @param callable $callable
    306-
    * @param array $options
    307-
    *
    308302
    * @return array
    309303
    */
    310304
    private function getCallableData($callable, array $options = array())

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

    Lines changed: 0 additions & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -435,7 +435,6 @@ private function formatCallable($callable)
    435435

    436436
    /**
    437437
    * @param string $content
    438-
    * @param array $options
    439438
    */
    440439
    private function writeText($content, array $options = array())
    441440
    {

    0 commit comments

    Comments
     (0)
    0