clang-tools 22.0.0git
clang::clangd::HoverInfo::Param Struct Reference

Represents parameters of a function, a template or a macro. More...

#include <Hover.h>

Public Attributes

std::optional< PrintedTypeType
 The printable parameter type, e.g.
std::optional< std::string > Name
 std::nullopt for unnamed parameters.
std::optional< std::string > Default
 std::nullopt if no default is provided.

Detailed Description

Represents parameters of a function, a template or a macro.

For example:

  • void foo(ParamType Name = DefaultValue)
  • #define FOO(Name)
  • template <ParamType Name = DefaultType>> class Foo {};

Definition at line 46 of file Hover.h.

Member Data Documentation

◆ Default

std::optional<std::string> clang::clangd::HoverInfo::Param::Default

std::nullopt if no default is provided.

Definition at line 53 of file Hover.h.

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

◆ Name

std::optional<std::string> clang::clangd::HoverInfo::Param::Name

std::nullopt for unnamed parameters.

Definition at line 51 of file Hover.h.

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

◆ Type

std::optional<PrintedType> clang::clangd::HoverInfo::Param::Type

The printable parameter type, e.g.

"int", or "typename" (in TemplateParameters), might be std::nullopt for macro parameters.

Definition at line 49 of file Hover.h.

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


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