Skip to content

Commit e3f3e2c

Browse files
GrahamCampbellGrahamCampbell
committed
Docblock fixes
1 parent 0a67629 commit e3f3e2c

19 files changed

+84
-84
lines changed

‎Alias.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ class Alias
2222
/**
2323
* Constructor.
2424
*
25-
* @param string $id Alias identifier
26-
* @param bool $public If this alias is public
25+
* @param string $id Alias identifier
26+
* @param bool $public If this alias is public
2727
*
2828
* @api
2929
*/
@@ -48,7 +48,7 @@ public function isPublic()
4848
/**
4949
* Sets if this Alias is public.
5050
*
51-
* @param bool $boolean If this Alias should be public
51+
* @param bool $boolean If this Alias should be public
5252
*
5353
* @api
5454
*/

‎Compiler/AnalyzeServiceReferencesPass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class AnalyzeServiceReferencesPass implements RepeatablePassInterface
3636
/**
3737
* Constructor.
3838
*
39-
* @param bool $onlyConstructorArguments Sets this Service Reference pass to ignore method calls
39+
* @param bool $onlyConstructorArguments Sets this Service Reference pass to ignore method calls
4040
*/
4141
public function __construct($onlyConstructorArguments = false)
4242
{

‎Compiler/InlineServiceDefinitionsPass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ private function inlineArguments(ContainerBuilder $container, array $arguments)
109109
* @param string $id
110110
* @param Definition $definition
111111
*
112-
* @return bool If the definition is inlineable
112+
* @return bool If the definition is inlineable
113113
*/
114114
private function isInlineableDefinition(ContainerBuilder $container, $id, Definition $definition)
115115
{

‎Compiler/ResolveInvalidReferencesPass.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ public function process(ContainerBuilder $container)
6969
/**
7070
* Processes arguments to determine invalid references.
7171
*
72-
* @param array $arguments An array of Reference objects
73-
* @param bool $inMethodCall
72+
* @param array $arguments An array of Reference objects
73+
* @param bool $inMethodCall
7474
*
7575
* @return array
7676
*

‎Compiler/ServiceReferenceGraphNode.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public function addOutEdge(ServiceReferenceGraphEdge $edge)
6565
/**
6666
* Checks if the value of this node is an Alias.
6767
*
68-
* @return bool True if the value is an Alias instance
68+
* @return bool True if the value is an Alias instance
6969
*/
7070
public function isAlias()
7171
{
@@ -75,7 +75,7 @@ public function isAlias()
7575
/**
7676
* Checks if the value of this node is a Definition.
7777
*
78-
* @return bool True if the value is a Definition instance
78+
* @return bool True if the value is a Definition instance
7979
*/
8080
public function isDefinition()
8181
{

‎Container.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public function compile()
115115
/**
116116
* Returns true if the container parameter bag are frozen.
117117
*
118-
* @return bool true if the container parameter bag are frozen, false otherwise
118+
* @return bool true if the container parameter bag are frozen, false otherwise
119119
*
120120
* @api
121121
*/
@@ -141,7 +141,7 @@ public function getParameterBag()
141141
*
142142
* @param string $name The parameter name
143143
*
144-
* @return mixed The parameter value
144+
* @return mixed The parameter value
145145
*
146146
* @throws InvalidArgumentException if the parameter is not defined
147147
*
@@ -157,7 +157,7 @@ public function getParameter($name)
157157
*
158158
* @param string $name The parameter name
159159
*
160-
* @return bool The presence of parameter in container
160+
* @return bool The presence of parameter in container
161161
*
162162
* @api
163163
*/
@@ -189,7 +189,7 @@ public function setParameter($name, $value)
189189
* @param object $service The service instance
190190
* @param string $scope The scope of the service
191191
*
192-
* @throws RuntimeException When trying to set a service in an inactive scope
192+
* @throws RuntimeException When trying to set a service in an inactive scope
193193
* @throws InvalidArgumentException When trying to set a service in the prototype scope
194194
*
195195
* @api
@@ -236,7 +236,7 @@ public function set($id, $service, $scope = self::SCOPE_CONTAINER)
236236
*
237237
* @param string $id The service identifier
238238
*
239-
* @return bool true if the service is defined, false otherwise
239+
* @return bool true if the service is defined, false otherwise
240240
*
241241
* @api
242242
*/
@@ -261,8 +261,8 @@ public function has($id)
261261
* If a service is defined both through a set() method and
262262
* with a get{$id}Service() method, the former has always precedence.
263263
*
264-
* @param string $id The service identifier
265-
* @param int $invalidBehavior The behavior when the service does not exist
264+
* @param string $id The service identifier
265+
* @param int $invalidBehavior The behavior when the service does not exist
266266
*
267267
* @return object The associated service
268268
*
@@ -353,7 +353,7 @@ public function get($id, $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE
353353
*
354354
* @param string $id The service identifier
355355
*
356-
* @return bool true if service has already been initialized, false otherwise
356+
* @return bool true if service has already been initialized, false otherwise
357357
*/
358358
public function initialized($id)
359359
{

‎ContainerBuilder.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
8484
* If you are not using the loaders and therefore don't want
8585
* to depend on the Config component, set this flag to false.
8686
*
87-
* @param bool $track true if you want to track resources, false otherwise
87+
* @param bool $track true if you want to track resources, false otherwise
8888
*/
8989
public function setResourceTracking($track)
9090
{
@@ -94,7 +94,7 @@ public function setResourceTracking($track)
9494
/**
9595
* Checks if resources are tracked.
9696
*
97-
* @return bool true if resources are tracked, false otherwise
97+
* @return bool true if resources are tracked, false otherwise
9898
*/
9999
public function isTrackingResources()
100100
{
@@ -168,7 +168,7 @@ public function getExtensions()
168168
*
169169
* @param string $name The name of the extension
170170
*
171-
* @return bool If the extension exists
171+
* @return bool If the extension exists
172172
*
173173
* @api
174174
*/
@@ -273,7 +273,7 @@ public function addClassResource(\ReflectionClass $class)
273273
* @param string $extension The extension alias or namespace
274274
* @param array $values An array of values that customizes the extension
275275
*
276-
* @return ContainerBuilder The current instance
276+
* @return ContainerBuilder The current instance
277277
* @throws BadMethodCallException When this ContainerBuilder is frozen
278278
*
279279
* @throws \LogicException if the container is frozen
@@ -430,7 +430,7 @@ public function removeDefinition($id)
430430
*
431431
* @param string $id The service identifier
432432
*
433-
* @return bool true if the service is defined, false otherwise
433+
* @return bool true if the service is defined, false otherwise
434434
*
435435
* @api
436436
*/
@@ -444,8 +444,8 @@ public function has($id)
444444
/**
445445
* Gets a service.
446446
*
447-
* @param string $id The service identifier
448-
* @param int $invalidBehavior The behavior when the service does not exist
447+
* @param string $id The service identifier
448+
* @param int $invalidBehavior The behavior when the service does not exist
449449
*
450450
* @return object The associated service
451451
*
@@ -574,8 +574,8 @@ public function getExtensionConfig($name)
574574
/**
575575
* Prepends a config array to the configs of the given extension.
576576
*
577-
* @param string $name The name of the extension
578-
* @param array $config The config to set
577+
* @param string $name The name of the extension
578+
* @param array $config The config to set
579579
*/
580580
public function prependExtensionConfig($name, array $config)
581581
{
@@ -669,8 +669,8 @@ public function setAliases(array $aliases)
669669
/**
670670
* Sets an alias for an existing service.
671671
*
672-
* @param string $alias The alias to create
673-
* @param string|Alias $id The service to alias
672+
* @param string $alias The alias to create
673+
* @param string|Alias $id The service to alias
674674
*
675675
* @throws InvalidArgumentException if the id is not a string or an Alias
676676
* @throws InvalidArgumentException if the alias is for itself
@@ -713,7 +713,7 @@ public function removeAlias($alias)
713713
*
714714
* @param string $id The service identifier
715715
*
716-
* @return bool true if the alias exists, false otherwise
716+
* @return bool true if the alias exists, false otherwise
717717
*
718718
* @api
719719
*/
@@ -843,7 +843,7 @@ public function setDefinition($id, Definition $definition)
843843
*
844844
* @param string $id The service identifier
845845
*
846-
* @return bool true if the service definition exists, false otherwise
846+
* @return bool true if the service definition exists, false otherwise
847847
*
848848
* @api
849849
*/
@@ -905,9 +905,9 @@ public function findDefinition($id)
905905
*
906906
* @return object The service described by the service definition
907907
*
908-
* @throws RuntimeException When the scope is inactive
909-
* @throws RuntimeException When the factory definition is incomplete
910-
* @throws RuntimeException When the service is a synthetic service
908+
* @throws RuntimeException When the scope is inactive
909+
* @throws RuntimeException When the factory definition is incomplete
910+
* @throws RuntimeException When the service is a synthetic service
911911
* @throws InvalidArgumentException When configure callable is not callable
912912
*
913913
* @internal this method is public because of PHP 5.3 limitations, do not use it explicitly in your code

‎ContainerInterface.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ public function set($id, $service, $scope = self::SCOPE_CONTAINER);
5050
*
5151
* @return object The associated service
5252
*
53-
* @throws InvalidArgumentException if the service is not defined
53+
* @throws InvalidArgumentException if the service is not defined
5454
* @throws ServiceCircularReferenceException When a circular reference is detected
55-
* @throws ServiceNotFoundException When the service is not defined
55+
* @throws ServiceNotFoundException When the service is not defined
5656
*
5757
* @see Reference
5858
*
@@ -65,7 +65,7 @@ public function get($id, $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE
6565
*
6666
* @param string $id The service identifier
6767
*
68-
* @return bool true if the service is defined, false otherwise
68+
* @return bool true if the service is defined, false otherwise
6969
*
7070
* @api
7171
*/
@@ -76,7 +76,7 @@ public function has($id);
7676
*
7777
* @param string $name The parameter name
7878
*
79-
* @return mixed The parameter value
79+
* @return mixed The parameter value
8080
*
8181
* @throws InvalidArgumentException if the parameter is not defined
8282
*
@@ -89,7 +89,7 @@ public function getParameter($name);
8989
*
9090
* @param string $name The parameter name
9191
*
92-
* @return bool The presence of parameter in container
92+
* @return bool The presence of parameter in container
9393
*
9494
* @api
9595
*/

‎Definition.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -240,8 +240,8 @@ public function addArgument($argument)
240240
/**
241241
* Sets a specific argument
242242
*
243-
* @param int $index
244-
* @param mixed $argument
243+
* @param int $index
244+
* @param mixed $argument
245245
*
246246
* @return Definition The current instance
247247
*
@@ -275,7 +275,7 @@ public function getArguments()
275275
/**
276276
* Gets an argument to pass to the service constructor/factory method.
277277
*
278-
* @param int $index
278+
* @param int $index
279279
*
280280
* @return mixed The argument value
281281
*
@@ -548,7 +548,7 @@ public function getScope()
548548
/**
549549
* Sets the visibility of this service.
550550
*
551-
* @param bool $boolean
551+
* @param bool $boolean
552552
*
553553
* @return Definition The current instance
554554
*
@@ -576,7 +576,7 @@ public function isPublic()
576576
/**
577577
* Sets the synchronized flag of this service.
578578
*
579-
* @param bool $boolean
579+
* @param bool $boolean
580580
*
581581
* @return Definition The current instance
582582
*
@@ -604,7 +604,7 @@ public function isSynchronized()
604604
/**
605605
* Sets the lazy flag of this service.
606606
*
607-
* @param bool $lazy
607+
* @param bool $lazy
608608
*
609609
* @return Definition The current instance
610610
*/
@@ -629,7 +629,7 @@ public function isLazy()
629629
* Sets whether this definition is synthetic, that is not constructed by the
630630
* container, but dynamically injected.
631631
*
632-
* @param bool $boolean
632+
* @param bool $boolean
633633
*
634634
* @return Definition the current instance
635635
*
@@ -659,7 +659,7 @@ public function isSynthetic()
659659
* Whether this definition is abstract, that means it merely serves as a
660660
* template for other definitions.
661661
*
662-
* @param bool $boolean
662+
* @param bool $boolean
663663
*
664664
* @return Definition the current instance
665665
*

‎DefinitionDecorator.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ public function setLazy($boolean)
167167
* If replaceArgument() has been used to replace an argument, this method
168168
* will return the replacement value.
169169
*
170-
* @param int $index
170+
* @param int $index
171171
*
172172
* @return mixed The argument value
173173
*
@@ -198,10 +198,10 @@ public function getArgument($index)
198198
* certain conventions when you want to overwrite the arguments of the
199199
* parent definition, otherwise your arguments will only be appended.
200200
*
201-
* @param int $index
202-
* @param mixed $value
201+
* @param int $index
202+
* @param mixed $value
203203
*
204-
* @return DefinitionDecorator the current instance
204+
* @return DefinitionDecorator the current instance
205205
* @throws InvalidArgumentException when $index isn't an integer
206206
*
207207
* @api

0 commit comments

Comments
 (0)