Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 8f36bbd

Browse filesBrowse files
nicolas-grekasnicolas-grekas
committed
Cleanup more @return annotations
1 parent 21f801e commit 8f36bbd
Copy full SHA for 8f36bbd

File tree

Expand file treeCollapse file tree

396 files changed

+1106
-1182
lines changed
Filter options

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree

396 files changed

+1106
-1182
lines changed

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

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, string
259259
/**
260260
* Detects what metadata driver to use for the supplied directory.
261261
*
262-
* @return string|null A metadata driver short name, if one can be detected
262+
* @return string|null
263263
*/
264264
protected function detectMetadataDriver(string $dir, ContainerBuilder $container)
265265
{
@@ -379,7 +379,7 @@ protected function loadCacheDriver(string $cacheName, string $objectManagerName,
379379
*
380380
* The manager called $autoMappedManager will map all bundles that are not mapped by other managers.
381381
*
382-
* @return array The modified version of $managerConfigs
382+
* @return array
383383
*/
384384
protected function fixManagersAutoMappings(array $managerConfigs, array $bundles)
385385
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterMappingsPass.php
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ public function process(ContainerBuilder $container)
165165
* Get the service name of the metadata chain driver that the mappings
166166
* should be registered with.
167167
*
168-
* @return string The name of the chain driver service
168+
* @return string
169169
*
170170
* @throws InvalidArgumentException if non of the managerParameters has a
171171
* non-empty value
@@ -181,7 +181,7 @@ protected function getChainDriverServiceName(ContainerBuilder $container)
181181
* @param ContainerBuilder $container Passed on in case an extending class
182182
* needs access to the container
183183
*
184-
* @return Definition|Reference the metadata driver to add to all chain drivers
184+
* @return Definition|Reference
185185
*/
186186
protected function getDriver(ContainerBuilder $container)
187187
{
@@ -228,7 +228,7 @@ private function getManagerName(ContainerBuilder $container): string
228228
* This default implementation checks if the class has the enabledParameter
229229
* configured and if so if that parameter is present in the container.
230230
*
231-
* @return bool whether this compiler pass really should register the mappings
231+
* @return bool
232232
*/
233233
protected function enabled(ContainerBuilder $container)
234234
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/Form/ChoiceList/EntityLoaderInterface.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ interface EntityLoaderInterface
2121
/**
2222
* Returns an array of entities that are valid choices in the corresponding choice list.
2323
*
24-
* @return array The entities
24+
* @return array
2525
*/
2626
public function getEntities();
2727

2828
/**
2929
* Returns an array of entities matching the given identifiers.
3030
*
31-
* @return array The entities
31+
* @return array
3232
*/
3333
public function getEntitiesByIds(string $identifier, array $values);
3434
}

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

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/Form/ChoiceList/IdReader.php
+1-9Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,6 @@ public function __construct(ObjectManager $om, ClassMetadata $classMetadata)
5959

6060
/**
6161
* Returns whether the class has a single-column ID.
62-
*
63-
* @return bool returns `true` if the class has a single-column ID and
64-
* `false` otherwise
6562
*/
6663
public function isSingleId(): bool
6764
{
@@ -70,9 +67,6 @@ public function isSingleId(): bool
7067

7168
/**
7269
* Returns whether the class has a single-column integer ID.
73-
*
74-
* @return bool returns `true` if the class has a single-column integer ID
75-
* and `false` otherwise
7670
*/
7771
public function isIntId(): bool
7872
{
@@ -84,7 +78,7 @@ public function isIntId(): bool
8478
*
8579
* This method assumes that the object has a single-column ID.
8680
*
87-
* @return string The ID value
81+
* @return string
8882
*/
8983
public function getIdValue(object $object = null)
9084
{
@@ -111,8 +105,6 @@ public function getIdValue(object $object = null)
111105
* Returns the name of the ID field.
112106
*
113107
* This method assumes that the object has a single-column ID.
114-
*
115-
* @return string The name of the ID field
116108
*/
117109
public function getIdField(): string
118110
{

‎src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class CollectionToArrayTransformer implements DataTransformerInterface
2424
/**
2525
* Transforms a collection into an array.
2626
*
27-
* @return mixed An array of entities
27+
* @return mixed
2828
*
2929
* @throws TransformationFailedException
3030
*/
@@ -52,7 +52,7 @@ public function transform($collection)
5252
*
5353
* @param mixed $array An array of entities
5454
*
55-
* @return Collection A collection of entities
55+
* @return Collection
5656
*/
5757
public function reverseTransform($array)
5858
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php
-3Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,6 @@ public static function createChoiceName(object $choice, $key, string $value): st
8686
* @param object $queryBuilder A query builder, type declaration is not present here as there
8787
* is no common base class for the different implementations
8888
*
89-
* @return array|null Array with important QueryBuilder parts or null if
90-
* they can't be determined
91-
*
9289
* @internal This method is public to be usable as callback. It should not
9390
* be used in user code.
9491
*/

‎src/Symfony/Bridge/Monolog/Tests/Handler/MailerHandlerTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Monolog/Tests/Handler/MailerHandlerTest.php
+2-8Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,7 @@ public function testHtmlContent()
9191
$handler->handle($this->getRecord(Logger::WARNING, 'message'));
9292
}
9393

94-
/**
95-
* @return array Record
96-
*/
97-
protected function getRecord($level = Logger::WARNING, $message = 'test', $context = [])
94+
protected function getRecord($level = Logger::WARNING, $message = 'test', $context = []): array
9895
{
9996
return [
10097
'message' => $message,
@@ -107,10 +104,7 @@ protected function getRecord($level = Logger::WARNING, $message = 'test', $conte
107104
];
108105
}
109106

110-
/**
111-
* @return array
112-
*/
113-
protected function getMultipleRecords()
107+
protected function getMultipleRecords(): array
114108
{
115109
return [
116110
$this->getRecord(Logger::DEBUG, 'debug message 1'),

‎src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Deprecation.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/PhpUnit/DeprecationErrorHandler/Deprecation.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ private function getPackage($path)
310310
}
311311

312312
/**
313-
* @return string[] an array of paths
313+
* @return string[]
314314
*/
315315
private static function getVendors()
316316
{

‎src/Symfony/Bridge/Twig/AppVariable.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Twig/AppVariable.php
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public function getUser()
9191
/**
9292
* Returns the current request.
9393
*
94-
* @return Request|null The HTTP request object
94+
* @return Request|null
9595
*/
9696
public function getRequest()
9797
{
@@ -105,7 +105,7 @@ public function getRequest()
105105
/**
106106
* Returns the current session.
107107
*
108-
* @return Session|null The session
108+
* @return Session|null
109109
*/
110110
public function getSession()
111111
{
@@ -120,7 +120,7 @@ public function getSession()
120120
/**
121121
* Returns the current app environment.
122122
*
123-
* @return string The current environment string (e.g 'dev')
123+
* @return string
124124
*/
125125
public function getEnvironment()
126126
{
@@ -134,7 +134,7 @@ public function getEnvironment()
134134
/**
135135
* Returns the current app debug mode.
136136
*
137-
* @return bool The current debug mode
137+
* @return bool
138138
*/
139139
public function getDebug()
140140
{

‎src/Symfony/Bridge/Twig/Extension/CodeExtension.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Twig/Extension/CodeExtension.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ public function formatFile(string $file, int $line, string $text = null): string
175175
/**
176176
* Returns the link for a given file/line pair.
177177
*
178-
* @return string|false A link or false
178+
* @return string|false
179179
*/
180180
public function getFileLink(string $file, int $line)
181181
{

‎src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public function canTransition(object $subject, string $transitionName, string $n
5959
/**
6060
* Returns all enabled transitions.
6161
*
62-
* @return Transition[] All enabled transitions
62+
* @return Transition[]
6363
*/
6464
public function getEnabledTransitions(object $subject, string $name = null): array
6565
{

‎src/Symfony/Bridge/Twig/Form/TwigRendererEngine.php

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Twig/Form/TwigRendererEngine.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public function renderBlock(FormView $view, $resource, string $blockName, array
7070
*
7171
* @see getResourceForBlock()
7272
*
73-
* @return bool True if the resource could be loaded, false otherwise
73+
* @return bool
7474
*/
7575
protected function loadResourceForBlockName(string $cacheKey, FormView $view, string $blockName)
7676
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php
-2Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,6 @@ public function warmUp(string $cacheDir)
5252

5353
/**
5454
* Checks whether this warmer is optional or not.
55-
*
56-
* @return bool always true
5755
*/
5856
public function isOptional(): bool
5957
{

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function __construct(bool $debug)
6060
/**
6161
* Generates the configuration tree builder.
6262
*
63-
* @return TreeBuilder The tree builder
63+
* @return TreeBuilder
6464
*/
6565
public function getConfigTreeBuilder()
6666
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/HttpCache/HttpCache.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ protected function forward(Request $request, bool $catch = false, Response $entr
7676
/**
7777
* Returns an array of options to customize the Cache configuration.
7878
*
79-
* @return array An array of options
79+
* @return array
8080
*/
8181
protected function getOptions()
8282
{

‎src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ protected function tearDown(): void
5252
}
5353

5454
/**
55-
* @return string The Kernel class name
55+
* @return string
5656
*
5757
* @throws \RuntimeException
5858
* @throws \LogicException

‎src/Symfony/Bundle/SecurityBundle/DataCollector/SecurityDataCollector.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/SecurityBundle/DataCollector/SecurityDataCollector.php
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ public function lateCollect()
233233
/**
234234
* Checks if security is enabled.
235235
*
236-
* @return bool true if security is enabled, false otherwise
236+
* @return bool
237237
*/
238238
public function isEnabled()
239239
{
@@ -243,7 +243,7 @@ public function isEnabled()
243243
/**
244244
* Gets the user.
245245
*
246-
* @return string The user
246+
* @return string
247247
*/
248248
public function getUser()
249249
{
@@ -274,7 +274,7 @@ public function getInheritedRoles()
274274
* Checks if the data contains information about inherited roles. Still the inherited
275275
* roles can be an empty array.
276276
*
277-
* @return bool true if the profile was contains inherited role information
277+
* @return bool
278278
*/
279279
public function supportsRoleHierarchy()
280280
{
@@ -284,7 +284,7 @@ public function supportsRoleHierarchy()
284284
/**
285285
* Checks if the user is authenticated or not.
286286
*
287-
* @return bool true if the user is authenticated, false otherwise
287+
* @return bool
288288
*/
289289
public function isAuthenticated()
290290
{
@@ -318,7 +318,7 @@ public function getImpersonationExitPath()
318318
/**
319319
* Get the class name of the security token.
320320
*
321-
* @return string|Data|null The token
321+
* @return string|Data|null
322322
*/
323323
public function getTokenClass()
324324
{
@@ -338,7 +338,7 @@ public function getToken()
338338
/**
339339
* Get the logout URL.
340340
*
341-
* @return string|null The logout URL
341+
* @return string|null
342342
*/
343343
public function getLogoutUrl()
344344
{

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public function __construct(array $factories, array $userProviderFactories)
5151
/**
5252
* Generates the configuration tree builder.
5353
*
54-
* @return TreeBuilder The tree builder
54+
* @return TreeBuilder
5555
*/
5656
public function getConfigTreeBuilder()
5757
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AbstractFactory.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ final public function addOption(string $name, $default = null)
9999
* Subclasses must return the id of a service which implements the
100100
* AuthenticationProviderInterface.
101101
*
102-
* @return string never null, the id of the authentication provider
102+
* @return string
103103
*/
104104
abstract protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId);
105105

‎src/Symfony/Bundle/TwigBundle/DependencyInjection/Configuration.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/TwigBundle/DependencyInjection/Configuration.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class Configuration implements ConfigurationInterface
2626
/**
2727
* Generates the configuration tree builder.
2828
*
29-
* @return TreeBuilder The tree builder
29+
* @return TreeBuilder
3030
*/
3131
public function getConfigTreeBuilder()
3232
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ public function openAction(Request $request)
371371
/**
372372
* Gets the Template Manager.
373373
*
374-
* @return TemplateManager The Template Manager
374+
* @return TemplateManager
375375
*/
376376
protected function getTemplateManager()
377377
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/WebProfilerBundle/DependencyInjection/Configuration.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class Configuration implements ConfigurationInterface
2727
/**
2828
* Generates the configuration tree builder.
2929
*
30-
* @return TreeBuilder The tree builder
30+
* @return TreeBuilder
3131
*/
3232
public function getConfigTreeBuilder()
3333
{

‎src/Symfony/Component/Asset/Context/ContextInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Asset/Context/ContextInterface.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ interface ContextInterface
2121
/**
2222
* Gets the base path.
2323
*
24-
* @return string The base path
24+
* @return string
2525
*/
2626
public function getBasePath();
2727

2828
/**
2929
* Checks whether the request is secure or not.
3030
*
31-
* @return bool true if the request is secure, false otherwise
31+
* @return bool
3232
*/
3333
public function isSecure();
3434
}

‎src/Symfony/Component/Asset/Exception/AssetNotFoundException.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Asset/Exception/AssetNotFoundException.php
-3Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ public function __construct(string $message, array $alternatives = [], int $code
3131
$this->alternatives = $alternatives;
3232
}
3333

34-
/**
35-
* @return array A list of similar defined names
36-
*/
3734
public function getAlternatives(): array
3835
{
3936
return $this->alternatives;

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.