phpDocumentor

GuideSetDescriptor extends DocumentationSetDescriptor
in package

Table of Contents

$name  : string
$output  : string
$source  : Source
$documents  : Collection<string|int, DocumentDescriptor>
$inputFormat  : string
$tocs  : Collection<string|int, TocDescriptor>
__construct()  : mixed
addDocument()  : void
addTableOfContents()  : void
getDocuments()  : Collection<string|int, DocumentDescriptor>
getInputFormat()  : string
getName()  : string
getOutput()  : string
getSource()  : Source
Returns the source location for this set of documentation.
getTableOfContents()  : Collection<string|int, TocDescriptor>

Properties

Methods

__construct()

public __construct(string $name, Source $source, string $output, string $inputFormat) : mixed
Parameters
$name : string
$source : Source
$output : string
$inputFormat : string
Return values
mixed

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