function PhpDocParser::parseOptionalDescription

20 calls to PhpDocParser::parseOptionalDescription()

PhpDocParser::parseAssertTagValue in vendor/phpstan/phpdoc-parser/src/Parser/PhpDocParser.php

*

PhpDocParser::parseDeprecatedTagValue in vendor/phpstan/phpdoc-parser/src/Parser/PhpDocParser.php

PhpDocParser::parseExtendsTagValue in vendor/phpstan/phpdoc-parser/src/Parser/PhpDocParser.php

PhpDocParser::parseMethodTagValue in vendor/phpstan/phpdoc-parser/src/Parser/PhpDocParser.php

PhpDocParser::parseMixinTagValue in vendor/phpstan/phpdoc-parser/src/Parser/PhpDocParser.php

... See full list

File

vendor/phpstan/phpdoc-parser/src/Parser/PhpDocParser.php, line 1278

Class

PhpDocParser

@phpstan-import-type ValueType from Doctrine\DoctrineArgument as DoctrineValueType

Namespace

PHPStan\PhpDocParser\Parser

Code

private function parseOptionalDescription(TokenIterator $tokens, bool $limitStartToken = false) : string {
    if ($limitStartToken) {
        foreach (self::DISALLOWED_DESCRIPTION_START_TOKENS as $disallowedStartToken) {
            if (!$tokens->isCurrentTokenType($disallowedStartToken)) {
                continue;
            }
            $tokens->consumeTokenType(Lexer::TOKEN_OTHER);
            // will throw exception
        }
        if ($this->requireWhitespaceBeforeDescription && !$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL, Lexer::TOKEN_CLOSE_PHPDOC, Lexer::TOKEN_END) && !$tokens->isPrecededByHorizontalWhitespace()) {
            $tokens->consumeTokenType(Lexer::TOKEN_HORIZONTAL_WS);
            // will throw exception
        }
    }
    return $this->parseText($tokens)->text;
}