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

Adds XML comments to constructors for Int, String, and Bool Feedbacks

Browse source
This commit is contained in:
Andrew Welker 2020-03-25 14:33:49 -06:00
parent e2fe8834c5
commit cbe96dbed9
3 changed files with 36 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -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)
{