\phpDocumentorConfiguration

The definition for the configuration of phpDocumentor.

Summary

Methods
Properties
Constants
__construct()
getTitle()
getFiles()
getLogging()
getParser()
getPartials()
getPlugins()
getTransformations()
getTransformer()
getTranslator()
No public properties found
No constants found
No protected methods found
$title
$parser
$logging
$transformer
$files
$plugins
$transformations
$translator
$partials
N/A
No private methods found
No private properties found
N/A

Properties

$title

$title : string

Type

string — The title for the generated documentation.

$plugins

$plugins : array<mixed,\phpDocumentor\Plugin\Plugin>

Type

array<mixed,\phpDocumentor\Plugin\Plugin> — contains a listing of all plugins that should be loaded during startup.

$transformations

$transformations : array<mixed,\phpDocumentor\Transformer\Configuration\Transformations>

Type

array<mixed,\phpDocumentor\Transformer\Configuration\Transformations> — contains a list of all templates and custom transformations that are to be executed during the transformation process.

$partials

$partials : array<mixed,\phpDocumentor\Partials\Partial>

Type

array<mixed,\phpDocumentor\Partials\Partial> — A list of custom texts, or references thereto, that may be injected into templates.

Methods

__construct()

__construct() 

Initializes all settings with their default values.

getTitle()

getTitle() : string

Returns the title for the generated documentation.

Returns

string

getPartials()

getPartials() : array<mixed,\phpDocumentor\Partials\Partial>

Returns all partials that can be imported in the application.

Returns

array<mixed,\phpDocumentor\Partials\Partial>

getPlugins()

getPlugins() : array<mixed,\phpDocumentor\Plugin\Plugin>

Returns a list of all plugins that should be loaded by the application.

Returns

array<mixed,\phpDocumentor\Plugin\Plugin>