8000 minor #20444 [YAML] PHPDoc fixes for inline parser/dumper (ro0NL) · symfony/symfony@6953f4f · GitHub
[go: up one dir, main page]

Skip to content

Commit 6953f4f

Browse files
committed
minor #20444 [YAML] PHPDoc fixes for inline parser/dumper (ro0NL)
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
2 parents d6e9287 + dd47295 commit 6953f4f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/Symfony/Component/Yaml/Inline.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ class Inline
2828
private static $objectForMap = false;
2929

3030
/**
31-
* Converts a YAML string to a PHP array.
31+
* Converts a YAML string to a PHP value.
3232
*
3333
* @param string $value A YAML string
3434
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
3535
* @param bool $objectSupport true if object support is enabled, false otherwise
3636
* @param bool $objectForMap true if maps should return a stdClass instead of array()
3737
* @param array $references Mapping of variable names to values
3838
*
39-
* @return array A PHP array representing the YAML string
39+
* @return mixed A PHP value
4040
*
4141
* @throws ParseException
4242
*/
@@ -90,7 +90,7 @@ public static function parse($value, $exceptionOnInvalidType = false, $objectSup
9090
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
9191
* @param bool $objectSupport true if object support is enabled, false otherwise
9292
*
93-
* @return string The YAML string representing the PHP array
93+
* @return string The YAML string representing the PHP value
9494
*
9595
* @throws DumpException When trying to dump PHP resource
9696
*/
@@ -210,7 +210,7 @@ private static function dumpArray($value, $exceptionOnInvalidType, $objectSuppor
210210
}
211211

212212
/**
213-
* Parses a scalar to a YAML string.
213+
* Parses a YAML scalar.
214214
*
215215
* @param string $scalar
216216
* @param string $delimiters
@@ -219,7 +219,7 @@ private static function dumpArray($value, $exceptionOnInvalidType, $objectSuppor
219219
* @param bool $evaluate
220220
* @param array $references
221221
*
222-
* @return string A YAML string
222+
* @return string
223223
*
224224
* @throws ParseException When malformed inline YAML string is parsed
225225
*/
@@ -261,12 +261,12 @@ public static function parseScalar($scalar, $delimiters = null, $stringDelimiter
261261
}
262262

263263
/**
264-
* Parses a quoted scalar to YAML.
264+
* Parses a YAML quoted scalar.
265265
*
266266
* @param string $scalar
267267
* @param int &$i
268268
*
269-
* @return string A YAML string
269+
* @return string
270270
*
271271
* @throws ParseException When malformed inline YAML string is parsed
272272
*/
@@ -291,13 +291,13 @@ private static function parseQuotedScalar($scalar, &$i)
291291
}
292292

293293
/**
294-
* Parses a sequence to a YAML string.
294+
* Parses a YAML sequence.
295295
*
296296
* @param string $sequence
297297
* @param int &$i
298298
* @param array $references
299299
*
300-
* @return string A YAML string
300+
* @return array
301301
*
302302
* @throws ParseException When malformed inline YAML string is parsed
303303
*/
@@ -350,1 8739 3 +350,13 @@ private static function parseSequence($sequence, &$i = 0, $references = array())
350350
}
351351

352352
/**
353-
* Parses a mapping to a YAML string.
353+
* Parses a YAML mapping.
354354
*
355355
* @param string $mapping
356356
* @param int &$i
357357
* @param array $references
358358
*
359-
* @return string A YAML string
359+
* @return array|\stdClass
360360
*
361361
* @throws ParseException When malformed inline YAML string is parsed
362362
*/

0 commit comments

Comments
 (0)
0