mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-04-14 21:16:48 +00:00
docs: update XML comments for Essentials Core
This commit is contained in:
parent
0764685c51
commit
f88bb13367
260 changed files with 7018 additions and 1318 deletions
|
|
@ -15,10 +15,29 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public class ActionIncrementer
|
||||
{
|
||||
/// <summary>
|
||||
/// The amount to change the value by each increment
|
||||
/// </summary>
|
||||
public int ChangeAmount { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The maximum value for the incrementer
|
||||
/// </summary>
|
||||
public int MaxValue { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The minimum value for the incrementer
|
||||
/// </summary>
|
||||
public int MinValue { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The delay before repeating starts
|
||||
/// </summary>
|
||||
public uint RepeatDelay { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The time between repeats
|
||||
/// </summary>
|
||||
public uint RepeatTime { get; set; }
|
||||
|
||||
Action<int> SetAction;
|
||||
|
|
|
|||
|
|
@ -16,14 +16,44 @@ namespace PepperDash.Essentials.Core
|
|||
public class UshortSigIncrementer
|
||||
{
|
||||
UShortInputSig TheSig;
|
||||
|
||||
/// <summary>
|
||||
/// The amount to change the value by each increment
|
||||
/// </summary>
|
||||
public ushort ChangeAmount { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The maximum value for the incrementer
|
||||
/// </summary>
|
||||
public int MaxValue { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The minimum value for the incrementer
|
||||
/// </summary>
|
||||
public int MinValue { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The delay before repeating starts
|
||||
/// </summary>
|
||||
public uint RepeatDelay { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The time between repeats
|
||||
/// </summary>
|
||||
public uint RepeatTime { get; set; }
|
||||
|
||||
bool SignedMode;
|
||||
CTimer Timer;
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="sig">the signal toi be incremented</param>
|
||||
/// <param name="changeAmount">the amount to increment by</param>
|
||||
/// <param name="minValue">the minimum value of the signal</param>
|
||||
/// <param name="maxValue">the maximum value of the signal</param>
|
||||
/// <param name="repeatDelay">the delay before repeating starts</param>
|
||||
/// <param name="repeatTime">the time between repeats</param>
|
||||
public UshortSigIncrementer(UShortInputSig sig, ushort changeAmount, int minValue, int maxValue, uint repeatDelay, uint repeatTime)
|
||||
{
|
||||
TheSig = sig;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue