minor #23832 [DI] Fix some docblocks (nicolas-grekas)

Robin Chalas · Robin Chalas · commit 5fad797f6b37 · 2017-08-08T23:31:04.000+02:00
This PR was merged into the 2.7 branch. Discussion ---------- [DI] Fix some docblocks | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- dd86229 [DI] Fix some docblocks
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -710,8 +710,8 @@ public function getAlias($id)
      * This methods allows for simple registration of service definition
      * with a fluid interface.
      *
-     * @param string $id    The service identifier
-     * @param string $class The service class
+     * @param string $id         The service identifier
+     * @param string $class|null The service class
      *
      * @return Definition A Definition instance
      */
diff --git a/src/Symfony/Component/DependencyInjection/Definition.php b/src/Symfony/Component/DependencyInjection/Definition.php
@@ -257,18 +257,38 @@ public function setArguments(array $arguments)
         return $this;
     }
 
+    /**
+     * Sets the properties to define when creating the service.
+     *
+     * @param array $properties
+     *
+     * @return $this
+     */
     public function setProperties(array $properties)
     {
         $this->properties = $properties;
 
         return $this;
     }
 
+    /**
+     * Gets the properties to define when creating the service.
+     *
+     * @return array
+     */
     public function getProperties()
     {
         return $this->properties;
     }
 
+    /**
+     * Sets a specific property.
+     *
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return $this
+     */
     public function setProperty($name, $value)
     {
         $this->properties[$name] = $value;
@@ -291,7 +311,7 @@ public function addArgument($argument)
     }
 
     /**
-     * Sets a specific argument.
+     * Replaces a specific argument.
      *
      * @param int   $index
      * @param mixed $argument

Original file line number	Diff line number	Diff line change
`@@ -710,8 +710,8 @@ public function getAlias($id)`
`710`	`710`	`* This methods allows for simple registration of service definition`
`711`	`711`	`* with a fluid interface.`
`712`	`712`	`*`
`713`		`- * @param string $id The service identifier`
`714`		`- * @param string $class The service class`
	`713`	`+ * @param string $id The service identifier`
	`714`	`+ * @param string $class\|null The service class`
`715`	`715`	`*`
`716`	`716`	`* @return Definition A Definition instance`
`717`	`717`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -257,18 +257,38 @@ public function setArguments(array $arguments)`
`257`	`257`	`return $this;`
`258`	`258`	`}`
`259`	`259`
	`260`	`+ /**`
	`261`	`+ * Sets the properties to define when creating the service.`
	`262`	`+ *`
	`263`	`+ * @param array $properties`
	`264`	`+ *`
	`265`	`+ * @return $this`
	`266`	`+ */`
`260`	`267`	`public function setProperties(array $properties)`
`261`	`268`	`{`
`262`	`269`	`$this->properties = $properties;`
`263`	`270`
`264`	`271`	`return $this;`
`265`	`272`	`}`
`266`	`273`
	`274`	`+ /**`
	`275`	`+ * Gets the properties to define when creating the service.`
	`276`	`+ *`
	`277`	`+ * @return array`
	`278`	`+ */`
`267`	`279`	`public function getProperties()`
`268`	`280`	`{`
`269`	`281`	`return $this->properties;`
`270`	`282`	`}`
`271`	`283`
	`284`	`+ /**`
	`285`	`+ * Sets a specific property.`
	`286`	`+ *`
	`287`	`+ * @param string $name`
	`288`	`+ * @param mixed $value`
	`289`	`+ *`
	`290`	`+ * @return $this`
	`291`	`+ */`
`272`	`292`	`public function setProperty($name, $value)`
`273`	`293`	`{`
`274`	`294`	`$this->properties[$name] = $value;`
`@@ -291,7 +311,7 @@ public function addArgument($argument)`
`291`	`311`	`}`
`292`	`312`
`293`	`313`	`/**`
`294`		`- * Sets a specific argument.`
	`314`	`+ * Replaces a specific argument.`
`295`	`315`	`*`
`296`	`316`	`* @param int $index`
`297`	`317`	`* @param mixed $argument`