merged branch weaverryan/parameter_bag_phpdoc (PR #2965)

Commits
-------

a9b54df [HttpFoundation] Adding some additional PHPDoc to ParameterBag

Discussion
----------

Parameter bag phpdoc

Hi guys!

Very basic - just noticed that a few spots were a little light in PHPDoc while doing some docs stuff. Especially with core components that are being used by other groups, loading up on more PHPDoc may be a good idea where it's light.

Thanks!
This commit is contained in:
Fabien Potencier 2011-12-26 19:29:16 +01:00
commit fb374c1395

View File

@ -86,8 +86,8 @@ class ParameterBag
* Returns a parameter by name.
*
* @param string $path The key
* @param mixed $default The default value
* @param boolean $deep
* @param mixed $default The default value if the parameter key does not exist
* @param boolean $deep If true, a path like foo[bar] will find deeper items
*
* @api
*/
@ -183,8 +183,8 @@ class ParameterBag
* Returns the alphabetic characters of the parameter value.
*
* @param string $key The parameter key
* @param mixed $default The default value
* @param boolean $deep
* @param mixed $default The default value if the parameter key does not exist
* @param boolean $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*
@ -199,8 +199,8 @@ class ParameterBag
* Returns the alphabetic characters and digits of the parameter value.
*
* @param string $key The parameter key
* @param mixed $default The default value
* @param boolean $deep
* @param mixed $default The default value if the parameter key does not exist
* @param boolean $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*
@ -215,8 +215,8 @@ class ParameterBag
* Returns the digits of the parameter value.
*
* @param string $key The parameter key
* @param mixed $default The default value
* @param boolean $deep
* @param mixed $default The default value if the parameter key does not exist
* @param boolean $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*
@ -231,8 +231,8 @@ class ParameterBag
* Returns the parameter value converted to integer.
*
* @param string $key The parameter key
* @param mixed $default The default value
* @param boolean $deep
* @param mixed $default The default value if the parameter key does not exist
* @param boolean $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*