struct LSP::DocumentSymbol
- LSP::DocumentSymbol
- Struct
- Value
- Object
Overview
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.
Included Modules
- JSON::Serializable
- LSP::Initializer
Defined in:
requests/language_features/document_symbols.crConstructors
Instance Method Summary
-
#children : Array(DocumentSymbol) | Nil
Children of this symbol, e.g.
-
#children=(children : Array(DocumentSymbol) | Nil)
Children of this symbol, e.g.
-
#deprecated : Bool | Nil
Indicates if this symbol is deprecated.
-
#deprecated=(deprecated : Bool | Nil)
Indicates if this symbol is deprecated.
-
#detail : String | Nil
More detail for this symbol, e.g the signature of a function.
-
#detail=(detail : String | Nil)
More detail for this symbol, e.g the signature of a function.
-
#kind : LSP::SymbolKind
The kind of this symbol.
-
#kind=(kind : LSP::SymbolKind)
The kind of this symbol.
-
#name : String
The name of this symbol.
-
#name=(name : String)
The name of this symbol.
-
#range : LSP::Range
The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
-
#range=(range : LSP::Range)
The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
- #selection_range : LSP::Range
- #selection_range=(selection_range : LSP::Range)
- #to_symbol_information_array(uri : String)
Constructor Detail
Instance Method Detail
Children of this symbol, e.g. properties of a class.
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.
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.
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.
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.