mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-08-31 19:08:29 +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
|
|
@ -30,6 +30,11 @@ namespace PepperDash.Essentials.Core.Utilities
|
|||
|
||||
private bool _allowActionsToExecute;
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <param name="config"></param>
|
||||
public ActionSequence(string key, DeviceConfig config)
|
||||
: base(key, config.Name)
|
||||
{
|
||||
|
|
@ -126,9 +131,15 @@ namespace PepperDash.Essentials.Core.Utilities
|
|||
/// </summary>
|
||||
public class ActionSequencePropertiesConfig
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the ActionSequence
|
||||
/// </summary>
|
||||
[JsonProperty("actionSequence")]
|
||||
public List<SequencedDeviceActionWrapper> ActionSequence { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
public ActionSequencePropertiesConfig()
|
||||
{
|
||||
ActionSequence = new List<SequencedDeviceActionWrapper>();
|
||||
|
|
@ -140,10 +151,10 @@ namespace PepperDash.Essentials.Core.Utilities
|
|||
/// </summary>
|
||||
public class SequencedDeviceActionWrapper : DeviceActionWrapper
|
||||
{
|
||||
[JsonProperty("delayMs")]
|
||||
/// <summary>
|
||||
/// Gets or sets the DelayMs
|
||||
/// </summary>
|
||||
[JsonProperty("delayMs")]
|
||||
public int DelayMs { get; set; }
|
||||
}
|
||||
|
||||
|
|
@ -152,11 +163,19 @@ namespace PepperDash.Essentials.Core.Utilities
|
|||
/// </summary>
|
||||
public class ActionSequenceFactory : EssentialsDeviceFactory<ActionSequence>
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
public ActionSequenceFactory()
|
||||
{
|
||||
TypeNames = new List<string>() { "actionsequence" };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// BuildDevice method
|
||||
/// </summary>
|
||||
/// <param name="dc">device config</param>
|
||||
/// <returns></returns>
|
||||
public override EssentialsDevice BuildDevice(DeviceConfig dc)
|
||||
{
|
||||
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new ActionSequence Device");
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue