\phpDocumentor\Guides\RestructuredText\ParserLineChecker

Summary

Methods
Properties
Constants
__construct()
isSpecialLine()
isListLine()
isBlockLine()
isComment()
isDirective()
isDefinitionList()
isDefinitionListEnded()
No public properties found
HEADER_LETTERS
No protected methods found
No protected properties found
N/A
No private methods found
$lineParser
N/A

Constants

HEADER_LETTERS

HEADER_LETTERS = ['=', '-', '~', '*', '+', '^', '"', '.', '`', "'", '_', '#', ':']

Properties

$lineParser

$lineParser : \phpDocumentor\Guides\RestructuredText\Parser\LineDataParser

Type

LineDataParser

Methods

__construct()

__construct(\phpDocumentor\Guides\RestructuredText\Parser\LineDataParser  $lineParser) : mixed

Parameters

\phpDocumentor\Guides\RestructuredText\Parser\LineDataParser $lineParser

Returns

mixed —

isSpecialLine()

isSpecialLine(string  $line) : ?string

Parameters

string $line

Returns

?string —

isListLine()

isListLine(string  $line, bool  $isCode) : bool

Parameters

string $line
bool $isCode

Returns

bool —

isBlockLine()

isBlockLine(string  $line) : bool

Parameters

string $line

Returns

bool —

isComment()

isComment(string  $line) : bool

Parameters

string $line

Returns

bool —

isDirective()

isDirective(string  $line) : bool

Parameters

string $line

Returns

bool —

isDefinitionList()

isDefinitionList(string  $line) : bool

Parameters

string $line

Returns

bool —

isDefinitionListEnded()

isDefinitionListEnded(string  $line, string  $nextLine) : bool

Parameters

string $line
string $nextLine

Returns

bool —