phpDocumentor

GuideSetDescriptor extends DocumentationSetDescriptor
in package

Table of Contents

$name  : string
$output  : string
$source  : mixed
__construct()  : mixed
getName()  : string
getOutput()  : string
getSource()  : array<string|int, mixed>
Returns the source location for this set of documentation.

Properties

Methods

__construct()

public __construct(string $name, array<string|int, mixed> $source, string $output) : mixed
Parameters
$name : string
$source : array<string|int, mixed>
$output : string
Return values
mixed

getSource()

Returns the source location for this set of documentation.

public getSource() : array<string|int, mixed>

The returned array contains an element 'dsn' (of type DSN) and 'paths'; where each path represents one part of the documentation set relative to the DSN.

Tags
todo:

should the source location be included in a Descriptor? This couples it to the file system upon which it was ran and makes it uncacheable. But should this be cached? In any case, I need it for the RenderGuide writer at the moment; so refactor this once that becomes clearer.

Return values
array<string|int, mixed>

Search results