dots.vscode.document-symbol
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.
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.
childrencljs
(children document-symbol)Children of this symbol, e.g. properties of a class.
Returns: DocumentSymbol[]
Children of this symbol, e.g. properties of a class. **Returns:** `DocumentSymbol[]`
detailcljs
(detail document-symbol)More detail for this symbol, e.g. the signature of a function.
Returns: string
More detail for this symbol, e.g. the signature of a function. **Returns:** `string`
kindcljs
(kind document-symbol)The kind of this symbol.
Returns: SymbolKind
The kind of this symbol. **Returns:** `SymbolKind`
namecljs
(name document-symbol)The name of this symbol.
Returns: string
The name of this symbol. **Returns:** `string`
rangecljs
(range document-symbol)The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
Returns: Range
The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code. **Returns:** `Range`
selection-rangecljs
(selection-range document-symbol)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 {@linkcode DocumentSymbol.range range}.
Returns: 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 {@linkcode DocumentSymbol.range range}.
**Returns:** `Range`set-children!cljs
(set-children! document-symbol value)Children of this symbol, e.g. properties of a class.
Children of this symbol, e.g. properties of a class.
set-detail!cljs
(set-detail! document-symbol value)More detail for this symbol, e.g. the signature of a function.
More detail for this symbol, e.g. the signature of a function.
set-kind!cljs
(set-kind! document-symbol value)The kind of this symbol.
The kind of this symbol.
set-name!cljs
(set-name! document-symbol value)The name of this symbol.
The name of this symbol.
set-range!cljs
(set-range! document-symbol value)The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
set-selection-range!cljs
(set-selection-range! document-symbol value)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 {@linkcode DocumentSymbol.range 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 {@linkcode DocumentSymbol.range range}.set-tags!cljs
(set-tags! document-symbol value)Tags for this symbol.
Tags for this symbol.
tagscljs
(tags document-symbol)Tags for this symbol.
Returns: readonly SymbolTag[] | undefined
Tags for this symbol. **Returns:** `readonly SymbolTag[] | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close