pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-15 04:34:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added XML Comments, Obsolete Message, and backer field

Browse Source 
#214
This commit is contained in:
Trevor Payne
2020-05-22 14:56:50 -05:00
parent 608a9068b9
commit 2f1592bc62
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs
View File

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