Inlay hint information. More...

#include <Protocol.h>

Public Member Functions
std::string	joinLabels () const
	Join the label[].value together.

Public Attributes
Position	position
	The position of this hint.

std::vector< InlayHintLabelPart >	label
	The label of this hint.

InlayHintKind	kind
	The kind of this hint.

bool	paddingLeft = false
	Render padding before the hint.

bool	paddingRight = false
	Render padding after the hint.

Range	range
	The range of source code to which the hint applies.

Detailed Description

Inlay hint information.

Definition at line 1735 of file Protocol.h.

Member Function Documentation

◆ joinLabels()

std::string clang::clangd::InlayHint::joinLabels ( ) const

Join the label[].value together.

Definition at line 1504 of file Protocol.cpp.

References label.

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

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 1747 of file Protocol.h.

◆ label

std::vector<InlayHintLabelPart> 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 1743 of file Protocol.h.

Referenced by joinLabels().

◆ 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 1754 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 1761 of file Protocol.h.

◆ position

Position clang::clangd::InlayHint::position

The position of this hint.

Definition at line 1737 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 1768 of file Protocol.h.