8000 minor #32974 "An instance of X" phpdocs removal (fabpot) · symfony/symfony@94a0719 · GitHub
[go: up one dir, main page]
Skip to content

Commit 94a0719

Browse files
nicolas-grekasnicolas-grekas
committed
minor #32974 "An instance of X" phpdocs removal (fabpot)
This PR was merged into the 4.4 branch. Discussion ---------- "An instance of X" phpdocs removal | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - That's #32973 on 4.4 :P Commits ------- 7a44ed6 removed unneeded phpdocs
2 parents 34e8676 + 7a44ed6 commit 94a0719

Some content is hidden

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

43 files changed

+77
-171
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ abstract class AbstractDoctrineExtension extends Extension
3535
protected $drivers = [];
3636

3737
/**
38-
* @param array $objectManager A configured object manager
39-
* @param ContainerBuilder $container A ContainerBuilder instance
38+
* @param array $objectManager A configured object manager
4039
*
4140
* @throws \InvalidArgumentException
4241
*/

‎src/Symfony/Bundle/FrameworkBundle/HttpCache/HttpCache.php

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ class HttpCache extends BaseHttpCache
2929
protected $kernel;
3030

3131
/**
32-
* @param KernelInterface $kernel A KernelInterface instance
33-
* @param string $cacheDir The cache directory (default used if null)
32+
* @param string $cacheDir The cache directory (default used if null)
3433
*/
3534
public function __construct(KernelInterface $kernel, string $cacheDir = null)
3635
{
@@ -43,9 +42,8 @@ public function __construct(KernelInterface $kernel, string $cacheDir = null)
4342
/**
4443
* Forwards the Request to the backend and returns the Response.
4544
*
46-
* @param Request $request A Request instance
47-
* @param bool $raw Whether to catch exceptions or not
48-
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
45+
* @param bool $raw Whether to catch exceptions or not
46+
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
4947
*
5048
* @return Response A Response instance
5149
*/

‎src/Symfony/Bundle/FrameworkBundle/Routing/Router.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,8 @@ class Router extends BaseRouter implements WarmableInterface, ServiceSubscriberI
3636
private $paramFetcher;
3737

3838
/**
39-
* @param ContainerInterface $container A ContainerInterface instance
40-
* @param mixed $resource The main resource to load
41-
* @param array $options An array of options
42-
* @param RequestContext $context The context
43-
* @param ContainerInterface|null $parameters A ContainerInterface instance allowing to fetch parameters
44-
* @param LoggerInterface|null $logger
39+
* @param mixed $resource The main resource to load
40+
* @param array $options An array of options
4541
*/
4642
public function __construct(ContainerInterface $container, $resource, array $options = [], RequestContext $context = null, ContainerInterface $parameters = null, LoggerInterface $logger = null, string $defaultLocale = null)
4743
{

‎src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,9 @@ class Translator extends BaseTranslator implements WarmableInterface
6565
* * debug: Whether to enable debugging or not (false by default)
6666
* * resource_files: List of translation resources available grouped by locale.
6767
*
68-
* @param ContainerInterface $container A ContainerInterface instance
69-
* @param MessageFormatterInterface $formatter The message formatter
70-
* @param string $defaultLocale
71-
* @param array $loaderIds An array of loader Ids
72-
* @param array $options An array of options
68+
* @param string $defaultLocale
69+
* @param array $loaderIds An array of loader Ids
70+
* @param array $options An array of options
7371
*
7472
* @throws InvalidArgumentException
7573
*/

‎src/Symfony/Bundle/TwigBundle/TemplateIterator.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,9 @@ class TemplateIterator implements \IteratorAggregate
3030
private $defaultPath;
3131

3232
/**
33-
* @param KernelInterface $kernel A KernelInterface instance
34-
* @param string $rootDir The directory where global templates can be stored
35-
* @param array $paths Additional Twig paths to warm
36-
* @param string|null $defaultPath The directory where global templates can be stored
33+
* @param string $rootDir The directory where global templates can be stored
34+
* @param array $paths Additional Twig paths to warm
35+
* @param string|null $defaultPath The directory where global templates can be stored
3736
*/
3837
public function __construct(KernelInterface $kernel, string $rootDir, array $paths = [], string $defaultPath = null)
3938
{

‎src/Symfony/Bundle/WebProfilerBundle/DependencyInjection/WebProfilerExtension.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ class WebProfilerExtension extends Extension
3737
/**
3838
* Loads the web profiler configuration.
3939
*
40-
* @param array $configs An array of configuration settings
41-
* @param ContainerBuilder $container A ContainerBuilder instance
40+
* @param array $configs An array of configuration settings
4241
*/
4342
public function load(array $configs, ContainerBuilder $container)
4443
{

‎src/Symfony/Component/BrowserKit/CookieJar.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,7 @@ public function updateFromSetCookie(array $setCookies, $uri = null)
140140
/**
141141
* Updates the cookie jar from a Response object.
142142
*
143-
* @param Response $response A Response object
144-
* @param string $uri The base URL
143+
* @param string $uri The base URL
145144
*/
146145
public function updateFromResponse(Response $response, $uri = null)
147146
{

‎src/Symfony/Component/Console/Helper/ProgressBar.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ final class ProgressBar
5252
private static $formats;
5353

5454
/**
55-
* @param OutputInterface $output An OutputInterface instance
56-
* @param int $max Maximum steps (0 if unknown)
55+
* @param int $max Maximum steps (0 if unknown)
5756
*/
5857
public function __construct(OutputInterface $output, int $max = 0, float $minSecondsBetweenRedraws = 0.1)
5958
{

‎src/Symfony/Component/Console/Helper/QuestionHelper.php

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -353,9 +353,8 @@ private function mostRecentlyEnteredValue(string $entered)
353353
/**
354354
* Gets a hidden response from user.
355355
*
356-
* @param OutputInterface $output An Output instance
357-
* @param resource $inputStream The handler resource
358-
* @param bool $trimmable Is the answer trimmable
356+
* @param resource $inputStream The handler resource
357+
* @param bool $trimmable Is the answer trimmable
359358
*
360359
* @throws RuntimeException In case the fallback is deactivated and the response cannot be hidden
361360
*/
@@ -416,9 +415,7 @@ private function getHiddenResponse(OutputInterface $output, $inputStream, bool $
416415
/**
417416
* Validates an attempt.
418417
*
419-
* @param callable $interviewer A callable that will ask for a question and return the result
420-
* @param OutputInterface $output An Output instance
421-
* @param Question $question A Question instance
418+
* @param callable $interviewer A callable that will ask for a question and return the result
422419
*
423420
* @return mixed The validated response
424421
*

‎src/Symfony/Component/ErrorHandler/FatalErrorHandler/FatalErrorHandlerInterface.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ interface FatalErrorHandlerInterface
2323
/**
2424
* Attempts to convert an error into an exception.
2525
*
26-
* @param array $error An array as returned by error_get_last()
27-
* @param FatalErrorException $exception A FatalErrorException instance
26+
* @param array $error An array as returned by error_get_last()
2827
*
2928
* @return FatalErrorException|null A FatalErrorException instance if the class is able to convert the error, null otherwise
3029
*/

‎src/Symfony/Component/ExpressionLanguage/ParsedExpression.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@ class ParsedExpression extends Expression
2222
{
2323
private $nodes;
2424

25-
/**
26-
* @param string $expression An expression
27-
* @param Node $nodes A Node representing the expression
28-
*/
2925
public function __construct(string $expression, Node $nodes)
3026
{
3127
parent::__construct($expression);

‎src/Symfony/Component/HttpFoundation/Session/Session.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable
3131
private $data = [];
3232
private $usageIndex = 0;
3333

34-
/**
35-
* @param SessionStorageInterface $storage A SessionStorageInterface instance
36-
* @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
37-
* @param FlashBagInterface $flashes A FlashBagInterface instance (defaults null for default FlashBag)
38-
*/
3934
public function __construct(SessionStorageInterface $storage = null, AttributeBagInterface $attributes = null, FlashBagInterface $flashes = null)
4035
{
4136
$this->storage = $storage ?: new NativeSessionStorage();

‎src/Symfony/Component/HttpKernel/Config/FileLocator.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ class FileLocator extends BaseFileLocator
2525
private $path;
2626

2727
/**
28-
* @param KernelInterface $kernel A KernelInterface instance
29-
* @param string|null $path The path the global resource directory
30-
* @param array $paths An array of paths where to look for resources
28+
* @param string|null $path The path the global resource directory
29+
* @param array $paths An array of paths where to look for resources
3130
*/
3231
public function __construct(KernelInterface $kernel, string $path = null, array $paths = [])
3332
{

‎src/Symfony/Component/HttpKernel/EventListener/FragmentListener.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ class FragmentListener implements EventSubscriberInterface
3737
private $fragmentPath;
3838

3939
/**
40-
* @param UriSigner $signer A UriSigner instance
41-
* @param string $fragmentPath The path that triggers this listener
40+
* @param string $fragmentPath The path that triggers this listener
4241
*/
4342
public function __construct(UriSigner $signer, string $fragmentPath = '/_fragment')
4443
{

‎src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ class LocaleListener implements EventSubscriberInterface
3434
private $requestStack;
3535

3636
/**
37-
* @param RequestStack $requestStack A RequestStack instance
3837
* @param string $defaultLocale The default locale
3938
* @param RequestContextAwareInterface|null $router The router
4039
*/

‎src/Symfony/Component/HttpKernel/EventListener/ProfilerListener.php

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,8 @@ class ProfilerListener implements EventSubscriberInterface
3939
protected $parents;
4040

4141
/**
42-
* @param Profiler $profiler A Profiler instance
43-
* @param RequestStack $requestStack A RequestStack instance
44-
* @param RequestMatcherInterface|null $matcher A RequestMatcher instance
45-
* @param bool $onlyException True if the profiler only collects data when an exception occurs, false otherwise
46-
* @param bool $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
42+
* @param bool $onlyException True if the profiler only collects data when an exception occurs, false otherwise
43+
* @param bool $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
4744
*/
4845
public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMasterRequests = false)
4946
{

‎src/Symfony/Component/HttpKernel/EventListener/RouterListener.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,9 @@ class RouterListener implements EventSubscriberInterface
5050
private $debug;
5151

5252
/**
53-
* @param UrlMatcherInterface|RequestMatcherInterface $matcher The Url or Request matcher
54-
* @param RequestStack $requestStack A RequestStack instance
55-
* @param RequestContext|null $context The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
56-
* @param LoggerInterface|null $logger The logger
53+
* @param UrlMatcherInterface|RequestMatcherInterface $matcher The Url or Request matcher
54+
* @param RequestContext|null $context The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
55+
* @param LoggerInterface|null $logger The logger
5756
* @param string $projectDir
5857
* @param bool $debug
5958
*

‎src/Symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ abstract class AbstractSurrogateFragmentRenderer extends RoutableFragmentRendere
3232
* The "fallback" strategy when surrogate is not available should always be an
3333
* instance of InlineFragmentRenderer.
3434
*
35-
* @param SurrogateInterface $surrogate An Surrogate instance
3635
* @param FragmentRendererInterface $inlineStrategy The inline strategy to use when the surrogate is not supported
3736
* @param UriSigner $signer
3837
*/

‎src/Symfony/Component/HttpKernel/Fragment/FragmentRendererInterface.php

Lines changed: 0 additions & 1 deletion
Original fi 10000 le line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ interface FragmentRendererInterface
2626
* Renders a URI and returns the Response content.
2727
*
2828
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
29-
* @param Request $request A Request instance
3029
* @param array $options An array of options
3130
*
3231
* @return Response A Response instance

‎src/Symfony/Component/HttpKernel/Fragment/RoutableFragmentRenderer.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,8 @@ public function setFragmentPath($path)
3939
/**
4040
* Generates a fragment URI for a given controller.
4141
*
42-
* @param ControllerReference $reference A ControllerReference instance
43-
* @param Request $request A Request instance
44-
* @param bool $absolute Whether to generate an absolute URL or not
45-
* @param bool $strict Whether to allow non-scalar attributes or not
42+
* @param bool $absolute Whether to generate an absolute URL or not
43+
* @param bool $strict Whether to allow non-scalar attributes or not
4644
*
4745
* @return string A fragment URI
4846
*/

‎src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,7 @@ public function terminate(Request $request, Response $response)
256256
/**
257257
* Forwards the Request to the backend without storing the Response in the cache.
258258
*
259-
* @param Request $request A Request instance
260-
* @param bool $catch Whether to process exceptions
259+
* @param bool $catch Whether to process exceptions
261260
*
262261
* @return Response A Response instance
263262
*/
@@ -271,8 +270,7 @@ protected function pass(Request $request, $catch = false)
271270
/**
272271
* Invalidates non-safe methods (like POST, PUT, and DELETE).
273272
*
274-
* @param Request $request A Request instance
275-
* @param bool $catch Whether to process exceptions
273+
* @param bool $catch Whether to process exceptions
276274
*
277275
* @return Response A Response instance
278276
*
@@ -320,8 +318,7 @@ protected function invalidate(Request $request, $catch = false)
320318
* the backend using conditional GET. When no matching cache entry is found,
321319
* it triggers "miss" processing.
322320
*
323-
* @param Request $request A Request instance
324-
* @param bool $catch Whether to process exceptions
321+
* @param bool $catch Whether to process exceptions
325322
*
326323
* @return Response A Response instance
327324
*
@@ -366,9 +363,7 @@ protected function lookup(Request $request, $catch = false)
366363
* The original request is used as a template for a conditional
367364
* GET request with the backend.
368365
*
369-
* @param Request $request A Request instance
370-
* @param Response $entry A Response instance to validate
371-
* @param bool $catch Whether to process exceptions
366+
* @param bool $catch Whether to process exceptions
372367
*
373368
* @return Response A Response instance
374369
*/
@@ -429,8 +424,7 @@ protected function validate(Request $request, Response $entry, $catch = false)
429424
* Unconditionally fetches a fresh response from the backend and
430425
* stores it in the cache if is cacheable.
431426
*
432-
* @param Request $request A Request instance
433-
* @param bool $catch Whether to process exceptions
427+
* @param bool $catch Whether to process exceptions
434428
*
435429
* @return Response A Response instance
436430
*/
@@ -462,9 +456,8 @@ protected function fetch(Request $request, $catch = false)
462456
* All backend requests (cache passes, fetches, cache validations)
463457
* run through this method.
464458
*
465-
* @param Request $request A Request instance
466-
* @param bool $catch Whether to catch exceptions or not
467-
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
459+
* @param bool $catch Whether to catch exceptions or not
460+
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
468461
*
469462
* @return Response A Response instance
470463
*/

‎src/Symfony/Component/HttpKernel/HttpCache/SurrogateInterface.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,9 @@ public function process(Request $request, Response $response);
7878
/**
7979
* Handles a Surrogate from the cache.
8080
*
81-
* @param HttpCache $cache An HttpCache instance
82-
* @param string $uri The main URI
83-
* @param string $alt An alternative URI
84-
* @param bool $ignoreErrors Whether to ignore errors or not
81+
* @param string $uri The main URI
82+
* @param string $alt An alternative URI
83+
* @param bool $ignoreErrors Whether to ignore errors or not
8584
*
8685
* @return string
8786
*

‎src/Symfony/Component/HttpKernel/HttpKernel.php

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,7 @@ public function terminateWithException(\Exception $exception, Request $request =
110110
*
111111
* Exceptions are not caught.
112112
*
113-
* @param Request $request A Request instance
114-
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
113+
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
115114
*
116115
* @return Response A Response instance
117116
*
@@ -175,9 +174,8 @@ private function handleRaw(Request $request, int $type = self::MASTER_REQUEST)
175174
/**
176175
* Filters a response object.
177176
*
178-
* @param Response $response A Response instance
179-
* @param Request $request An error message in case the response is not a Response object
180-
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
177+
* @param Request $request An error message in case the response is not a Response object
178+
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
181179
*
182180
* @return Response The filtered Response instance
183181
*
@@ -210,9 +208,8 @@ private function finishRequest(Request $request, int $type)
210208
/**
211209
* Handles an exception by trying to convert it to a Response.
212210
*
213-
* @param \Exception $e An \Exception instance
214-
* @param Request $request A Request instance
215-
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
211+
* @param \Exception $e An \Exception instance
212+
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
216213
*
217214
* @throws \Exception
218215
*/

‎src/Symfony/Component/HttpKernel/HttpKernelInterface.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,9 @@ interface HttpKernelInterface
3030
* When $catch is true, the implementation must catch all exceptions
3131
* and do its best to convert them to a Response instance.
3232
*
33-
* @param Request $request A Request instance
34-
* @param int $type The type of the request
35-
* (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
36-
* @param bool $catch Whether to catch exceptions or not
33+
* @param int $type The type of the request
34+
* (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
35+
* @param bool $catch Whether to catch exceptions or not
3736
*
3837
* @return Response A Response instance
3938
*

‎src/Symfony/Component/Ldap/Adapter/AbstractConnection.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,6 @@ public function __construct(array $config = [])
3030
$this->config = $resolver->resolve($config);
3131
}
3232

33-
/**
34-
* Configures the adapter's options.
35-
*
36-
* @param OptionsResolver $resolver An OptionsResolver instance
37-
*/
3833
protected function configureOptions(OptionsResolver $resolver)
3934
{
4035
$resolver->setDefaults([

0 commit comments

Comments
 (0)
0