View source

typedef DocumentSymbol

package languageServerProtocol

import languageServerProtocol.Types

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.

Fields

@:optionaloptionaltags:Null<Array<SymbolTag>>

Tags for this completion item.

Available since

3.16.0 - Proposed state

.

selectionRange:Range

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

range: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 the clients cursor is inside the symbol to reveal in the symbol in the UI.

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.

kind:SymbolKind

The kind of this symbol.

@:optionaloptionaldetail:Null<String>

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

@:optionaloptionaldeprecated:Null<Bool>

Deprecated: "Use tags instead"

Indicates if this symbol is deprecated.

@:optionaloptionalchildren:Null<Array<DocumentSymbol>>

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