\phpDocumentor\Guides\MarkdownParser

Summary

Methods
Properties
Constants
__construct()
parse()
parseDocument()
parseParagraph()
parseListBlock()
getEnvironment()
getDocument()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$markdownParser
$environment
$parsers
$document
N/A

Properties

$markdownParser

$markdownParser : \League\CommonMark\DocParser

Type

\League\CommonMark\DocParser —

$environment

$environment : \phpDocumentor\Guides\Environment

Type

Environment

$parsers

$parsers : \phpDocumentor\Guides\Markdown\Parsers\AbstractBlock[]

Type

AbstractBlock[]

$document

$document : \phpDocumentor\Guides\Nodes\DocumentNode

Type

DocumentNode

Methods

__construct()

__construct(\phpDocumentor\Guides\Environment  $environment) : mixed

Parameters

\phpDocumentor\Guides\Environment $environment

Returns

mixed —

parse()

parse(string  $contents) : \phpDocumentor\Guides\Nodes\DocumentNode

Parameters

string $contents

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

parseDocument()

parseDocument(\League\CommonMark\Node\NodeWalker  $walker, string  $hash) : \phpDocumentor\Guides\Nodes\DocumentNode

Parameters

\League\CommonMark\Node\NodeWalker $walker
string $hash

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —

parseParagraph()

parseParagraph(\League\CommonMark\Node\NodeWalker  $walker) : \phpDocumentor\Guides\Nodes\ParagraphNode

Parameters

\League\CommonMark\Node\NodeWalker $walker

Returns

\phpDocumentor\Guides\Nodes\ParagraphNode —

parseListBlock()

parseListBlock(\League\CommonMark\Node\NodeWalker  $walker) : \phpDocumentor\Guides\Nodes\ListNode

Parameters

\League\CommonMark\Node\NodeWalker $walker

Returns

\phpDocumentor\Guides\Nodes\ListNode —

getEnvironment()

getEnvironment() : \phpDocumentor\Guides\Environment

Returns

\phpDocumentor\Guides\Environment —

getDocument()

getDocument() : \phpDocumentor\Guides\Nodes\DocumentNode

Returns

\phpDocumentor\Guides\Nodes\DocumentNode —