clang-tools 10.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 647 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 673 of file Protocol.h.

Referenced by clang::clangd::toLSPDiags().

## ◆ code

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

The diagnostic's code. Can be omitted.

Definition at line 656 of file Protocol.h.

Referenced by clang::clangd::toLSPDiags().

## ◆ 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 678 of file Protocol.h.

Referenced by clang::clangd::toLSPDiags().

## ◆ message

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

The diagnostic's message.

Definition at line 663 of file Protocol.h.

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

## ◆ range

Range clang::clangd::Diagnostic::range

The range at which the message applies.

Definition at line 649 of file Protocol.h.

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

## ◆ 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 667 of file Protocol.h.

Referenced by clang::clangd::toLSPDiags().

## ◆ 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 653 of file Protocol.h.

Referenced by clang::clangd::toLSPDiags().

## ◆ 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 660 of file Protocol.h.

Referenced by clang::clangd::toLSPDiags().

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

- Protocol.h