Skip to content

Commit

Permalink
minor #20444 [YAML] PHPDoc fixes for inline parser/dumper (ro0NL)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
fabpot committed Nov 9, 2016
2 parents d6e9287 + dd47295 commit 6953f4f
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions src/Symfony/Component/Yaml/Inline.php
Expand Up @@ -28,15 +28,15 @@ class Inline
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 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 $objectForMap true if maps should return a stdClass instead of array()
* @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
*/
Expand Down Expand Up @@ -90,7 +90,7 @@ public static function parse($value, $exceptionOnInvalidType = false, $objectSup
* @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
*
* @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
*/
Expand Down Expand Up @@ -210,7 +210,7 @@ private static function dumpArray($value, $exceptionOnInvalidType, $objectSuppor
}

/**
* Parses a scalar to a YAML string.
* Parses a YAML scalar.
*
* @param string $scalar
* @param string $delimiters
Expand All @@ -219,7 +219,7 @@ private static function dumpArray($value, $exceptionOnInvalidType, $objectSuppor
* @param bool $evaluate
* @param array $references
*
* @return string A YAML string
* @return string
*
* @throws ParseException When malformed inline YAML string is parsed
*/
Expand Down Expand Up @@ -261,12 +261,12 @@ public static function parseScalar($scalar, $delimiters = null, $stringDelimiter
}

/**
* Parses a quoted scalar to YAML.
* Parses a YAML quoted scalar.
*
* @param string $scalar
* @param int &$i
*
* @return string A YAML string
* @return string
*
* @throws ParseException When malformed inline YAML string is parsed
*/
Expand All @@ -291,13 +291,13 @@ private static function parseQuotedScalar($scalar, &$i)
}

/**
* Parses a sequence to a YAML string.
* Parses a YAML sequence.
*
* @param string $sequence
* @param int &$i
* @param array $references
*
* @return string A YAML string
* @return array
*
* @throws ParseException When malformed inline YAML string is parsed
*/
Expand Down Expand Up @@ -350,13 +350,13 @@ private static function parseSequence($sequence, &$i = 0, $references = array())
}

/**
* Parses a mapping to a YAML string.
* Parses a YAML mapping.
*
* @param string $mapping
* @param int &$i
* @param array $references
*
* @return string A YAML string
* @return array|\stdClass
*
* @throws ParseException When malformed inline YAML string is parsed
*/
Expand Down

0 comments on commit 6953f4f

Please sign in to comment.