MarkerFromTagsExtractor
extends ApiDocumentationPass
in package
FinalYes
This index builder collects all markers from tags and inserts them into the marker index.
Table of Contents
Constants
- COMPILER_PRIORITY = 9000
Methods
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- process() : ApiSetDescriptor
- addTodoMarkerToFile() : void
- Adds a marker with the TO DO information to the file on a given line number.
- getFileDescriptor() : FileDescriptor
- Retrieves the File Descriptor from the given element.
Constants
COMPILER_PRIORITY
public
mixed
COMPILER_PRIORITY
= 9000
Methods
__invoke()
Executes a compiler pass.
public
final __invoke(CompilableSubject $subject) : CompilableSubject
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
- $subject : CompilableSubject
-
Representation of the Object Graph that can be manipulated.
Return values
CompilableSubjectgetDescription()
public
getDescription() : string
Return values
stringprocess()
protected
process(ApiSetDescriptor $subject) : ApiSetDescriptor
Parameters
- $subject : ApiSetDescriptor
Return values
ApiSetDescriptoraddTodoMarkerToFile()
Adds a marker with the TO DO information to the file on a given line number.
private
addTodoMarkerToFile(FileDescriptor $fileDescriptor, TagDescriptor $todo, int $lineNumber) : void
Parameters
- $fileDescriptor : FileDescriptor
- $todo : TagDescriptor
- $lineNumber : int
getFileDescriptor()
Retrieves the File Descriptor from the given element.
private
getFileDescriptor(DescriptorAbstract $element) : FileDescriptor
Parameters
- $element : DescriptorAbstract