merged branch weaverryan/parameter_bag_phpdoc (PR symfony#2965)

fabpot · fabpot · commit fb374c139529 · 2011-12-26T19:29:16.000+01:00
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!
diff --git a/src/Symfony/Component/HttpFoundation/ParameterBag.php b/src/Symfony/Component/HttpFoundation/ParameterBag.php
@@ -86,8 +86,8 @@ public function add(array $parameters = array())
      * 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 @@ public function remove($key)
      * 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 @@ public function getAlpha($key, $default = '', $deep = false)
      * 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 @@ public function getAlnum($key, $default = '', $deep = false)
      * 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 @@ public function getDigits($key, $default = '', $deep = false)
      * 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
      *

Original file line number	Diff line number	Diff line change
`@@ -86,8 +86,8 @@ public function add(array $parameters = array())`
`86`	`86`	`* Returns a parameter by name.`
`87`	`87`	`*`
`88`	`88`	`* @param string $path The key`
`89`		`- * @param mixed $default The default value`
`90`		`- * @param boolean $deep`
	`89`	`+ * @param mixed $default The default value if the parameter key does not exist`
	`90`	`+ * @param boolean $deep If true, a path like foo[bar] will find deeper items`
`91`	`91`	`*`
`92`	`92`	`* @api`
`93`	`93`	`*/`
`@@ -183,8 +183,8 @@ public function remove($key)`
`183`	`183`	`* Returns the alphabetic characters of the parameter value.`
`184`	`184`	`*`
`185`	`185`	`* @param string $key The parameter key`
`186`		`- * @param mixed $default The default value`
`187`		`- * @param boolean $deep`
	`186`	`+ * @param mixed $default The default value if the parameter key does not exist`
	`187`	`+ * @param boolean $deep If true, a path like foo[bar] will find deeper items`
`188`	`188`	`*`
`189`	`189`	`* @return string The filtered value`
`190`	`190`	`*`
`@@ -199,8 +199,8 @@ public function getAlpha($key, $default = '', $deep = false)`
`199`	`199`	`* Returns the alphabetic characters and digits of the parameter value.`
`200`	`200`	`*`
`201`	`201`	`* @param string $key The parameter key`
`202`		`- * @param mixed $default The default value`
`203`		`- * @param boolean $deep`
	`202`	`+ * @param mixed $default The default value if the parameter key does not exist`
	`203`	`+ * @param boolean $deep If true, a path like foo[bar] will find deeper items`
`204`	`204`	`*`
`205`	`205`	`* @return string The filtered value`
`206`	`206`	`*`
`@@ -215,8 +215,8 @@ public function getAlnum($key, $default = '', $deep = false)`
`215`	`215`	`* Returns the digits of the parameter value.`
`216`	`216`	`*`
`217`	`217`	`* @param string $key The parameter key`
`218`		`- * @param mixed $default The default value`
`219`		`- * @param boolean $deep`
	`218`	`+ * @param mixed $default The default value if the parameter key does not exist`
	`219`	`+ * @param boolean $deep If true, a path like foo[bar] will find deeper items`
`220`	`220`	`*`
`221`	`221`	`* @return string The filtered value`
`222`	`222`	`*`
`@@ -231,8 +231,8 @@ public function getDigits($key, $default = '', $deep = false)`
`231`	`231`	`* Returns the parameter value converted to integer.`
`232`	`232`	`*`
`233`	`233`	`* @param string $key The parameter key`
`234`		`- * @param mixed $default The default value`
`235`		`- * @param boolean $deep`
	`234`	`+ * @param mixed $default The default value if the parameter key does not exist`
	`235`	`+ * @param boolean $deep If true, a path like foo[bar] will find deeper items`
`236`	`236`	`*`
`237`	`237`	`* @return string The filtered value`
`238`	`238`	`*`