From 2f1592bc62ab4d8a44d19f0c109d7843ffd42da1 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Fri, 22 May 2020 14:56:50 -0500 Subject: [PATCH] Added XML Comments, Obsolete Message, and backer field #214 --- .../JoinMaps/JoinMapBase.cs | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs index 8d50596e..676299e5 100644 --- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs +++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs @@ -346,8 +346,10 @@ namespace PepperDash.Essentials.Core /// /// Metadata describing the join /// - public class JoinMetadata - { + public class JoinMetadata + { + private string _description; + /// /// Join number (based on join offset value) /// @@ -362,14 +364,17 @@ namespace PepperDash.Essentials.Core public uint JoinSpan { get; set; } /// - /// A label for the join to better describe it's usage + /// A label for the join to better describe its usage /// - [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; } + /// + /// A description for the join to better describe its usage + /// + [JsonProperty("description")] + public string Description { get { return _description; } set { _description = value; } } /// /// Signal type(s) ///