[DI] minor docblock fixes

nicolas-grekas · nicolas-grekas · commit ca3c0da7d5fe · 2017-10-24T13:40:19.000+02:00
diff --git a/Compiler/AnalyzeServiceReferencesPass.php b/Compiler/AnalyzeServiceReferencesPass.php
@@ -51,8 +51,6 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)
 
     /**
      * Processes a ContainerBuilder object to populate the service reference graph.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/CheckCircularReferencesPass.php b/Compiler/CheckCircularReferencesPass.php
@@ -31,8 +31,6 @@ class CheckCircularReferencesPass implements CompilerPassInterface
 
     /**
      * Checks the ContainerBuilder object for circular references.
-     *
-     * @param ContainerBuilder $container The ContainerBuilder instances
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/CheckDefinitionValidityPass.php b/Compiler/CheckDefinitionValidityPass.php
@@ -33,8 +33,6 @@ class CheckDefinitionValidityPass implements CompilerPassInterface
     /**
      * Processes the ContainerBuilder to validate the Definition.
      *
-     * @param ContainerBuilder $container
-     *
      * @throws RuntimeException When the Definition is invalid
      */
     public function process(ContainerBuilder $container)
diff --git a/Compiler/CheckReferenceValidityPass.php b/Compiler/CheckReferenceValidityPass.php
@@ -39,8 +39,6 @@ class CheckReferenceValidityPass implements CompilerPassInterface
 
     /**
      * Processes the ContainerBuilder to validate References.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
@@ -112,9 +110,6 @@ private function validateReferences(array $arguments)
     /**
      * Validates the scope of a single Reference.
      *
-     * @param Reference  $reference
-     * @param Definition $definition
-     *
      * @throws ScopeWideningInjectionException when the definition references a service of a narrower scope
      * @throws ScopeCrossingInjectionException when the definition references a service of another scope hierarchy
      */
