Configuration

Configuration definition for the transformer.

package

Default

Methods

Returns the references to external documentation sites for classes not found in the parsed contents.

getExternalClassDocumentation() : array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>

Returns the location where the output of the parser is located.

getSource() : string|null

Response

string|null

Returns the destination location where the output of the transformation process should be written to.

getTarget() : string

Response

string

Sets references to external documentation sites for classes not found in the parsed contents.

setExternalClassDocumentation(array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation> $externalClassDocumentation) : void

Arguments

Set the source location where the parser's output can be found.

setSource(string $source) : void

This might, for example, be used in the Run command to read the parser's output location from the target setting in the configuration of the parser and then, by using this method, be set.

Arguments

$source

string

Properties

the location of the product created by the Parser that is used as input for the transformation process, or when null the transformer will determine the location by reading the parser's `target` setting.

source : string|null
var

the location of the product created by the Parser that is used as input for the transformation process, or when null the transformer will determine the location by reading the parser's target setting.

Serializer\Type

("string")

Type(s)

string|null

destination location for the transformer's output

target : string
var

destination location for the transformer's output

Serializer\Type

("string")

Type(s)

string

A series of references to external API documentation sites where classes with a specific prefix can link to.

externalClassDocumentation : array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>
var

A series of references to external API documentation sites where classes with a specific prefix can link to.

Serializer\Type

("array<phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>")

Serializer\SerializedName

("external-class-documentation")

Type(s)

array<mixed,\phpDocumentor\Transformer\Configuration\ExternalClassDocumentation>