From cbe96dbed98f09c9b7ee8efaae37410b3b9ed949 Mon Sep 17 00:00:00 2001
From: Andrew Welker <andrew.welker@gmail.com>
Date: Wed, 25 Mar 2020 14:33:49 -0600
Subject: [PATCH] Adds XML comments to constructors for Int, String, and Bool
 Feedbacks

---
 .../Feedbacks/BoolFeedback.cs                  | 18 +++++++++++++++++-
 .../Feedbacks/IntFeedback.cs                   | 17 +++++++++++++++++
 .../Feedbacks/StringFeedback.cs                |  3 ++-
 3 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs
index 60a09df8..4e8016a7 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs	
@@ -34,18 +34,34 @@ namespace PepperDash.Essentials.Core
 
         List<Crestron.SimplSharpPro.DeviceSupport.Feedback> LinkedCrestronFeedbacks = new List<Crestron.SimplSharpPro.DeviceSupport.Feedback>();
 
+        /// <summary>
+        /// Creates the feedback with the Func as described.
+        /// </summary>
+        /// <remarks>
+        /// While the 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 <seealso cref="FireUpdate"/> has been called
+        /// </remarks>
+        /// <param name="valueFunc">Delegate to invoke when this feedback needs to be updated</param>
         public BoolFeedback(Func<bool> valueFunc)
             : this(null, valueFunc)
         {
         }
 
+        /// <summary>
+        /// Creates the feedback with the Func as described.
+        /// </summary>
+        /// <remarks>
+        /// While the 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 <seealso cref="FireUpdate"/> has been called
+        /// </remarks>
+        /// <param name="key">Key to find this Feedback</param>
+        /// <param name="valueFunc">Delegate to invoke when this feedback needs to be updated</param>
         public BoolFeedback(string key, Func<bool> valueFunc)
             : base(key)
         {
             ValueFunc = valueFunc;
         }
 
-
         public override void FireUpdate()
         {
             bool newValue = InTestMode ? TestValue : ValueFunc.Invoke();
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/IntFeedback.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/IntFeedback.cs
index 4a278148..25390c2c 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/IntFeedback.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/IntFeedback.cs	
@@ -23,11 +23,28 @@ namespace PepperDash.Essentials.Core
         Func<int> ValueFunc;
         List<UShortInputSig> LinkedInputSigs = new List<UShortInputSig>();
 
+        /// <summary>
+        /// Creates the feedback with the Func as described.
+        /// </summary>
+        /// <remarks>
+        /// 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 <seealso cref="FireUpdate"/> has been called
+        /// </remarks>
+        /// <param name="valueFunc">Delegate to invoke when this feedback needs to be updated</param>
         public IntFeedback(Func<int> valueFunc)
             : this(null, valueFunc)
         {
         }
 
+        /// <summary>
+        /// Creates the feedback with the Func as described.
+        /// </summary>
+        /// <remarks>
+        /// 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 <seealso cref="FireUpdate"/> has been called
+        /// </remarks>
+        /// <param name="key">Key to find this Feedback</param>
+        /// <param name="valueFunc">Delegate to invoke when this feedback needs to be updated</param>
         public IntFeedback(string key, Func<int> valueFunc)
             : base(key)
         {
diff --git a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs
index b02c02f0..ceadcace 100644
--- a/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs	
+++ b/essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs	
@@ -7,6 +7,7 @@ using Crestron.SimplSharpPro;
 
 namespace PepperDash.Essentials.Core
 {
+
     public class StringFeedback : Feedback
     {
         public override string StringValue { get { return _StringValue; } } // ValueFunc.Invoke(); } }
@@ -18,7 +19,7 @@ namespace PepperDash.Essentials.Core
         public string TestValue { get; private set; }
 
         /// <summary>
-        /// Evalutated on FireUpdate
+        /// Evaluated on FireUpdate
         /// </summary>
         public Func<string> ValueFunc { get; private set; }
         List<StringInputSig> LinkedInputSigs = new List<StringInputSig>();