ExampleTagsEnricher

Implements \phpDocumentor\Compiler\CompilerPassInterface

This index builder collects all examples from tags and inserts them into the example index.

package

Default

Methods

Initializes this compiler pass with its dependencies.

__construct(\phpDocumentor\Descriptor\Example\Finder $finder) 

Arguments

$finder

\phpDocumentor\Descriptor\Example\Finder

Finds examples in several directories.

Executes a compiler pass.

execute(\phpDocumentor\Descriptor\ProjectDescriptor $project) : mixed

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.

Arguments

$project

\phpDocumentor\Descriptor\ProjectDescriptor

Representation of the Object Graph that can be manipulated.

Response

mixed

Returns a textual description of what this pass does for output purposes.

getDescription() : string

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Response

string

Replaces the example tags in the description with the contents of the found example.

replaceInlineExamples(\phpDocumentor\Descriptor\DescriptorAbstract $element) : string

Arguments

Response

string

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY

Properties

exampleAssembler

exampleAssembler : \phpDocumentor\Descriptor\Builder\Reflector\Tags\ExampleAssembler