Sha256: 0a0f1426f23bfc045966e660b347241fbab3af3925903cc18465c64f15c6d022
Contents?: true
Size: 1.73 KB
Versions: 108
Compression:
Stored size: 1.73 KB
Contents
module LanguageServer
module Protocol
module Interface
#
# Represents the signature of something callable. A signature
# can have a label, like a function-name, a doc-comment, and
# a set of parameters.
#
class SignatureInformation
def initialize(label:, documentation: nil, parameters: nil, active_parameter: nil)
@attributes = {}
@attributes[:label] = label
@attributes[:documentation] = documentation if documentation
@attributes[:parameters] = parameters if parameters
@attributes[:activeParameter] = active_parameter if active_parameter
@attributes.freeze
end
#
# The label of this signature. Will be shown in
# the UI.
#
# @return [string]
def label
attributes.fetch(:label)
end
#
# The human-readable doc-comment of this signature. Will be shown
# in the UI but can be omitted.
#
# @return [string | MarkupContent]
def documentation
attributes.fetch(:documentation)
end
#
# The parameters of this signature.
#
# @return [ParameterInformation[]]
def parameters
attributes.fetch(:parameters)
end
#
# The index of the active parameter.
#
# If provided, this is used in place of `SignatureHelp.activeParameter`.
#
# @return [number]
def active_parameter
attributes.fetch(:activeParameter)
end
attr_reader :attributes
def to_hash
attributes
end
def to_json(*args)
to_hash.to_json(*args)
end
end
end
end
end
Version data entries
108 entries across 108 versions & 13 rubygems