diff --git a/Compiler/Compiler.php b/Compiler/Compiler.php
@@ -95,8 +95,6 @@ public function getLog()
 
     /**
      * Run the Compiler and process all Passes.
-     *
-     * @param ContainerBuilder $container
      */
     public function compile(ContainerBuilder $container)
     {
diff --git a/Compiler/CompilerPassInterface.php b/Compiler/CompilerPassInterface.php
@@ -22,8 +22,6 @@ interface CompilerPassInterface
 {
     /**
      * You can modify the container here before it is dumped to PHP code.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container);
 }
diff --git a/Compiler/InlineServiceDefinitionsPass.php b/Compiler/InlineServiceDefinitionsPass.php
@@ -39,8 +39,6 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)
 
     /**
      * Processes the ContainerBuilder for inline service definitions.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/PassConfig.php b/Compiler/PassConfig.php
@@ -161,11 +161,6 @@ public function getMergePass()
         return $this->mergePass;
     }
 
-    /**
-     * Sets the Merge Pass.
-     *
-     * @param CompilerPassInterface $pass The merge pass
-     */
     public function setMergePass(CompilerPassInterface $pass)
     {
         $this->mergePass = $pass;
diff --git a/Compiler/RemoveAbstractDefinitionsPass.php b/Compiler/RemoveAbstractDefinitionsPass.php
@@ -20,8 +20,6 @@ class RemoveAbstractDefinitionsPass implements CompilerPassInterface
 {
     /**
      * Removes abstract definitions from the ContainerBuilder.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/RemovePrivateAliasesPass.php b/Compiler/RemovePrivateAliasesPass.php
@@ -24,8 +24,6 @@ class RemovePrivateAliasesPass implements CompilerPassInterface
 {
     /**
      * Removes private aliases from the ContainerBuilder.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/RemoveUnusedDefinitionsPass.php b/Compiler/RemoveUnusedDefinitionsPass.php
@@ -32,8 +32,6 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)
 
     /**
      * Processes the ContainerBuilder to remove unused definitions.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/RepeatablePassInterface.php b/Compiler/RepeatablePassInterface.php
@@ -19,10 +19,5 @@
  */
 interface RepeatablePassInterface extends CompilerPassInterface
 {
-    /**
-     * Sets the RepeatedPass interface.
-     *
-     * @param RepeatedPass $repeatedPass
-     */
     public function setRepeatedPass(RepeatedPass $repeatedPass);
 }
diff --git a/Compiler/RepeatedPass.php b/Compiler/RepeatedPass.php
@@ -51,8 +51,6 @@ public function __construct(array $passes)
 
     /**
      * Process the repeatable passes that run more than once.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/ReplaceAliasByActualDefinitionPass.php b/Compiler/ReplaceAliasByActualDefinitionPass.php
@@ -29,8 +29,6 @@ class ReplaceAliasByActualDefinitionPass implements CompilerPassInterface
     /**
      * Process the Container to replace aliases with service definitions.
      *
-     * @param ContainerBuilder $container
-     *
      * @throws InvalidArgumentException if the service definition does not exist
      */
     public function process(ContainerBuilder $container)
diff --git a/Compiler/ResolveDefinitionTemplatesPass.php b/Compiler/ResolveDefinitionTemplatesPass.php
@@ -30,8 +30,6 @@ class ResolveDefinitionTemplatesPass implements CompilerPassInterface
 
     /**
      * Process the ContainerBuilder to replace DefinitionDecorator instances with their real Definition instances.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/ResolveInvalidReferencesPass.php b/Compiler/ResolveInvalidReferencesPass.php
@@ -28,8 +28,6 @@ class ResolveInvalidReferencesPass implements CompilerPassInterface
 
     /**
      * Process the ContainerBuilder to resolve invalid references.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/ResolveParameterPlaceHoldersPass.php b/Compiler/ResolveParameterPlaceHoldersPass.php
@@ -24,8 +24,6 @@ class ResolveParameterPlaceHoldersPass implements CompilerPassInterface
     /**
      * Processes the ContainerBuilder to resolve parameter placeholders.
      *
-     * @param ContainerBuilder $container
-     *
      * @throws ParameterNotFoundException
      */
     public function process(ContainerBuilder $container)
diff --git a/Compiler/ResolveReferencesToAliasesPass.php b/Compiler/ResolveReferencesToAliasesPass.php
@@ -27,8 +27,6 @@ class ResolveReferencesToAliasesPass implements CompilerPassInterface
 
     /**
      * Processes the ContainerBuilder to replace references to aliases with actual service references.
-     *
-     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
diff --git a/Compiler/ServiceReferenceGraph.php b/Compiler/ServiceReferenceGraph.php
@@ -80,13 +80,16 @@ public function clear()
      * Connects 2 nodes together in the Graph.
      *
      * @param string $sourceId
-     * @param string $sourceValue
+     * @param mixed  $sourceValue
      * @param string $destId
-     * @param string $destValue
+     * @param mixed  $destValue
      * @param string $reference
      */
     public function connect($sourceId, $sourceValue, $destId, $destValue = null, $reference = null)
     {
+        if (null === $sourceId || null === $destId) {
+            return;
+        }
         $sourceNode = $this->createNode($sourceId, $sourceValue);
         $destNode = $this->createNode($destId, $destValue);
         $edge = new ServiceReferenceGraphEdge($sourceNode, $destNode, $reference);
@@ -99,7 +102,7 @@ public function connect($sourceId, $sourceValue, $destId, $destValue = null, $re
      * Creates a graph node.
      *
      * @param string $id
-     * @param string $value
+     * @param mixed  $value
      *
      * @return ServiceReferenceGraphNode
      */
diff --git a/Compiler/ServiceReferenceGraphEdge.php b/Compiler/ServiceReferenceGraphEdge.php
@@ -27,7 +27,7 @@ class ServiceReferenceGraphEdge
     /**
      * @param ServiceReferenceGraphNode $sourceNode
      * @param ServiceReferenceGraphNode $destNode
-     * @param string                    $value
+     * @param mixed                     $value
      */
     public function __construct(ServiceReferenceGraphNode $sourceNode, ServiceReferenceGraphNode $destNode, $value = null)
     {
diff --git a/Compiler/ServiceReferenceGraphNode.php b/Compiler/ServiceReferenceGraphNode.php
@@ -38,21 +38,11 @@ public function __construct($id, $value)
         $this->value = $value;
     }
 
-    /**
-     * Adds an in edge to this node.
-     *
-     * @param ServiceReferenceGraphEdge $edge
-     */
     public function addInEdge(ServiceReferenceGraphEdge $edge)
     {
         $this->inEdges[] = $edge;
     }
 
-    /**
-     * Adds an out edge to this node.
-     *
-     * @param ServiceReferenceGraphEdge $edge
-     */
     public function addOutEdge(ServiceReferenceGraphEdge $edge)
     {
         $this->outEdges[] = $edge;
diff --git a/Container.php b/Container.php
@@ -50,11 +50,7 @@
  */
 class Container implements IntrospectableContainerInterface
 {
-    /**
-     * @var ParameterBagInterface
-     */
     protected $parameterBag;
-
     protected $services = array();
     protected $methodMap = array();
     protected $aliases = array();
@@ -66,9 +62,6 @@ class Container implements IntrospectableContainerInterface
 
     private $underscoreMap = array('_' => '', '.' => '_', '\\' => '_');
 
-    /**
-     * @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
-     */
     public function __construct(ParameterBagInterface $parameterBag = null)
     {
         $this->parameterBag = $parameterBag ?: new ParameterBag();
@@ -454,8 +447,6 @@ public function leaveScope($name)
     /**
      * Adds a scope to the container.
      *
-     * @param ScopeInterface $scope
-     *
      * @throws InvalidArgumentException
      */
     public function addScope(ScopeInterface $scope)
diff --git a/ContainerAwareInterface.php b/ContainerAwareInterface.php
@@ -18,10 +18,5 @@
  */
 interface ContainerAwareInterface
 {
-    /**
-     * Sets the container.
-     *
-     * @param ContainerInterface|null $container A ContainerInterface instance or null
-     */
     public function setContainer(ContainerInterface $container = null);
 }
diff --git a/ContainerAwareTrait.php b/ContainerAwareTrait.php
@@ -23,11 +23,6 @@ trait ContainerAwareTrait
      */
     protected $container;
 
-    /**
-     * Sets the container.
-     *
-     * @param ContainerInterface|null $container A ContainerInterface instance or null
-     */
     public function setContainer(ContainerInterface $container = null)
     {
         $this->container = $container;
diff --git a/ContainerBuilder.php b/ContainerBuilder.php
@@ -123,19 +123,12 @@ public function isTrackingResources()
 
     /**
      * Sets the instantiator to be used when fetching proxies.
-     *
-     * @param InstantiatorInterface $proxyInstantiator
      */
     public function setProxyInstantiator(InstantiatorInterface $proxyInstantiator)
     {
         $this->proxyInstantiator = $proxyInstantiator;
     }
 
-    /**
-     * Registers an extension.
-     *
-     * @param ExtensionInterface $extension An extension instance
-     */
     public function registerExtension(ExtensionInterface $extension)
     {
         $this->extensions[$extension->getAlias()] = $extension;
@@ -200,10 +193,6 @@ public function getResources()
     }
 
     /**
-     * Adds a resource for this configuration.
-     *
-     * @param ResourceInterface $resource A resource instance
-     *
      * @return $this
      */
     public function addResource(ResourceInterface $resource)
@@ -254,8 +243,6 @@ public function addObjectResource($object)
     /**
      * Adds the given class hierarchy as resources.
      *
-     * @param \ReflectionClass $class
-     *
      * @return $this
      */
     public function addClassResource(\ReflectionClass $class)
@@ -492,8 +479,6 @@ public function get($id, $invalidBehavior = ContainerInterface::EXCEPTION_ON_INV
      * parameter, the value will still be 'bar' as defined in the ContainerBuilder
      * constructor.
      *
-     * @param ContainerBuilder $container The ContainerBuilder instance to merge
-     *
      * @throws BadMethodCallException When this ContainerBuilder is frozen
      */
     public function merge(ContainerBuilder $container)
@@ -603,8 +588,6 @@ public function getServiceIds()
 
     /**
      * Adds the service aliases.
-     *
-     * @param array $aliases An array of aliases
      */
     public function addAliases(array $aliases)
     {
@@ -615,8 +598,6 @@ public function addAliases(array $aliases)
 
     /**
      * Sets the service aliases.
-     *
-     * @param array $aliases An array of aliases
      */
     public function setAliases(array $aliases)
     {
diff --git a/Definition.php b/Definition.php
@@ -246,8 +246,6 @@ public function getClass()
     /**
      * Sets the arguments to pass to the service constructor/factory method.
      *
-     * @param array $arguments An array of arguments
-     *
      * @return $this
      */
     public function setArguments(array $arguments)
@@ -260,8 +258,6 @@ public function setArguments(array $arguments)
     /**
      * Sets the properties to define when creating the service.
      *
-     * @param array $properties
-     *
      * @return $this
      */
     public function setProperties(array $properties)
@@ -366,8 +362,6 @@ public function getArgument($index)
     /**
      * Sets the methods to call after service initialization.
      *
-     * @param array $calls An array of method calls
-     *
      * @return $this
      */
     public function setMethodCalls(array $calls = array())
@@ -450,8 +444,6 @@ public function getMethodCalls()
     /**
      * Sets tags for this definition.
      *
-     * @param array $tags
-     *
      * @return $this
      */
     public function setTags(array $tags)
diff --git a/Dumper/Dumper.php b/Dumper/Dumper.php
diff --git a/Dumper/PhpDumper.php b/Dumper/PhpDumper.php
diff --git a/Dumper/XmlDumper.php b/Dumper/XmlDumper.php
diff --git a/Dumper/YamlDumper.php b/Dumper/YamlDumper.php
diff --git a/Extension/ConfigurationExtensionInterface.php b/Extension/ConfigurationExtensionInterface.php
diff --git a/Extension/Extension.php b/Extension/Extension.php
diff --git a/Extension/ExtensionInterface.php b/Extension/ExtensionInterface.php
diff --git a/Extension/PrependExtensionInterface.php b/Extension/PrependExtensionInterface.php
diff --git a/LazyProxy/PhpDumper/DumperInterface.php b/LazyProxy/PhpDumper/DumperInterface.php
diff --git a/Loader/ClosureLoader.php b/Loader/ClosureLoader.php
diff --git a/Loader/FileLoader.php b/Loader/FileLoader.php
diff --git a/Loader/YamlFileLoader.php b/Loader/YamlFileLoader.php

Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,6 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)`
`51`	`51`
`52`	`52`	`/**`
`53`	`53`	`* Processes a ContainerBuilder object to populate the service reference graph.`
`54`		`- *`
`55`		`- * @param ContainerBuilder $container`
`56`	`54`	`*/`
`57`	`55`	`public function process(ContainerBuilder $container)`
`58`	`56`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,6 @@ class CheckCircularReferencesPass implements CompilerPassInterface`
`31`	`31`
`32`	`32`	`/**`
`33`	`33`	`* Checks the ContainerBuilder object for circular references.`
`34`		`- *`
`35`		`- * @param ContainerBuilder $container The ContainerBuilder instances`
`36`	`34`	`*/`
`37`	`35`	`public function process(ContainerBuilder $container)`
`38`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,6 @@ class CheckDefinitionValidityPass implements CompilerPassInterface`
`33`	`33`	`/**`
`34`	`34`	`* Processes the ContainerBuilder to validate the Definition.`
`35`	`35`	`*`
`36`		`- * @param ContainerBuilder $container`
`37`		`- *`
`38`	`36`	`* @throws RuntimeException When the Definition is invalid`
`39`	`37`	`*/`
`40`	`38`	`public function process(ContainerBuilder $container)`
Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,6 @@ public function getLog()`
`95`	`95`
`96`	`96`	`/**`
`97`	`97`	`* Run the Compiler and process all Passes.`
`98`		`- *`
`99`		`- * @param ContainerBuilder $container`
`100`	`98`	`*/`
`101`	`99`	`public function compile(ContainerBuilder $container)`
`102`	`100`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,6 @@ interface CompilerPassInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* You can modify the container here before it is dumped to PHP code.`
`25`		`- *`
`26`		`- * @param ContainerBuilder $container`
`27`	`25`	`*/`
`28`	`26`	`public function process(ContainerBuilder $container);`
`29`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,6 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)`
`39`	`39`
`40`	`40`	`/**`
`41`	`41`	`* Processes the ContainerBuilder for inline service definitions.`
`42`		`- *`
`43`		`- * @param ContainerBuilder $container`
`44`	`42`	`*/`
`45`	`43`	`public function process(ContainerBuilder $container)`
`46`	`44`	`{`
Original file line number	Diff line number	Diff line change
`@@ -161,11 +161,6 @@ public function getMergePass()`
`161`	`161`	`return $this->mergePass;`
`162`	`162`	`}`
`163`	`163`
`164`		`- /**`
`165`		`- * Sets the Merge Pass.`
`166`		`- *`
`167`		`- * @param CompilerPassInterface $pass The merge pass`
`168`		`- */`
`169`	`164`	`public function setMergePass(CompilerPassInterface $pass)`
`170`	`165`	`{`
`171`	`166`	`$this->mergePass = $pass;`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,6 @@ class RemoveAbstractDefinitionsPass implements CompilerPassInterface`
`20`	`20`	`{`
`21`	`21`	`/**`
`22`	`22`	`* Removes abstract definitions from the ContainerBuilder.`
`23`		`- *`
`24`		`- * @param ContainerBuilder $container`
`25`	`23`	`*/`
`26`	`24`	`public function process(ContainerBuilder $container)`
`27`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,6 @@ class RemovePrivateAliasesPass implements CompilerPassInterface`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Removes private aliases from the ContainerBuilder.`
`27`		`- *`
`28`		`- * @param ContainerBuilder $container`
`29`	`27`	`*/`
`30`	`28`	`public function process(ContainerBuilder $container)`
`31`	`29`	`{`