phpDocumentor\Reflection\DocBlock\ExampleFinder Class Reference

Public Member Functions
	find (Example $example)
	setSourceDirectory (string $directory='')
	getSourceDirectory ()
	setExampleDirectories (array $directories)
	getExampleDirectories ()

Detailed Description

Class used to find an example file's location based on a given ExampleDescriptor.

Member Function Documentation

find()

phpDocumentor\Reflection\DocBlock\ExampleFinder::find

(

Example

$example

)

Attempts to find the example contents for the given descriptor.

getExampleDirectories()

phpDocumentor\Reflection\DocBlock\ExampleFinder::getExampleDirectories

(

)

Returns a series of directories that may contain examples.

Returns

string[]

getSourceDirectory()

phpDocumentor\Reflection\DocBlock\ExampleFinder::getSourceDirectory

(

)

Returns the project's root directory where an 'examples' folder can be expected.

setExampleDirectories()

phpDocumentor\Reflection\DocBlock\ExampleFinder::setExampleDirectories

(

array

$directories

)

Registers a series of directories that may contain examples.

Parameters

string[]

$directories

setSourceDirectory()

phpDocumentor\Reflection\DocBlock\ExampleFinder::setSourceDirectory

(

string

$directory = ''

)

Registers the project's root directory where an 'examples' folder can be expected.

---

The documentation for this class was generated from the following file:

• vendor/phpdocumentor/reflection-docblock/src/DocBlock/ExampleFinder.php