[YAML] Refine the return value of Yaml::parse()

jakzal · jakzal · commit 6a806e32b7a1 · 2016-01-27T16:53:33.000Z
diff --git a/src/Symfony/Component/Yaml/Yaml.php b/src/Symfony/Component/Yaml/Yaml.php
@@ -21,10 +21,7 @@
 class Yaml
 {
     /**
-     * Parses YAML into a PHP array.
-     *
-     * The parse method, when supplied with a YAML stream (string or file),
-     * will do its best to convert YAML in a file into a PHP array.
+     * Parses YAML into a PHP value.
      *
      *  Usage:
      *  <code>
@@ -40,7 +37,7 @@ class Yaml
      * @param bool   $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise
      * @param bool   $objectSupport          True if object support is enabled, false otherwise
      *
-     * @return array The YAML converted to a PHP array
+     * @return mixed The YAML converted to a PHP value
      *
      * @throws ParseException If the YAML is not valid
      */

Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,7 @@`
`21`	`21`	`class Yaml`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * Parses YAML into a PHP array.`
`25`		`- *`
`26`		`- * The parse method, when supplied with a YAML stream (string or file),`
`27`		`- * will do its best to convert YAML in a file into a PHP array.`
	`24`	`+ * Parses YAML into a PHP value.`
`28`	`25`	`*`
`29`	`26`	`* Usage:`
`30`	`27`	`* <code>`
`@@ -40,7 +37,7 @@ class Yaml`
`40`	`37`	`* @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise`
`41`	`38`	`* @param bool $objectSupport True if object support is enabled, false otherwise`
`42`	`39`	`*`
`43`		`- * @return array The YAML converted to a PHP array`
	`40`	`+ * @return mixed The YAML converted to a PHP value`
`44`	`41`	`*`
`45`	`42`	`* @throws ParseException If the YAML is not valid`
`46`	`43`	`*/`