clang-tools  11.0.0
Public Attributes | List of all members
clang::clangd::Diagnostic Struct Reference

#include <Protocol.h>

Collaboration diagram for clang::clangd::Diagnostic:
[legend]

Public Attributes

Range range
 The range at which the message applies. More...
 
int severity = 0
 The diagnostic's severity. More...
 
std::string code
 The diagnostic's code. Can be omitted. More...
 
std::string source
 A human-readable string describing the source of this diagnostic, e.g. More...
 
std::string message
 The diagnostic's message. More...
 
llvm::Optional< std::vector< DiagnosticRelatedInformation > > relatedInformation
 An array of related diagnostic information, e.g. More...
 
llvm::Optional< std::string > category
 The diagnostic's category. More...
 
llvm::Optional< std::vector< CodeAction > > codeActions
 Clangd extension: code actions related to this diagnostic. More...
 

Detailed Description

Definition at line 784 of file Protocol.h.

Member Data Documentation

◆ category

llvm::Optional<std::string> clang::clangd::Diagnostic::category

The diagnostic's category.

Can be omitted. An LSP extension that's used to send the name of the category over to the client. The category typically describes the compilation stage during which the issue was produced, e.g. "Semantic Issue" or "Parse Issue".

Definition at line 810 of file Protocol.h.

◆ code

std::string clang::clangd::Diagnostic::code

The diagnostic's code. Can be omitted.

Definition at line 793 of file Protocol.h.

◆ codeActions

llvm::Optional<std::vector<CodeAction> > clang::clangd::Diagnostic::codeActions

Clangd extension: code actions related to this diagnostic.

Only with capability textDocument.publishDiagnostics.codeActionsInline. (These actions can also be obtained using textDocument/codeAction).

Definition at line 815 of file Protocol.h.

◆ message

std::string clang::clangd::Diagnostic::message

The diagnostic's message.

Definition at line 800 of file Protocol.h.

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

◆ range

Range clang::clangd::Diagnostic::range

The range at which the message applies.

Definition at line 786 of file Protocol.h.

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

◆ relatedInformation

llvm::Optional<std::vector<DiagnosticRelatedInformation> > clang::clangd::Diagnostic::relatedInformation

An array of related diagnostic information, e.g.

when symbol-names within a scope collide all definitions can be marked via this property.

Definition at line 804 of file Protocol.h.

◆ severity

int clang::clangd::Diagnostic::severity = 0

The diagnostic's severity.

Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

Definition at line 790 of file Protocol.h.

Referenced by clang::clangd::operator<<().

◆ source

std::string clang::clangd::Diagnostic::source

A human-readable string describing the source of this diagnostic, e.g.

'typescript' or 'super lint'.

Definition at line 797 of file Protocol.h.


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