ExampleTagsEnricher
in package
Implements
CompilerPassInterface
This index builder collects all examples from tags and inserts them into the example index.
Interfaces, Classes & Used Traits
- CompilerPassInterface
- Represents a single pass / business rule to be executed by the Compiler.
Constants
COMPILER_PRIORITY Line 31
mixed COMPILER_PRIORITY = 9002
Properties
$exampleAssembler Line 34
private$exampleAssembler : \phpDocumentor\Descriptor\Builder\Reflector\Tags\ExampleAssembler
Methods
__construct() Line 41
Initializes this compiler pass with its dependencies.
public__construct(ExampleFinder $finder) : mixed
Parameters
Finds examples in several directories.
Returns
mixed —
getDescription() Line 46
Returns a textual description of what this pass does for output purposes.
publicgetDescription() : string
Please note that the command line will be truncated to 68 characters (
Returns
string —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.
replaceInlineExamples() Line 64
Replaces the example tags in the description with the contents of the found example.
protectedreplaceInlineExamples(DescriptorAbstract $element) : string