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
$name
protected
string
$name
= ''
$output
protected
string
$output
= '.'
$source
protected
Source
$source
$documents
private
Collection<string|int, DocumentDescriptor>
$documents
$inputFormat
private
string
$inputFormat
$tocs
private
Collection<string|int, TocDescriptor>
$tocs
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 —addDocument()
public
addDocument(string $file, DocumentDescriptor $documentDescriptor) : void
Parameters
- $file : string
- $documentDescriptor : DocumentDescriptor
Return values
void —addTableOfContents()
public
addTableOfContents(TocDescriptor $descriptor) : void
Parameters
- $descriptor : TocDescriptor
Return values
void —getDocuments()
public
getDocuments() : Collection<string|int, DocumentDescriptor>
Return values
Collection<string|int, DocumentDescriptor> —getInputFormat()
public
getInputFormat() : string
Return values
string —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() : Source
Tags
Return values
Source —getTableOfContents()
public
getTableOfContents() : Collection<string|int, TocDescriptor>