clang-tools
9.0.0
|
Contains detailed information about a Symbol. More...
#include <XRefs.h>
Classes | |
struct | Param |
Represents parameters of a function, a template or a macro. More... | |
Public Member Functions | |
FormattedString | present () const |
Produce a user-readable information. More... | |
Public Attributes | |
llvm::Optional< std::string > | NamespaceScope |
For a variable named Bar, declared in clang::clangd::Foo::getFoo the following fields will hold: More... | |
std::string | LocalScope |
Remaining named contexts in symbol's qualified name, empty string means symbol is not local. More... | |
std::string | Name |
Name of the symbol, does not contain any "::". More... | |
llvm::Optional< Range > | SymRange |
SymbolKind | Kind |
Scope containing the symbol. More... | |
std::string | Documentation |
std::string | Definition |
Source code containing the definition of the symbol. More... | |
llvm::Optional< std::string > | Type |
Pretty-printed variable type. More... | |
llvm::Optional< std::string > | ReturnType |
Set for functions and lambadas. More... | |
llvm::Optional< std::vector< Param > > | Parameters |
Set for functions, lambdas and macros with parameters. More... | |
llvm::Optional< std::vector< Param > > | TemplateParameters |
Set for all templates(function, class, variable). More... | |
llvm::Optional< std::string > | Value |
Contains the evaluated value of the symbol if available. More... | |
Contains detailed information about a Symbol.
Especially useful when generating hover responses. It can be rendered as a hover panel, or embedding clients can use the structured information to provide their own UI.
FormattedString clang::clangd::HoverInfo::present | ( | ) | const |
Produce a user-readable information.
Definition at line 1274 of file XRefs.cpp.
References clang::clangd::FormattedString::appendCodeBlock(), clang::clangd::FormattedString::appendInlineCode(), clang::clangd::FormattedString::appendText(), clang::clangd::Definition, and Name.
std::string clang::clangd::HoverInfo::Definition |
std::string clang::clangd::HoverInfo::Documentation |
Definition at line 93 of file XRefs.h.
Referenced by clang::clangd::enhanceFromIndex(), and clang::clangd::getHoverContents().
SymbolKind clang::clangd::HoverInfo::Kind |
Scope containing the symbol.
e.g, "global namespace", "function x::Y"
Definition at line 92 of file XRefs.h.
Referenced by clang::clangd::getHoverContents().
std::string clang::clangd::HoverInfo::LocalScope |
Remaining named contexts in symbol's qualified name, empty string means symbol is not local.
Definition at line 86 of file XRefs.h.
Referenced by clang::clangd::getHoverContents().
std::string clang::clangd::HoverInfo::Name |
Name of the symbol, does not contain any "::".
Definition at line 88 of file XRefs.h.
Referenced by clang::clangd::getHoverContents().
llvm::Optional<std::string> clang::clangd::HoverInfo::NamespaceScope |
For a variable named Bar, declared in clang::clangd::Foo::getFoo the following fields will hold:
Definition at line 83 of file XRefs.h.
Referenced by clang::clangd::getHoverContents().
llvm::Optional<std::vector<Param> > clang::clangd::HoverInfo::Parameters |
llvm::Optional<std::string> clang::clangd::HoverInfo::ReturnType |
Set for functions and lambadas.
Definition at line 101 of file XRefs.h.
Referenced by clang::clangd::getHoverContents().
llvm::Optional<std::vector<Param> > clang::clangd::HoverInfo::TemplateParameters |
Set for all templates(function, class, variable).
Definition at line 105 of file XRefs.h.
Referenced by clang::clangd::getHoverContents().
llvm::Optional<std::string> clang::clangd::HoverInfo::Type |
llvm::Optional<std::string> clang::clangd::HoverInfo::Value |