Class SignatureParameter
- Namespace
- RDCore.SDK.Model.Symbols.Completion
- Assembly
- RDCore.SDK.dll
A parameter of a SignatureDescription: where it is written in the signature's label, and what it is.
public sealed record SignatureParameter : IEquatable<SignatureParameter>
- Inheritance
-
SignatureParameter
- Implements
- Inherited Members
Constructors
SignatureParameter(string, int, int, bool, string?)
A parameter of a SignatureDescription: where it is written in the signature's label, and what it is.
public SignatureParameter(string Name, int Start, int End, bool IsParamArray = false, string? Documentation = null)
Parameters
NamestringThe name of the parameter.
StartintThe offset of the first character of the parameter in the label.
EndintThe offset of the character after the parameter in the label.
IsParamArrayboolWhether it is a
ParamArray, which takes every argument from where it is on.DocumentationstringWhat the parameter is, in a sentence: its doc string; null when it has none.
Properties
Documentation
What the parameter is, in a sentence: its doc string; null when it has none.
public string? Documentation { get; init; }
Property Value
End
The offset of the character after the parameter in the label.
public int End { get; init; }
Property Value
IsParamArray
Whether it is a ParamArray, which takes every argument from where it is on.
public bool IsParamArray { get; init; }
Property Value
Name
The name of the parameter.
public string Name { get; init; }
Property Value
Start
The offset of the first character of the parameter in the label.
public int Start { get; init; }