diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #20444 [YAML] PHPDoc fixes for inline parser/dumper (ro0NL)

Browse Source 
This PR was merged into the 2.7 branch.

Discussion
----------

[YAML] PHPDoc fixes for inline parser/dumper

| Q             | A
| ------------- | ---
| Branch?       | "master"
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | comma-separated list of tickets fixed by the PR, if any
| License       | MIT
| Doc PR        | reference to the documentation PR, if any

Commits
-------

dd47295 fixed phpdoc
This commit is contained in:
Fabien Potencier 2016-11-09 14:52:56 -08:00
commit 6953f4f779
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/Symfony/Component/Yaml/Inline.php
View File

@ -28,7 +28,7 @@ class Inline
private static $objectForMap = false; private static $objectForMap = false;
/** /**
* Converts a YAML string to a PHP array. * Converts a YAML string to a PHP value.
* *
* @param string $value A YAML string * @param string $value A YAML string
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
@ -36,7 +36,7 @@ class Inline
* @param bool $objectForMap true if maps should return a stdClass instead of array() * @param bool $objectForMap true if maps should return a stdClass instead of array()
* @param array $references Mapping of variable names to values * @param array $references Mapping of variable names to values
* *
* @return array A PHP array representing the YAML string * @return mixed A PHP value
* *
* @throws ParseException * @throws ParseException
*/ */
@ -90,7 +90,7 @@ class Inline
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise * @param bool $objectSupport true if object support is enabled, false otherwise
* *
* @return string The YAML string representing the PHP array * @return string The YAML string representing the PHP value
* *
* @throws DumpException When trying to dump PHP resource * @throws DumpException When trying to dump PHP resource
*/ */
@ -210,7 +210,7 @@ class Inline
} }
/** /**
* Parses a scalar to a YAML string. * Parses a YAML scalar.
* *
* @param string $scalar * @param string $scalar
* @param string $delimiters * @param string $delimiters
@ -219,7 +219,7 @@ class Inline
* @param bool $evaluate * @param bool $evaluate
* @param array $references * @param array $references
* *
* @return string A YAML string * @return string
* *
* @throws ParseException When malformed inline YAML string is parsed * @throws ParseException When malformed inline YAML string is parsed
*/ */
@ -261,12 +261,12 @@ class Inline
} }
/** /**
* Parses a quoted scalar to YAML. * Parses a YAML quoted scalar.
* *
* @param string $scalar * @param string $scalar
* @param int &$i * @param int &$i
* *
* @return string A YAML string * @return string
* *
* @throws ParseException When malformed inline YAML string is parsed * @throws ParseException When malformed inline YAML string is parsed
*/ */
@ -291,13 +291,13 @@ class Inline
} }
/** /**
* Parses a sequence to a YAML string. * Parses a YAML sequence.
* *
* @param string $sequence * @param string $sequence
* @param int &$i * @param int &$i
* @param array $references * @param array $references
* *
* @return string A YAML string * @return array
* *
* @throws ParseException When malformed inline YAML string is parsed * @throws ParseException When malformed inline YAML string is parsed
*/ */
@ -350,13 +350,13 @@ class Inline
} }
/** /**
* Parses a mapping to a YAML string. * Parses a YAML mapping.
* *
* @param string $mapping * @param string $mapping
* @param int &$i * @param int &$i
* @param array $references * @param array $references
* *
* @return string A YAML string * @return array|\stdClass
* *
* @throws ParseException When malformed inline YAML string is parsed * @throws ParseException When malformed inline YAML string is parsed
*/ */