phpDocumentor

ApiSetDescriptor extends DocumentationSetDescriptor
in package

Table of Contents

$name  : string
$output  : string
$source  : Source
$apiSpecification  : ApiSpecification
$tocs  : Collection<string|int, TocDescriptor>
__construct()  : mixed
addTableOfContents()  : void
getName()  : string
getOutput()  : string
getSettings()  : ApiSpecification
getSource()  : Source
Returns the source location for this set of documentation.
getTableOfContents()  : Collection<string|int, TocDescriptor>

Properties

Methods

getSource()

Returns the source location for this set of documentation.

public getSource() : Source
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
Source

Search results