class LSProtocol::SignatureInformation
- LSProtocol::SignatureInformation
- Reference
- Object
Overview
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .new(label : String | Nil, active_parameter : UInt32 | Nil = nil, documentation : MarkupContent | String | Nil = nil, parameters : Array(ParameterInformation) | Nil = nil)
Instance Method Summary
- #active_parameter : UInt32 | Nil
-
#documentation : MarkupContent | String | Nil
The human-readable doc-comment of this signature.
-
#label : String
The label of this signature.
-
#parameters : Array(ParameterInformation) | Nil
The parameters of this signature.
Constructor Detail
def self.new(label : String | Nil, active_parameter : UInt32 | Nil = nil, documentation : MarkupContent | String | Nil = nil, parameters : Array(ParameterInformation) | Nil = nil)
#
Instance Method Detail
def documentation : MarkupContent | String | Nil
#
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.