ParameterInformation
in package
implements
JsonSerializable
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $documentation : MarkupContent|string|null
- The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
- $label : string|array<string|int, int>
- The label of this parameter information.
Methods
- __construct() : mixed
- Create ParameterInformation
- jsonSerialize() : mixed
- This is needed because VSCode Does not like nulls meaning if a null is sent then this will not compute
Properties
$documentation
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
public
MarkupContent|string|null
$documentation
$label
The label of this parameter information.
public
string|array<string|int, int>
$label
Either a string or an inclusive start and exclusive end offsets within its containing
signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
string representation as Position and Range does.
Note: a label of type string should be a substring of its containing signature label.
Its intended use case is to highlight the parameter label part in the SignatureInformation.label.
Methods
__construct()
Create ParameterInformation
public
__construct(string|array<string|int, int> $label[, MarkupContent|string|null $documentation = null ]) : mixed
Parameters
- $label : string|array<string|int, int>
-
The label of this parameter information.
- $documentation : MarkupContent|string|null = null
-
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
jsonSerialize()
This is needed because VSCode Does not like nulls meaning if a null is sent then this will not compute
public
jsonSerialize() : mixed
Attributes
- #[ReturnTypeWillChange]