From 534110cfbfc239554a7ce5623ed58893c2d77c25 Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Wed, 25 Mar 2020 14:43:06 -0600 Subject: [PATCH] updates XML comments for bool & string feedbacks --- .../Feedbacks/BoolFeedback.cs | 4 ++-- .../Feedbacks/StringFeedback.cs | 17 +++++++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs index 4e8016a7..f46b4767 100644 --- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs +++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs @@ -38,7 +38,7 @@ namespace PepperDash.Essentials.Core /// Creates the feedback with the Func as described. /// /// - /// While the sig value will be updated with the current value stored when it is linked to a EISC Bridge, + /// While the linked sig value will be updated with the current value stored when it is linked to a EISC Bridge, /// it will NOT reflect an actual value from a device until has been called /// /// Delegate to invoke when this feedback needs to be updated @@ -51,7 +51,7 @@ namespace PepperDash.Essentials.Core /// Creates the feedback with the Func as described. /// /// - /// While the sig value will be updated with the current value stored when it is linked to a EISC Bridge, + /// While the linked sig value will be updated with the current value stored when it is linked to a EISC Bridge, /// it will NOT reflect an actual value from a device until has been called /// /// Key to find this Feedback diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs index ceadcace..56251a2e 100644 --- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs +++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs @@ -24,11 +24,28 @@ namespace PepperDash.Essentials.Core public Func ValueFunc { get; private set; } List LinkedInputSigs = new List(); + /// + /// Creates the feedback with the Func as described. + /// + /// + /// While the linked sig value will be updated with the current value stored when it is linked to a EISC Bridge, + /// it will NOT reflect an actual value from a device until has been called + /// + /// Delegate to invoke when this feedback needs to be updated public StringFeedback(Func valueFunc) : this(null, valueFunc) { } + /// + /// Creates the feedback with the Func as described. + /// + /// + /// While the linked sig value will be updated with the current value stored when it is linked to a EISC Bridge, + /// it will NOT reflect an actual value from a device until has been called + /// + /// Key to find this Feedback + /// Delegate to invoke when this feedback needs to be updated public StringFeedback(string key, Func valueFunc) : base(key) {