phpDocumentor

NamespaceReference extends Reference
in package

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

Tags
link
https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html

Table of Contents

found()  : void
Called when a reference is just found
getDomain()  : string
Returns the domain for the role of this reference, or empty in case no domain was detected.
getName()  : string
getRole()  : string
resolve()  : ResolvedReference

Methods

found()

Called when a reference is just found

public found(Environment $environment, string $data) : void
Parameters
$environment : Environment

the Environment in use

$data : string

the data of the reference

Return values
void

getRole()

public getRole() : string
Return values
string

Search results