Cleanup more @return annotations

Author: nicolas-grekas

Dumper.php

@@ -46,7 +46,7 @@ public function __construct(int $indentation = 4)
      * @param int   $indent The level of indentation (used internally)
      * @param int   $flags  A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
      *
-     * @return string The YAML representation of the PHP value
+     * @return string
      */
     public function dump($input, int $inline = 0, int $indent = 0, int $flags = 0): string
     {

Escaper.php

@@ -49,8 +49,6 @@ class Escaper
      * Determines if a PHP value would require double quoting in YAML.
      *
      * @param string $value A PHP value
-     *
-     * @return bool True if the value would require double quotes
      */
     public static function requiresDoubleQuoting(string $value): bool
     {
@@ -61,8 +59,6 @@ public static function requiresDoubleQuoting(string $value): bool
      * Escapes and surrounds a PHP value with double quotes.
      *
      * @param string $value A PHP value
-     *
-     * @return string The quoted, escaped string
      */
     public static function escapeWithDoubleQuotes(string $value): string
     {
@@ -73,8 +69,6 @@ public static function escapeWithDoubleQuotes(string $value): string
      * Determines if a PHP value would require single quoting in YAML.
      *
      * @param string $value A PHP value
-     *
-     * @return bool True if the value would require single quotes
      */
     public static function requiresSingleQuoting(string $value): bool
     {
@@ -93,8 +87,6 @@ public static function requiresSingleQuoting(string $value): bool
      * Escapes and surrounds a PHP value with single quotes.
      *
      * @param string $value A PHP value
-     *
-     * @return string The quoted, escaped string
      */
     public static function escapeWithSingleQuotes(string $value): string
     {

Exception/ParseException.php

@@ -44,7 +44,7 @@ public function __construct(string $message, int $parsedLine = -1, string $snipp
     /**
      * Gets the snippet of code near the error.
      *
-     * @return string The snippet of code
+     * @return string
      */
     public function getSnippet()
     {
@@ -66,7 +66,7 @@ public function setSnippet(string $snippet)
      *
      * This method returns null if a string is parsed.
      *
-     * @return string The filename
+     * @return string
      */
     public function getParsedFile()
     {
@@ -86,7 +86,7 @@ public function setParsedFile(string $parsedFile)
     /**
      * Gets the line where the error occurred.
      *
-     * @return int The file line
+     * @return int
      */
     public function getParsedLine()
     {

Inline.php

@@ -54,7 +54,7 @@ public static function initialize(int $flags, int $parsedLineNumber = null, stri
      * @param int    $flags      A bit field of PARSE_* constants to customize the YAML parser behavior
      * @param array  $references Mapping of variable names to values
      *
-     * @return mixed A PHP value
+     * @return mixed
      *
      * @throws ParseException
      */
@@ -112,7 +112,7 @@ public static function parse(string $value = null, int $flags = 0, array &$refer
      * @param mixed $value The PHP variable to convert
      * @param int   $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
      *
-     * @return string The YAML string representing the PHP value
+     * @return string
      *
      * @throws DumpException When trying to dump PHP resource
      */
@@ -205,7 +205,7 @@ public static function dump($value, int $flags = 0): string
      *
      * @param array|\ArrayObject|\stdClass $value The PHP array or array-like object to check
      *
-     * @return bool true if value is hash array, false otherwise
+     * @return bool
      */
     public static function isHash($value): bool
     {
@@ -218,7 +218,7 @@ public static function isHash($value): bool
      * @param array $value The PHP array to dump
      * @param int   $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
      *
-     * @return string The YAML string representing the PHP array
+     * @return string
      */
     private static function dumpArray(array $value, int $flags): string
     {
@@ -544,7 +544,7 @@ private static function parseMapping(string $mapping, int $flags, int &$i = 0, a
     /**
      * Evaluates scalars and replaces magic values.
      *
-     * @return mixed The evaluated YAML string
+     * @return mixed
      *
      * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
      */
@@ -767,7 +767,7 @@ private static function isBinaryString(string $value): bool
     /**
      * Gets a regex that matches a YAML date.
      *
-     * @return string The regular expression
+     * @return string
      *
      * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
      */

Parser.php

@@ -45,7 +45,7 @@ class Parser
      * @param string $filename The path to the YAML file to be parsed
      * @param int    $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed The YAML converted to a PHP value
+     * @return mixed
      *
      * @throws ParseException If the file could not be read or the YAML is not valid
      */
@@ -74,7 +74,7 @@ public function parseFile(string $filename, int $flags = 0)
      * @param string $value A YAML string
      * @param int    $flags A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed A PHP value
+     * @return mixed
      *
      * @throws ParseException If the YAML is not valid
      */
@@ -539,8 +539,6 @@ private function parseBlock(int $offset, string $yaml, int $flags)
      * Returns the current line number (takes the offset into account).
      *
      * @internal
-     *
-     * @return int The current line number
      */
     public function getRealCurrentLineNb(): int
     {
@@ -559,8 +557,6 @@ public function getRealCurrentLineNb(): int
 
     /**
      * Returns the current line indentation.
-     *
-     * @return int The current line indentation
      */
     private function getCurrentLineIndentation(): int
     {
@@ -577,8 +573,6 @@ private function getCurrentLineIndentation(): int
      * @param int|null $indentation The indent level at which the block is to be read, or null for default
      * @param bool     $inSequence  True if the enclosing data structure is a sequence
      *
-     * @return string A YAML string
-     *
      * @throws ParseException When indentation problem are detected
      */
     private function getNextEmbedBlock(int $indentation = null, bool $inSequence = false): string
@@ -718,7 +712,7 @@ private function moveToPreviousLine(): bool
      * @param int    $flags   A bit field of PARSE_* constants to customize the YAML parser behavior
      * @param string $context The parser context (either sequence or mapping)
      *
-     * @return mixed A PHP value
+     * @return mixed
      *
      * @throws ParseException When reference does not exist
      */
@@ -938,8 +932,6 @@ private function parseBlockScalar(string $style, string $chomping = '', int $ind
 
     /**
      * Returns true if the next line is indented.
-     *
-     * @return bool Returns true if the next line is indented, false otherwise
      */
     private function isNextLineIndented(): bool
     {
@@ -969,8 +961,6 @@ private function isNextLineIndented(): bool
 
     /**
      * Returns true if the current line is blank or if it is a comment line.
-     *
-     * @return bool Returns true if the current line is empty or if it is a comment line, false otherwise
      */
     private function isCurrentLineEmpty(): bool
     {
@@ -979,8 +969,6 @@ private function isCurrentLineEmpty(): bool
 
     /**
      * Returns true if the current line is blank.
-     *
-     * @return bool Returns true if the current line is blank, false otherwise
      */
     private function isCurrentLineBlank(): bool
     {
@@ -989,8 +977,6 @@ private function isCurrentLineBlank(): bool
 
     /**
      * Returns true if the current line is a comment line.
-     *
-     * @return bool Returns true if the current line is a comment line, false otherwise
      */
     private function isCurrentLineComment(): bool
     {
@@ -1009,8 +995,6 @@ private function isCurrentLineLastLineInDocument(): bool
      * Cleanups a YAML string to be parsed.
      *
      * @param string $value The input YAML string
-     *
-     * @return string A cleaned up YAML string
      */
     private function cleanup(string $value): string
     {
@@ -1045,8 +1029,6 @@ private function cleanup(string $value): string
 
     /**
      * Returns true if the next line starts unindented collection.
-     *
-     * @return bool Returns true if the next line starts unindented collection, false otherwise
      */
     private function isNextLineUnIndentedCollection(): bool
     {
@@ -1076,8 +1058,6 @@ private function isNextLineUnIndentedCollection(): bool
 
     /**
      * Returns true if the string is un-indented collection item.
-     *
-     * @return bool Returns true if the string is un-indented collection item, false otherwise
      */
     private function isStringUnIndentedCollectionItem(): bool
     {

Unescaper.php

@@ -33,7 +33,7 @@ class Unescaper
      *
      * @param string $value A single quoted string
      *
-     * @return string The unescaped string
+     * @return string
      */
     public function unescapeSingleQuotedString(string $value): string
     {
@@ -45,7 +45,7 @@ public function unescapeSingleQuotedString(string $value): string
      *
      * @param string $value A double quoted string
      *
-     * @return string The unescaped string
+     * @return string
      */
     public function unescapeDoubleQuotedString(string $value): string
     {
@@ -62,7 +62,7 @@ public function unescapeDoubleQuotedString(string $value): string
      *
      * @param string $value An escaped character
      *
-     * @return string The unescaped character
+     * @return string
      */
     private function unescapeCharacter(string $value): string
     {

Yaml.php

@@ -46,7 +46,7 @@ class Yaml
      * @param string $filename The path to the YAML file to be parsed
      * @param int    $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed The YAML converted to a PHP value
+     * @return mixed
      *
      * @throws ParseException If the file could not be read or the YAML is not valid
      */
@@ -69,7 +69,7 @@ public static function parseFile(string $filename, int $flags = 0)
      * @param string $input A string containing YAML
      * @param int    $flags A bit field of PARSE_* constants to customize the YAML parser behavior
      *
-     * @return mixed The YAML converted to a PHP value
+     * @return mixed
      *
      * @throws ParseException If the YAML is not valid
      */
@@ -91,7 +91,7 @@ public static function parse(string $input, int $flags = 0)
      * @param int   $indent The amount of spaces to use for indentation of nested nodes
      * @param int   $flags  A bit field of DUMP_* constants to customize the dumped YAML string
      *
-     * @return string A YAML string representing the original PHP value
+     * @return string
      */
     public static function dump($input, int $inline = 2, int $indent = 4, int $flags = 0): string
     {