clang-tools  14.0.0git
Public Attributes | List of all members
clang::clangd::InlayHint Struct Reference

An annotation to be displayed inline next to a range of source code. More...

#include <Protocol.h>

Collaboration diagram for clang::clangd::InlayHint:
Collaboration graph
[legend]

Public Attributes

Range range
 The range of source code to which the hint applies. More...
 
InlayHintKind kind
 The type of hint. More...
 
std::string label
 The label that is displayed in the editor. More...
 

Detailed Description

An annotation to be displayed inline next to a range of source code.

Definition at line 1535 of file Protocol.h.

Member Data Documentation

◆ kind

InlayHintKind clang::clangd::InlayHint::kind

The type of hint.

Definition at line 1545 of file Protocol.h.

◆ label

std::string clang::clangd::InlayHint::label

The label that is displayed in the editor.

Definition at line 1548 of file Protocol.h.

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

◆ range

Range clang::clangd::InlayHint::range

The range of source code to which the hint applies.

We provide the entire range, rather than just the endpoint relevant to position (e.g. the start of the range for InlayHintPosition::Before), to give clients the flexibility to make choices like only displaying the hint while the cursor is over the range, rather than displaying it all the time.

Definition at line 1542 of file Protocol.h.


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