class

LSProtocol::DocumentSymbol

Inherits JSON::Serializable / Reference / Object

Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.

Constructors

new(kind : SymbolKind | Nil, name : String | Nil, range : Range | Nil, selection_range : Range | Nil, children : Array(DocumentSymbol) | Nil = nil, deprecated : Bool | Nil = nil, detail : String | Nil = nil, tags : Array(SymbolTag) | Nil = nil)
Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

children

Children of this symbol, e.g. properties of a class.

Source
deprecated

Indicates if this symbol is deprecated.

@deprecated Use tags instead

Source
detail

More detail for this symbol, e.g the signature of a function.

Source
kind

The kind of this symbol.

Source
name

The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.

Source
range

The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.

Source
selection_range

The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the range.

Source
tags

Tags for this document symbol.

@since 3.16.0

Source