phpDocumentor

Doc extends Reference
in package

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

Tags
link
https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html

Table of Contents

$dependenciesMustBeResolved  : bool
Used with "ref" - it means the dependencies added in found() must be resolved to their final path later (they are not already document names).
$name  : string
$resolver  : Resolver
__construct()  : mixed
found()  : void
Called when a reference is just found
getName()  : string
The name of the reference, i.e the :something:
resolve()  : ResolvedReference|null
Resolve the reference and returns an array

Properties

$dependenciesMustBeResolved

Used with "ref" - it means the dependencies added in found() must be resolved to their final path later (they are not already document names).

private bool $dependenciesMustBeResolved

$name

private string $name

Methods

__construct()

public __construct([string $name = 'doc' ][, bool $dependenciesMustBeResolved = false ]) : mixed
Parameters
$name : string = 'doc'
$dependenciesMustBeResolved : bool = false
Return values
mixed

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

getName()

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

public getName() : string
Return values
string

Search results