Parser

Parses doc comments

class Parser

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`?TagFactory $tagFactory = null`) Creates a new Parser.

Public
Returns	Signature and Description
`Block`	`parse`(`?ScannedBase $token`) Parses a doc comment.
`Block`	`parseString`(`?string $comment`, `?ScannedBase $token = null`) Parses a doc comment string.

Protected
Returns	Signature and Description
`string`	`extract`(`string $comment`) Extract the content from the comment.

public function __construct(?TagFactory $tagFactory = null)

Creates a new Parser.

Parameters
Name	Type	Description
`$tagFactory`	`?TagFactory`	Optional. The factory to use.

protected function extract(string $comment)

Extract the content from the comment.

Parameters
Name	Type	Description
`$comment`	`string`	The comment to clean up

Returns
Type	Description
`string`	The extracted content

public function parse(?ScannedBase $token)

Parses a doc comment.

Parameters
Name	Type	Description
`$token`	`?ScannedBase`	The token whose doc comment will be evaluated

Returns
Type	Description
`Block`	The parsed block

public function parseString(?string $comment, ?ScannedBase $token = null)

Parses a doc comment string.

Parameters
Name	Type	Description
`$comment`	`?string`	The doc comment
`$token`	`?ScannedBase`	The token whose doc comment will be evaluated

Returns
Type	Description
`Block`	The parsed block