\phpDocumentor\Guides\ReferencesPhpFunctionReference

A reference is something that can be resolved in the document, for instance:

Summary

Methods
Properties
Constants
getName()
resolve()
found()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getName()

getName() : string

The name of the reference, i.e the :something:

Returns

string —

resolve()

resolve(\phpDocumentor\Guides\Environment  $environment, string  $data) : \phpDocumentor\Guides\References\ResolvedReference

Resolve the reference and returns an array

Parameters

\phpDocumentor\Guides\Environment $environment

the Environment in use

string $data

the data of the reference

Returns

\phpDocumentor\Guides\References\ResolvedReference —

found()

found(\phpDocumentor\Guides\Environment  $environment, string  $data) : void

Called when a reference is just found

Parameters

\phpDocumentor\Guides\Environment $environment

the Environment in use

string $data

the data of the reference