minor #18442 [HttpFoundation] Improve phpdoc (mnapoli)

nicolas-grekas · nicolas-grekas · commit 019e316aa037 · 2016-04-05T17:56:10.000+02:00
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #18442). Discussion ---------- [HttpFoundation] Improve phpdoc | Q | A | ------------- | --- | Branch? | master? | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Improve the phpdoc for the `$default` parameter of the `get()` method. It wasn't clear when the default value would be used (whether the key would not exist or the value was `null` or nullish). The comment is now in sync with `Symfony\Component\HttpFoundation\ParameterBag::get()`. Commits ------- 6bfbb2e [HttpFoundation] Improve phpdoc
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -674,7 +674,7 @@ public static function getHttpMethodParameterOverride()
      * public property instead (query, attributes, request).
      *
      * @param string $key     the key
-     * @param mixed  $default the default value
+     * @param mixed  $default the default value if the parameter key does not exist
      * @param bool   $deep    is parameter deep in multidimensional array
      *
      * @return mixed

Origi 695E nal file line number	Diff line number	Diff line change
`@@ -674,7 +674,7 @@ public static function getHttpMethodParameterOverride()`
`674`	`674`	`* public property instead (query, attributes, request).`
`675`	`675`	`*`
`676`	`676`	`* @param string $key the key`
`677`		`- * @param mixed $default the default value`
	`677`	`+ * @param mixed $default the default value if the parameter key does not exist`
`678`	`678`	`* @param bool $deep is parameter deep in multidimensional array`
`679`	`679`	`*`
`680`	`680`	`* @return mixed`