\phpDocumentor\Pipeline\StageInitializeBuilderFromConfig

Summary

Methods
Properties
Constants
__construct()
__invoke()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
buildVersion()
guardAgainstMultipleSetsOfTheSameType()
$partials
N/A

Properties

$partials

$partials : \phpDocumentor\Descriptor\Collection<string>

Type

\phpDocumentor\Descriptor\Collection

Methods

__construct()

__construct(\phpDocumentor\Descriptor\Collection<string>  $partials) : mixed

Parameters

\phpDocumentor\Descriptor\Collection $partials

Returns

mixed —

__invoke()

__invoke(\phpDocumentor\Pipeline\Stage\Payload  $payload) : \phpDocumentor\Pipeline\Stage\Payload

Parameters

\phpDocumentor\Pipeline\Stage\Payload $payload

Returns

\phpDocumentor\Pipeline\Stage\Payload —

buildVersion()

buildVersion(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Descriptor\VersionDescriptor

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Descriptor\VersionDescriptor —

guardAgainstMultipleSetsOfTheSameType()

guardAgainstMultipleSetsOfTheSameType(\phpDocumentor\Configuration\VersionSpecification  $version) : void

Until official support is added for versions, check whether there is 1 and fail when multiple is given.

By adding this restriction, it should prevent confusion with users when they were to add multiple in the configuration.

Parameters

\phpDocumentor\Configuration\VersionSpecification $version