lsp.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.

@since 3.16.0

Fields8

DocumentSymbol.name : string

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.

DocumentSymbol.detail : nil | string

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

DocumentSymbol.kind : lsp.SymbolKind

The kind of this symbol.

DocumentSymbol.tags : lsp.SymbolTag[] | nil

DocumentSymbol.deprecated : nil | boolean

Deprecated

Use tags instead

DocumentSymbol.range : lsp.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.

DocumentSymbol.selectionRange : lsp.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.

DocumentSymbol.children : lsp.DocumentSymbol[] | nil

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