phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Exception
Filter
Interfaces
ProjectDescriptor
TableOfContents
Tag
BaseTypes
Validation
Event
Guides
Handlers
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig

\phpDocumentor\DescriptorApiSetDescriptor

Summary

Methods
Properties
Constants
__construct()
getName()
addTableOfContents()
getTableOfContents()
getSource()
getOutputLocation()
getSettings()
No public properties found
No constants found
No protected methods found
$name
$source
$outputLocation
N/A
No private methods found
$tocs
$apiSpecification
N/A

Properties

$name

$name : string

Type

string —

$source

$source : \phpDocumentor\Configuration\Source

Type

Source —

$outputLocation

$outputLocation : string

Type

string —

$tocs

$tocs : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor>

Type

TocDescriptor> —

$apiSpecification

$apiSpecification : \phpDocumentor\Configuration\ApiSpecification

Type

ApiSpecification —

Methods

__construct()

__construct(string  $name, \phpDocumentor\Configuration\Source  $source, string  $outputLocation, \phpDocumentor\Configuration\ApiSpecification  $apiSpecification) : mixed

Parameters

string $name
\phpDocumentor\Configuration\Source $source
string $outputLocation
\phpDocumentor\Configuration\ApiSpecification $apiSpecification

Returns

mixed —

getName()

getName() : string

Returns

string —

addTableOfContents()

addTableOfContents(\phpDocumentor\Descriptor\TocDescriptor  $descriptor) : void

Parameters

\phpDocumentor\Descriptor\TocDescriptor $descriptor

getTableOfContents()

getTableOfContents() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor> —

getSource()

getSource() : \phpDocumentor\Configuration\Source

Returns the source location for this set of documentation.

Returns

\phpDocumentor\Configuration\Source —

getOutputLocation()

getOutputLocation() : string

Returns

string —

getSettings()

getSettings() : \phpDocumentor\Configuration\ApiSpecification

Returns

\phpDocumentor\Configuration\ApiSpecification —