TokenDeclaration<T as ScannedBase>

A thing and its corresponding doc block

interface TokenDeclaration<T as ScannedBase> extends Declaration
Copyright
2016 Appertly
License
Apache-2.0

Instance Methods

Public
ReturnsSignature and Description
Block
getDocBlock()

Gets the doc comment block.

string
getFilename()

Gets the source filename.

string
getName()

Gets the name of the declaration.

T
getToken()

Gets the scanned token.

Method Details

getDocBlock

Inherited from Declaration

abstract public function getDocBlock()

Gets the doc comment block.

Returns
TypeDescription
Block

The doc block, which could be empty

getFilename

Inherited from Declaration

abstract public function getFilename()

Gets the source filename.

Returns
TypeDescription
string

The filename

getName

abstract public function getName()

Gets the name of the declaration.

Returns
TypeDescription
string

The declaration name

getToken

abstract public function getToken()

Gets the scanned token.

Returns
TypeDescription
T

The scanned token