ParamDoc

One parameter of a method, with the type actually rendered and its prose.

Synopsis

final class ParamDoc


Source	`Ir/ParamDoc.php`

Properties

Property	Type	Description
`$byReference`	`bool`	readonly.
`$default`	?``string	readonly.
`$description`	`string`	readonly.
`$name`	`string`	readonly.
`$promoted`	`bool`	readonly.
`$type`	`TypeRef`	readonly.
`$variadic`	`bool`	readonly.

Constructor

__construct()

public function __construct(string $name, TypeRef $type, bool $byReference = false, bool $variadic = false, bool $promoted = false, ?string $default = null, string $description = ''): mixed

Parameter	Type	Description
`$name`	`string`
`$type`	`TypeRef`
`$byReference`	`bool`
`$variadic`	`bool`
`$promoted`	`bool`
`$default`	?``string
`$description`	`string`

Returns mixed

Methods

Method	Description
`signature(): string`	The parameter as it appears in a signature, defaults and all.

signature()

public function signature(): string

The parameter as it appears in a signature, defaults and all.

Returns string