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

updates XML comments for bool & string feedbacks

Browse source
This commit is contained in:
Andrew Welker 2020-03-25 14:43:06 -06:00
parent cbe96dbed9
commit 534110cfbf
2 changed files with 19 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/BoolFeedback.cs
View file

@ -38,7 +38,7 @@ namespace PepperDash.Essentials.Core
/// Creates the feedback with the Func as described. /// Creates the feedback with the Func as described.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// 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 <seealso cref="FireUpdate"/> has been called /// it will NOT reflect an actual value from a device until <seealso cref="FireUpdate"/> has been called
/// </remarks> /// </remarks>
/// <param name="valueFunc">Delegate to invoke when this feedback needs to be updated</param> /// <param name="valueFunc">Delegate to invoke when this feedback needs to be updated</param>
@ -51,7 +51,7 @@ namespace PepperDash.Essentials.Core
/// Creates the feedback with the Func as described. /// Creates the feedback with the Func as described.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// 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 <seealso cref="FireUpdate"/> has been called /// it will NOT reflect an actual value from a device until <seealso cref="FireUpdate"/> has been called
/// </remarks> /// </remarks>
/// <param name="key">Key to find this Feedback</param> /// <param name="key">Key to find this Feedback</param>

17
essentials-framework/Essentials Core/PepperDashEssentialsBase/Feedbacks/StringFeedback.cs
View file

@ -24,11 +24,28 @@ namespace PepperDash.Essentials.Core
public Func<string> ValueFunc { get; private set; } public Func<string> ValueFunc { get; private set; }
List<StringInputSig> LinkedInputSigs = new List<StringInputSig>(); List<StringInputSig> LinkedInputSigs = new List<StringInputSig>();
/// <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 StringFeedback(Func<string> valueFunc) public StringFeedback(Func<string> valueFunc)
: this(null, 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 StringFeedback(string key, Func<string> valueFunc) public StringFeedback(string key, Func<string> valueFunc)
: base(key) : base(key)
{ {