\phpDocumentor\Compiler\PassExampleTagsEnricher

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

Summary

Methods
Properties
Constants
__construct()
getDescription()
execute()
No public properties found
COMPILER_PRIORITY
replaceInlineExamples()
No protected properties found
N/A
No private methods found
$exampleAssembler
N/A

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY

Properties

Methods

__construct()

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

Initializes this compiler pass with its dependencies.

Parameters

\phpDocumentor\Descriptor\Example\Finder $finder

Finds examples in several directories.

getDescription()

getDescription() : string

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

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

Returns

string

execute()

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.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Representation of the Object Graph that can be manipulated.

Returns

mixed

replaceInlineExamples()

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

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

Parameters

\phpDocumentor\Descriptor\DescriptorAbstract $element

Returns

string