Class SymbolHover

Namespace

RDCore.SDK.Semantics.Refactoring

Assembly

RDCore.SDK.dll

What a hover over a name says of its symbol (LSP 3.17 §Hover Request): its declaration as code would write it, what declares it, and what it does when its doc string says so.

public sealed record SymbolHover : IEquatable<SymbolHover>

Inheritance

object

SymbolHover

Implements

IEquatable<SymbolHover>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SymbolHover(string, string?, string?)

What a hover over a name says of its symbol (LSP 3.17 §Hover Request): its declaration as code would write it, what declares it, and what it does when its doc string says so.

public SymbolHover(string Declaration, string? Container, string? Documentation)

Parameters

Declaration string

The declaration, on one line: Public Function GetTotal() As Long, Dim count As Long, Enum Colour.

Container string

What declares the symbol: its module, procedure, Enum or Type - Helpers, VBA.Strings; null for a module, which nothing declares.

Documentation string

What the symbol is or does, in a sentence: its doc string; null when it has none.

Properties

Container

What declares the symbol: its module, procedure, Enum or Type - Helpers, VBA.Strings; null for a module, which nothing declares.

public string? Container { get; init; }

Property Value

string

Declaration

The declaration, on one line: Public Function GetTotal() As Long, Dim count As Long, Enum Colour.

public string Declaration { get; init; }

Property Value

string

Documentation

What the symbol is or does, in a sentence: its doc string; null when it has none.

public string? Documentation { get; init; }

Property Value

string

Methods

Of(Symbol)

What a hover says of a symbol.

public static SymbolHover Of(Symbol symbol)

Parameters

symbol Symbol

The symbol.

Returns

SymbolHover

ToMarkdown(CultureInfo?)

The hover as Markdown: the declaration as a block of VBA, what declares it, and its doc string.

public string ToMarkdown(CultureInfo? culture = null)

Parameters

culture CultureInfo

The language of the reader; the current UI culture by default.

Returns

string

ToPlainText(CultureInfo?)

The hover as plain text, for a client that does not read Markdown.

public string ToPlainText(CultureInfo? culture = null)

Parameters

culture CultureInfo

The language of the reader; the current UI culture by default.

Returns

string