Skip to content

Commit 8806578

Browse files
Cleanup more @return annotations
1 parent 0f8de5f commit 8806578

25 files changed

+63
-63
lines changed

Alias.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ public function getDeprecation(string $id): array
152152
/**
153153
* Returns the Id of this alias.
154154
*
155-
* @return string The alias id
155+
* @return string
156156
*/
157157
public function __toString()
158158
{

Argument/ReferenceSetArgumentTrait.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public function __construct(array $values)
3131
}
3232

3333
/**
34-
* @return Reference[] The values in the set
34+
* @return Reference[]
3535
*/
3636
public function getValues()
3737
{

ChildDefinition.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public function setParent(string $parent)
6161
*
6262
* @param int|string $index
6363
*
64-
* @return mixed The argument value
64+
* @return mixed
6565
*
6666
* @throws OutOfBoundsException When the argument does not exist
6767
*/

Compiler/AbstractRecursivePass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ protected function inExpression(bool $reset = true): bool
6969
*
7070
* @param mixed $value
7171
*
72-
* @return mixed The processed value
72+
* @return mixed
7373
*/
7474
protected function processValue($value, bool $isRoot = false)
7575
{

Compiler/AutowirePass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ private function autowireCalls(\ReflectionClass $reflectionClass, bool $isRoot,
188188
/**
189189
* Autowires the constructor or a method.
190190
*
191-
* @return array The autowired arguments
191+
* @return array
192192
*
193193
* @throws AutowiringFailedException
194194
*/

Compiler/ServiceReferenceGraphNode.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public function isAlias()
6161
/**
6262
* Checks if the value of this node is a Definition.
6363
*
64-
* @return bool True if the value is a Definition instance
64+
* @return bool
6565
*/
6666
public function isDefinition()
6767
{
@@ -101,7 +101,7 @@ public function getOutEdges()
101101
/**
102102
* Returns the value of this Node.
103103
*
104-
* @return mixed The value
104+
* @return mixed
105105
*/
106106
public function getValue()
107107
{

Config/ContainerParametersResource.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public function __toString(): string
3838
}
3939

4040
/**
41-
* @return array Tracked parameters
41+
* @return array
4242
*/
4343
public function getParameters(): array
4444
{

Container.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public function getParameter(string $name)
117117
}
118118

119119
/**
120-
* @return bool The presence of parameter in container
120+
* @return bool
121121
*/
122122
public function hasParameter(string $name)
123123
{
@@ -184,7 +184,7 @@ public function set(string $id, ?object $service)
184184
*
185185
* @param string $id The service identifier
186186
*
187-
* @return bool true if the service is defined, false otherwise
187+
* @return bool
188188
*/
189189
public function has(string $id)
190190
{
@@ -204,7 +204,7 @@ public function has(string $id)
204204
/**
205205
* Gets a service.
206206
*
207-
* @return object|null The associated service
207+
* @return object|null
208208
*
209209
* @throws ServiceCircularReferenceException When a circular reference is detected
210210
* @throws ServiceNotFoundException When the service is not defined
@@ -277,7 +277,7 @@ private function make(string $id, int $invalidBehavior)
277277
/**
278278
* Returns true if the given service has actually been initialized.
279279
*
280-
* @return bool true if service has already been initialized, false otherwise
280+
* @return bool
281281
*/
282282
public function initialized(string $id)
283283
{
@@ -314,7 +314,7 @@ public function reset()
314314
/**
315315
* Gets all service ids.
316316
*
317-
* @return string[] An array of all defined service ids
317+
* @return string[]
318318
*/
319319
public function getServiceIds()
320320
{
@@ -334,7 +334,7 @@ public function getRemovedIds()
334334
/**
335335
* Camelizes a string.
336336
*
337-
* @return string The camelized string
337+
* @return string
338338
*/
339339
public static function camelize(string $id)
340340
{
@@ -344,7 +344,7 @@ public static function camelize(string $id)
344344
/**
345345
* A string to underscore.
346346
*
347-
* @return string The underscored string
347+
* @return string
348348
*/
349349
public static function underscore(string $id)
350350
{
@@ -362,7 +362,7 @@ protected function load(string $file)
362362
/**
363363
* Fetches a variable from the environment.
364364
*
365-
* @return mixed The value to use for the provided environment variable name
365+
* @return mixed
366366
*
367367
* @throws EnvNotFoundException When the environment variable is not found and has no default value
368368
*/

ContainerBuilder.php

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ public function setResourceTracking(bool $track)
177177
/**
178178
* Checks if resources are tracked.
179179
*
180-
* @return bool true If resources are tracked, false otherwise
180+
* @return bool
181181
*/
182182
public function isTrackingResources()
183183
{
@@ -224,7 +224,7 @@ public function getExtension(string $name)
224224
/**
225225
* Returns all registered extensions.
226226
*
227-
* @return ExtensionInterface[] An array of ExtensionInterface
227+
* @return ExtensionInterface[]
228228
*/
229229
public function getExtensions()
230230
{
@@ -234,7 +234,7 @@ public function getExtensions()
234234
/**
235235
* Checks if we have an extension.
236236
*
237-
* @return bool If the extension exists
237+
* @return bool
238238
*/
239239
public function hasExtension(string $name)
240240
{
@@ -244,7 +244,7 @@ public function hasExtension(string $name)
244244
/**
245245
* Returns an array of resources loaded to build this configuration.
246246
*
247-
* @return ResourceInterface[] An array of resources
247+
* @return ResourceInterface[]
248248
*/
249249
public function getResources()
250250
{
@@ -462,7 +462,7 @@ public function addCompilerPass(CompilerPassInterface $pass, string $type = Pass
462462
/**
463463
* Returns the compiler pass config which can then be modified.
464464
*
465-
* @return PassConfig The compiler pass config
465+
* @return PassConfig
466466
*/
467467
public function getCompilerPassConfig()
468468
{
@@ -472,7 +472,7 @@ public function getCompilerPassConfig()
472472
/**
473473
* Returns the compiler.
474474
*
475-
* @return Compiler The compiler
475+
* @return Compiler
476476
*/
477477
public function getCompiler()
478478
{
@@ -516,15 +516,15 @@ public function removeDefinition(string $id)
516516
*
517517
* @param string $id The service identifier
518518
*
519-
* @return bool true if the service is defined, false otherwise
519+
* @return bool
520520
*/
521521
public function has(string $id)
522522
{
523523
return isset($this->definitions[$id]) || isset($this->aliasDefinitions[$id]) || parent::has($id);
524524
}
525525

526526
/**
527-
* @return object|null The associated service
527+
* @return object|null
528528
*
529529
* @throws InvalidArgumentException when no definitions are available
530530
* @throws ServiceCircularReferenceException When a circular reference is detected
@@ -684,7 +684,7 @@ public function merge(self $container)
684684
/**
685685
* Returns the configuration array for the given extension.
686686
*
687-
* @return array An array of configuration
687+
* @return array
688688
*/
689689
public function getExtensionConfig(string $name)
690690
{
@@ -846,15 +846,15 @@ public function removeAlias(string $alias)
846846
}
847847

848848
/**
849-
* @return bool true if the alias exists, false otherwise
849+
* @return bool
850850
*/
851851
public function hasAlias(string $id)
852852
{
853853
return isset($this->aliasDefinitions[$id]);
854854
}
855855

856856
/**
857-
* @return Alias[] An array of aliases
857+
* @return Alias[]
858858
*/
859859
public function getAliases()
860860
{
@@ -894,7 +894,7 @@ public function register(string $id, string $class = null)
894894
* This method implements a shortcut for using setDefinition() with
895895
* an autowired definition.
896896
*
897-
* @return Definition The created definition
897+
* @return Definition
898898
*/
899899
public function autowire(string $id, string $class = null)
900900
{
@@ -937,7 +937,7 @@ public function getDefinitions()
937937
/**
938938
* Sets a service definition.
939939
*
940-
* @return Definition the service definition
940+
* @return Definition
941941
*
942942
* @throws BadMethodCallException When this ContainerBuilder is compiled
943943
*/
@@ -959,7 +959,7 @@ public function setDefinition(string $id, Definition $definition)
959959
/**
960960
* Returns true if a service definition exists under the given identifier.
961961
*
962-
* @return bool true if the service definition exists, false otherwise
962+
* @return bool
963963
*/
964964
public function hasDefinition(string $id)
965965
{
@@ -1014,7 +1014,7 @@ public function findDefinition(string $id)
10141014
/**
10151015
* Creates a service for a service definition.
10161016
*
1017-
* @return mixed The service described by the service definition
1017+
* @return mixed
10181018
*
10191019
* @throws RuntimeException When the factory definition is incomplete
10201020
* @throws RuntimeException When the service is a synthetic service
@@ -1257,7 +1257,7 @@ public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false
12571257
/**
12581258
* Returns all tags the defined services use.
12591259
*
1260-
* @return array An array of tags
1260+
* @return array
12611261
*/
12621262
public function findTags()
12631263
{
@@ -1272,7 +1272,7 @@ public function findTags()
12721272
/**
12731273
* Returns all tags not queried by findTaggedServiceIds.
12741274
*
1275-
* @return string[] An array of tags
1275+
* @return string[]
12761276
*/
12771277
public function findUnusedTags()
12781278
{

ContainerInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function set(string $id, ?object $service);
4141
* @param string $id The service identifier
4242
* @param int $invalidBehavior The behavior when the service does not exist
4343
*
44-
* @return object|null The associated service
44+
* @return object|null
4545
*
4646
* @throws ServiceCircularReferenceException When a circular reference is detected
4747
* @throws ServiceNotFoundException When the service is not defined
@@ -51,14 +51,14 @@ public function set(string $id, ?object $service);
5151
public function get(string $id, int $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE);
5252

5353
/**
54-
* @return bool true if the service is defined, false otherwise
54+
* @return bool
5555
*/
5656
public function has(string $id);
5757

5858
/**
5959
* Check for whether or not a service has been initialized.
6060
*
61-
* @return bool true if the service has been initialized, false otherwise
61+
* @return bool
6262
*/
6363
public function initialized(string $id);
6464

Definition.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public function __construct(string $class = null, array $arguments = [])
7272
/**
7373
* Returns all changes tracked for the Definition object.
7474
*
75-
* @return array An array of changes for this Definition
75+
* @return array
7676
*/
7777
public function getChanges()
7878
{
@@ -183,7 +183,7 @@ public function setClass(?string $class)
183183
/**
184184
* Gets the service class.
185185
*
186-
* @return string|null The service class
186+
* @return string|null
187187
*/
188188
public function getClass()
189189
{
@@ -299,7 +299,7 @@ public function setArgument($key, $value)
299299
/**
300300
* Gets the arguments to pass to the service constructor/factory method.
301301
*
302-
* @return array The array of arguments
302+
* @return array
303303
*/
304304
public function getArguments()
305305
{
@@ -311,7 +311,7 @@ public function getArguments()
311311
*
312312
* @param int|string $index
313313
*
314-
* @return mixed The argument value
314+
* @return mixed
315315
*
316316
* @throws OutOfBoundsException When the argument does not exist
317317
*/
@@ -395,7 +395,7 @@ public function hasMethodCall(string $method)
395395
/**
396396
* Gets the methods to call after service initialization.
397397
*
398-
* @return array An array of method calls
398+
* @return array
399399
*/
400400
public function getMethodCalls()
401401
{
@@ -463,7 +463,7 @@ public function setTags(array $tags)
463463
/**
464464
* Returns all tags.
465465
*
466-
* @return array An array of tags
466+
* @return array
467467
*/
468468
public function getTags()
469469
{
@@ -473,7 +473,7 @@ public function getTags()
473473
/**
474474
* Gets a tag by name.
475475
*
476-
* @return array An array of attributes
476+
* @return array
477477
*/
478478
public function getTag(string $name)
479479
{
@@ -543,7 +543,7 @@ public function setFile(?string $file)
543543
/**
544544
* Gets the file to require before creating the service.
545545
*
546-
* @return string|null The full pathname to include
546+
* @return string|null
547547
*/
548548
public function getFile()
549549
{

0 commit comments

Comments
 (0)