\phpDocumentor\Compiler\PassMarkerFromTagsExtractor

getDescription()

getDescription() : string

Returns a textual description of what this pass does for output purposes.

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Returns

execute()

execute(\phpDocumentor\Descriptor\ProjectDescriptor  $project) : void

Executes a compiler pass.

This method will execute the business logic associated with a given compiler pass and allow it to manipulate or consumer the Object Graph using the ProjectDescriptor object.

Parameters

getFileDescriptor()

getFileDescriptor(\phpDocumentor\Descriptor\DescriptorAbstract  $element) : \phpDocumentor\Descriptor\FileDescriptor

Retrieves the File Descriptor from the given element.

Parameters

Throws

\UnexpectedValueException

If the provided element does not have a file associated with it.

Returns

addTodoMarkerToFile()

addTodoMarkerToFile(\phpDocumentor\Descriptor\FileDescriptor  $fileDescriptor, \phpDocumentor\Descriptor\TagDescriptor  $todo, int  $lineNumber) : void

Adds a marker with the TO DO information to the file on a given line number.

Parameters