Added XML Comments, Obsolete Message, and backer field

#214
This commit is contained in:
Trevor Payne
2020-05-22 14:56:50 -05:00
parent 608a9068b9
commit 2f1592bc62

View File

@@ -346,8 +346,10 @@ namespace PepperDash.Essentials.Core
/// <summary>
/// Metadata describing the join
/// </summary>
public class JoinMetadata
{
public class JoinMetadata
{
private string _description;
/// <summary>
/// Join number (based on join offset value)
/// </summary>
@@ -362,14 +364,17 @@ namespace PepperDash.Essentials.Core
public uint JoinSpan { get; set; }
/// <summary>
/// A label for the join to better describe it's usage
/// A label for the join to better describe its usage
/// </summary>
[Obsolete]
[Obsolete("Use Description instead")]
[JsonProperty("label")]
public string Label { get { return Description; } set { Description = value; } }
public string Label { get { return _description; } set { _description = value; } }
[JsonProperty("description")]
public string Description { get; set; }
/// <summary>
/// A description for the join to better describe its usage
/// </summary>
[JsonProperty("description")]
public string Description { get { return _description; } set { _description = value; } }
/// <summary>
/// Signal type(s)
/// </summary>