ApiSetDescriptor
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
$name
protected
string
$name
= ''
$output
protected
string
$output
= '.'
$source
protected
mixed
$source
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 —getName()
public
getName() : string
Return values
string —getOutput()
public
getOutput() : string
Return values
string —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.