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

Inlay hint information. More...

#include <Protocol.h>

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

Public Attributes

Position position
 The position of this hint. More...
 
std::string label
 The label of this hint. More...
 
InlayHintKind kind
 The kind of this hint. More...
 
bool paddingLeft = false
 Render padding before the hint. More...
 
bool paddingRight = false
 Render padding after the hint. More...
 
Range range
 The range of source code to which the hint applies. More...
 

Detailed Description

Inlay hint information.

Definition at line 1570 of file Protocol.h.

Member Data Documentation

◆ kind

InlayHintKind clang::clangd::InlayHint::kind

The kind of this hint.

Can be omitted in which case the client should fall back to a reasonable default.

Definition at line 1582 of file Protocol.h.

◆ label

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

The label of this hint.

A human readable string or an array of InlayHintLabelPart label parts.

Note that neither the string nor the label part can be empty.

Definition at line 1578 of file Protocol.h.

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

◆ paddingLeft

bool clang::clangd::InlayHint::paddingLeft = false

Render padding before the hint.

Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

Definition at line 1589 of file Protocol.h.

◆ paddingRight

bool clang::clangd::InlayHint::paddingRight = false

Render padding after the hint.

Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

Definition at line 1596 of file Protocol.h.

◆ position

Position clang::clangd::InlayHint::position

The position of this hint.

Definition at line 1572 of file Protocol.h.

◆ range

Range clang::clangd::InlayHint::range

The range of source code to which the hint applies.

For example, a parameter hint may have the argument as its range. The range allows clients more flexibility of when/how to display the hint. This is an (unserialized) clangd extension.

Definition at line 1603 of file Protocol.h.

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


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