clang::clangd::SymbolQualitySignals Struct Reference

Attributes of a symbol that affect how much we like it. More...

#include <Quality.h>

Public Types
enum	SymbolCategory {   Unknown = 0 , Variable , Macro , Type ,   Function , Constructor , Destructor , Namespace ,   Keyword , Operator }

Public Member Functions
void	merge (const CodeCompletionResult &SemaCCResult)
void	merge (const Symbol &IndexResult)
float	evaluateHeuristics () const

Public Attributes
bool	Deprecated = false
bool	ReservedName = false
bool	ImplementationDetail = false
unsigned	References = 0
enum clang::clangd::SymbolQualitySignals::SymbolCategory	Category = Unknown

Detailed Description

Attributes of a symbol that affect how much we like it.

Definition at line 56 of file Quality.h.

Member Enumeration Documentation

SymbolCategory

enum clang::clangd::SymbolQualitySignals::SymbolCategory

Enumerator
Unknown
Variable
Macro
Type
Function
Constructor
Destructor
Namespace
Keyword
Operator

Definition at line 63 of file Quality.h.

Member Function Documentation

evaluateHeuristics()

float clang::clangd::SymbolQualitySignals::evaluateHeuristics

(

)

const

Definition at line 199 of file Quality.cpp.

References Category, Constructor, Deprecated, Destructor, Function, ImplementationDetail, Keyword, Macro, Namespace, Operator, References, ReservedName, Type, Unknown, and Variable.

Referenced by clang::clangd::locateSymbolTextually(), and clang::clangd::operator<<().

merge() [1/2]

void clang::clangd::SymbolQualitySignals::merge

(

const CodeCompletionResult &

SemaCCResult

)

Definition at line 178 of file Quality.cpp.

References clang::clangd::categorize(), Category, Deprecated, ImplementationDetail, clang::clangd::isImplementationDetail(), clang::clangd::isReservedName(), and ReservedName.

Referenced by clang::clangd::getWorkspaceSymbols(), and clang::clangd::locateSymbolTextually().

merge() [2/2]

void clang::clangd::SymbolQualitySignals::merge

(

const Symbol &

IndexResult

)

Definition at line 191 of file Quality.cpp.

References clang::clangd::categorize(), Category, clang::clangd::Symbol::Deprecated, Deprecated, clang::clangd::Symbol::Flags, clang::clangd::Symbol::ImplementationDetail, ImplementationDetail, clang::clangd::isReservedName(), clang::clangd::Symbol::Name, clang::clangd::Symbol::References, References, ReservedName, and clang::clangd::Symbol::SymInfo.

Member Data Documentation

Category

enum clang::clangd::SymbolQualitySignals::SymbolCategory clang::clangd::SymbolQualitySignals::Category = Unknown

Referenced by evaluateHeuristics(), merge(), merge(), and clang::clangd::operator<<().

Deprecated

bool clang::clangd::SymbolQualitySignals::Deprecated = false

Definition at line 57 of file Quality.h.

Referenced by evaluateHeuristics(), merge(), merge(), and clang::clangd::operator<<().

ImplementationDetail

bool clang::clangd::SymbolQualitySignals::ImplementationDetail = false

Definition at line 60 of file Quality.h.

Referenced by evaluateHeuristics(), merge(), merge(), and clang::clangd::operator<<().

References

unsigned clang::clangd::SymbolQualitySignals::References = 0

Definition at line 61 of file Quality.h.

Referenced by evaluateHeuristics(), merge(), and clang::clangd::operator<<().

ReservedName

bool clang::clangd::SymbolQualitySignals::ReservedName = false

Definition at line 58 of file Quality.h.

Referenced by evaluateHeuristics(), merge(), merge(), and clang::clangd::operator<<().

---

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

• Quality.h
• Quality.cpp