8000 minor #22211 Fix @param in PHPDoc (GromNaN) · symfony/symfony@924337f · GitHub
[go: up one dir, main page]
Skip to content

Commit 924337f

Browse files
fabpotfabpot
committed
minor #22211 Fix @param in PHPDoc (GromNaN)
This PR was merged into the 3.2 branch. Discussion ---------- Fix @param in PHPDoc | Q | A | ------------- | --- | Branch? | 3.2 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | no | License | MIT | Doc PR | no Errors reported by Sami API Doc generator on branch 3.2 ``` ERROR: The "factory" @param tag variable name is wrong (should be "objectLoader") on "Symfony\Bridge\Doctrine\Form\ChoiceList\DoctrineChoiceLoader::__construct" in src/Symfony/Bridge/Doctrine/Form/ChoiceList/DoctrineChoiceLoader.php:68 ERROR: The "objectLoader" @param tag variable name is wrong (should be "factory") on "Symfony\Bridge\Doctrine\Form\ChoiceList\DoctrineChoiceLoader::__construct" in src/Symfony/Bridge/Doctrine/Form/ChoiceList/DoctrineChoiceLoader.php:68 ERROR: "7" @param tags are expected but only "6" found on "Symfony\Bundle\WebProfilerBundle\Controller\ProfilerController::__construct" in src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php:50 ERROR: "3" @param tags are expected but only "2" found on "Symfony\Component\Asset\PathPackage::__construct" in src/Symfony/Component/Asset/PathPackage.php:35 ERROR: "2" @param tags are expected but only "1" found on "Symfony\Component\Cache\Adapter\PhpArrayAdapter::create" in src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php:64 ERROR: "3" @param tags are expected but only "1" found on "Symfony\Component\Cache\Adapter\RedisAdapter::__construct" in src/Symfony/Component/Cache/Adapter/RedisAdapter.php:39 ERROR: The "format" @param tag variable name is wrong (should be "fileLinkFormat") on "Symfony\Component\Debug\ExceptionHandler::setFileLinkFormat" in src/Symfony/Component/Debug/ExceptionHandler.php:90 ERROR: "2" @param tags are expected but only "3" found on "Symfony\Component\DependencyInjection\Compiler\Compiler::addPass" in src/Symfony/Component/DependencyInjection/Compiler/Compiler.php:73 ERROR: "2" @param tags are expected but only "3" found on "Symfony\Component\DependencyInjection\Compiler\PassConfig::addPass" in src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php:97 ERROR: "2" @param tags are expected but only "3" found on "Symfony\Component\DependencyInjection\ContainerBuilder::addCompilerPass" in src/Symfony/Component/DependencyInjection/ContainerBuilder.php:311 ERROR: "2" @param tags are expected but only "3" found on "Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface::getProxyFactoryCode" in src/Symfony/Component/DependencyInjection/LazyProxy/PhpDumper/DumperInterface.php:41 ERROR: "0" @param tags are expected but only "1" found on "Symfony\Component\HttpFoundation\Request::isMethodSafe" in src/Symfony/Component/HttpFoundation/Request.php:1458 ERROR: "5" @param tags are expected but only "6" found on "Symfony\Component\Serializer\Normalizer\AbstractNormalizer::instantiateObject" in src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php:291 ``` Errors that cannot be fixed are due to new arguments not included in the method signature for backward compatibility, but actually used by the code. Commits ------- 6ed9d0e Fix @param in PHPDoc
2 parents 8f090bc + 6ed9d0e commit 924337f

File tree

6 files changed

+15
-10
lines changed

6 files changed

+15
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ class DoctrineChoiceLoader implements ChoiceLoaderInterface
6161
* loaded objects
6262
* @param IdReader $idReader The reader for the object
6363
* IDs.
64+
* @param null|EntityLoaderInterface $objectLoader The objects loader
6465
* @param ChoiceListFactoryInterface $factory The factory for creating
6566
* the loaded choice list
66-
* @param null|EntityLoaderInterface $objectLoader The objects loader
6767
*/
6868
public function __construct($manager, $class, $idReader = null, $objectLoader = null, $factory = null)
6969
{

‎src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,13 @@ class ProfilerController
4040
/**
4141
* Constructor.
4242
*
43-
* @param UrlGeneratorInterface $generator The URL Generator
44-
* @param Profiler $profiler The profiler
45-
* @param \Twig_Environment $twig The twig environment
46-
* @param array $templates The templates
47-
* @param string $toolbarPosition The toolbar position (top, bottom, normal, or null -- use the configuration)
48-
* @param string $baseDir The project root directory
43+
* @param UrlGeneratorInterface $generator The URL Generator
44+
* @param Profiler $profiler The profiler
45+
* @param \Twig_Environment $twig The twig environment
46+
* @param array $templates The templates
47+
* @param string $toolbarPosition The toolbar position (top, bottom, normal, or null -- use the configuration)
48+
* @param ContentSecurityPolicyHandler $cspHandler The Content-Security-Policy handler
49+
* @param string $baseDir The project root directory
4950
*/
5051
public function __construct(UrlGeneratorInterface $generator, Profiler $profiler = null, \Twig_Environment $twig, array $templates, $toolbarPosition = 'bottom', ContentSecurityPolicyHandler $cspHandler = null, $baseDir = null)
5152
{

‎src/Symfony/Component/Asset/PathPackage.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ class PathPackage extends Package
3131
/**
3232
* @param string $basePath The base path to be prepended to relative paths
3333
* @param VersionStrategyInterface $versionStrategy The version strategy
34+
* @param ContextInterface|null $context The context
3435
*/
3536
public function __construct($basePath, VersionStrategyInterface $versionStrategy, ContextInterface $context = null)
3637
{

‎src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ function ($key, $value, $isHit) {
5757
* stores arrays in its latest versions. This factory method decorates the given
5858
* fallback pool with this adapter only if the current PHP version is supported.
5959
*
60-
* @param string $file The PHP file were values are cached
60+
* @param string $file The PHP file were values are cached
61+
* @param CacheItemPoolInterface $fallbackPool Fallback for old PHP versions or opcache disabled
6162
*
6263
* @return CacheItemPoolInterface
6364
*/

‎src/Symfony/Component/Cache/Adapter/RedisAdapter.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ class RedisAdapter extends AbstractAdapter
3434
private $redis;
3535

3636
/**
37-
* @param \Redis|\RedisArray|\RedisCluster|\Predis\Client $redisClient
37+
* @param \Redis|\RedisArray|\RedisCluster|\Predis\Client $redisClient The redis client
38+
* @param string $namespace The default namespace
39+
* @param integer $defaultLifetime The default lifetime
3840
*/
3941
public function __construct($redisClient, $namespace = '', $defaultLifetime = 0)
4042
{

‎src/Symfony/Component/Debug/ExceptionHandler.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public function setHandler(callable $handler = null)
8383
/**
8484
* Sets the format for links to source files.
8585
*
86-
* @param string|FileLinkFormatter $format The format for links to source files
86+
* @param string|FileLinkFormatter $fileLinkFormat The format for links to source files
8787
*
8888
* @return string The previous file link format
8989
*/

0 commit comments

Comments
 (0)
0