MarkerFromTagsExtractor extends ApiDocumentationPass
This index builder collects all markers from tags and inserts them into the marker index.
Attributes
- #[Stage]
- 'phpdoc.pipeline.api_documentation.compile'
- 9000
- 'Collect all markers embedded in tags'
Table of Contents
Methods
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
- process() : ApiSetDescriptor
- Actual method executed by the compiler.
- 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.
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()
Returns a textual description of what this pass does for output purposes.
public
getDescription() : string
Please note that the command line will be truncated to 68 characters (
Return values
stringprocess()
Actual method executed by the compiler.
protected
process(ApiSetDescriptor $subject) : ApiSetDescriptor
Processes the given ApiSetDescriptor and returns the modified 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