LLVM: llvm::lsp::DocumentSymbol Struct Reference (original) (raw)

Represents programming constructs like variables, classes, interfaces etc. More...

#include "[llvm/Support/LSP/Protocol.h](Protocol%5F8h%5Fsource.html)"

Public Attributes
std::string name
The name of this symbol.
std::string detail
More detail for this symbol, e.g the signature of a function.
SymbolKind kind
The kind of this symbol.
Range range
The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
Range selectionRange
The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
std::vector< DocumentSymbol > children
Children of this symbol, e.g. properties of a class.

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.

Definition at line 616 of file Protocol.h.

llvm::lsp::DocumentSymbol::DocumentSymbol ( ) default

Referenced by DocumentSymbol().

DocumentSymbol() [2/3]

llvm::lsp::DocumentSymbol::DocumentSymbol ( DocumentSymbol && ) default

References DocumentSymbol().

DocumentSymbol() [3/3]

children

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

Definition at line 644 of file Protocol.h.

detail

std::string llvm::lsp::DocumentSymbol::detail

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

Definition at line 628 of file Protocol.h.

kind

name

std::string llvm::lsp::DocumentSymbol::name

range

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

Definition at line 637 of file Protocol.h.

Referenced by DocumentSymbol().

selectionRange

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

Definition at line 641 of file Protocol.h.

Referenced by DocumentSymbol().


The documentation for this struct was generated from the following file: