COMPILER_PRIORITY
COMPILER_PRIORITY = 9002
This index builder collects all examples from tags and inserts them into the example index.
$exampleAssembler : \phpDocumentor\Descriptor\Builder\Reflector\Tags\ExampleAssembler
__construct(\phpDocumentor\Descriptor\Example\Finder $finder)
Initializes this compiler pass with its dependencies.
\phpDocumentor\Descriptor\Example\Finder | $finder | Finds examples in several directories. |
execute(\phpDocumentor\Descriptor\ProjectDescriptor $project) : mixed
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.
\phpDocumentor\Descriptor\ProjectDescriptor | $project | Representation of the Object Graph that can be manipulated. |
replaceInlineExamples(\phpDocumentor\Descriptor\DescriptorAbstract $element) : string
Replaces the example tags in the description with the contents of the found example.
\phpDocumentor\Descriptor\DescriptorAbstract | $element |