8000 minor #42499 Cleanup more ``@return`` annotations (nicolas-grekas) · symfony/symfony@c91322d · GitHub
[go: up one dir, main page]
Skip to content

Commit c91322d

Browse files
nicolas-grekasnicolas-grekas
committed
minor #42499 Cleanup more @return annotations (nicolas-grekas)
This PR was merged into the 5.4 branch. Discussion ---------- Cleanup more ``@return`` annotations | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Follow up of #42495, same motivation. Automated edits, manual selection, happy review :P Commits ------- 8f36bbd Cleanup more ``@return`` annotations
2 parents c0d09d6 + 8f36bbd commit c91322d

File tree

396 files changed

+1106
-1182
lines changed

Some content is hidden

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

396 files changed

+1106
-1182
lines changed

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

Lines 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‎

Lines 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‎

Lines 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‎

Lines 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‎

Lines 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‎

Lines 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‎

Lines 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‎

Lines 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‎

Lines 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
*/
1251 C12E 25
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‎

Lines 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
{

0 commit comments

Comments
 (0)
0