lsp / org.pinelang.lsp.lsp.models / DocumentSymbol

DocumentSymbol

data class DocumentSymbol

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

Name

Summary

<init>

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.DocumentSymbol(name:String, detail:String, kind:SymbolKind, deprecated:Boolean?, range:Range, selectionRange:Range, children:List<DocumentSymbol>?)

Properties

Name	Summary
children	Children of this symbol, e.g. properties of a class.val children:List<DocumentSymbol>?
deprecated	Indicates if this symbol is deprecated.val deprecated:Boolean?
detail	More detail for this symbol, e.g the signature of a function.val detail:String
kind	The kind of this symbol.val kind:SymbolKind
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.val name:String
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.val range:Range
selectionRange	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.val selectionRange:Range