View source

class DocumentSymbol

package moonshine.lsp

@:directlyUsed@:structInit

Implementation of DocumentSymbol interface from Language Server Protocol

DO NOT add new properties or methods to this class that are specific to Moonshine IDE or to a particular language. Create a subclass for new properties or create a utility function for methods.

See also:

Static methods

staticparse(original:Dynamic):DocumentSymbol

Constructor

new()

Variables

children:Array<DocumentSymbol>

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

deprecated:Bool

Indicates if this symbol is deprecated.

Deprecated. Use tags instead

detail:String

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

kind:SymbolKind

The kind of this symbol.

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.

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

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

tags:Array<SymbolTag>

Tags for this document symbol.