clang-tools
7.0.0
|
Optional symbol details that are not required to be set. More...
#include <Index.h>
Public Attributes | |
llvm::StringRef | Documentation |
Documentation including comment for the symbol declaration. More... | |
llvm::StringRef | ReturnType |
Type when this symbol is used in an expression. More... | |
llvm::StringRef | IncludeHeader |
This can be either a URI of the header to be #include'd for this symbol, or a literal header quoted with <> or "" that is suitable to be included directly. More... | |
Optional symbol details that are not required to be set.
For example, an index fuzzy match can return a large number of symbol candidates, and it is preferable to send only core symbol information in the batched results and have clients resolve full symbol information for a specific candidate if needed.
llvm::StringRef clang::clangd::Symbol::Details::Documentation |
Documentation including comment for the symbol declaration.
Definition at line 208 of file Index.h.
Referenced by clang::clangd::SymbolCollector::finish(), llvm::yaml::MappingTraits< Symbol::Details >::mapping(), and clang::clangd::mergeSymbol().
llvm::StringRef clang::clangd::Symbol::Details::IncludeHeader |
This can be either a URI of the header to be #include'd for this symbol, or a literal header quoted with <> or "" that is suitable to be included directly.
When this is a URI, the exact #include path needs to be calculated according to the URI scheme.
This is a canonical include for the symbol and can be different from FileURI in the CanonicalDeclaration.
Definition at line 219 of file Index.h.
Referenced by clang::clangd::SymbolCollector::finish(), llvm::yaml::MappingTraits< Symbol::Details >::mapping(), and clang::clangd::mergeSymbol().
llvm::StringRef clang::clangd::Symbol::Details::ReturnType |
Type when this symbol is used in an expression.
(Short display form). e.g. return type of a function, or type of a variable.
Definition at line 211 of file Index.h.
Referenced by clang::clangd::SymbolCollector::finish(), llvm::yaml::MappingTraits< Symbol::Details >::mapping(), and clang::clangd::mergeSymbol().