ResolveInlineMarkers
extends ApiDocumentationPass
in package
FinalYes
Attributes
- #[Stage]
- 'phpdoc.pipeline.api_documentation.compile'
- 9000
- 'Collect all markers in a file'
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
- Scans the files for markers and records them in the markers property of a file.
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()
Scans the files for markers and records them in the markers property of a file.
protected
process(ApiSetDescriptor $subject) : ApiSetDescriptor
Parameters
- $subject : ApiSetDescriptor