phpDocumentor

GuideSetDescriptor extends DocumentationSetDescriptor
in package

FinalYes

Table of Contents

Properties

$description  : DescriptionDescriptor|null
$name  : string
$outputLocation  : string
$source  : Source
$documents  : Collection<string|int, DocumentDescriptor>
$files  : Collection<string|int, FileInterface>
$indexes  : Collection<string|int, Collection<string|int, ElementInterface>>
$initialHeaderLevel  : int
$inputFormat  : string
$outputFormat  : string
$projectNode  : ProjectNode
$tocs  : Collection<string|int, TocDescriptor>

Methods

__construct()  : mixed
addDocument()  : void
addTableOfContents()  : void
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getDocuments()  : Collection<string|int, DocumentDescriptor>
getFiles()  : Collection<string|int, FileInterface>
Returns the list of files that is in this documentation set.
getGuidesProjectNode()  : ProjectNode
getIndex()  : Collection<string|int, ElementInterface>
Returns an index with the given name.
getIndexes()  : Collection<string|int, Collection<string|int, ElementInterface>>
Returns all indexes in this documentation set.
getInitialHeaderLevel()  : int
getInputFormat()  : string
getName()  : string
Returns the name for this element.
getOutputFormat()  : string
getOutputLocation()  : string
getSource()  : Source
Returns the source location for this set of documentation.
getTableOfContents()  : Collection<string|int, TocDescriptor>
setDescription()  : void
Sets a description or none to inherit from a parent.
setFiles()  : void
Sets the list of files that is in this documentation set.
setIndexes()  : void
Sets all indexes for this documentation set.

Properties

Methods

getGuidesProjectNode()

public getGuidesProjectNode() : ProjectNode
Return values
ProjectNode

getName()

Returns the name for this element.

public getName() : string
Return values
string

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

setIndexes()

Sets all indexes for this documentation set.

public setIndexes(Collection<string|int, Collection<string|int, ElementInterface>> $indexes) : void

An index is a compilation of references to elements, usually constructed in a compiler step, that aids template generation by providing a conveniently assembled list. An example of such an index is the 'marker' index where a list of TODOs and FIXMEs are located in a central location for reporting.

Parameters
$indexes : Collection<string|int, Collection<string|int, ElementInterface>>

        
On this page

Search results