docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions

View File

@@ -22,6 +22,9 @@ namespace PepperDash.Essentials.Devices.Common.Shades
int RelayPulseTime;
/// <summary>
/// Gets or sets the StopOrPresetButtonLabel
/// </summary>
public string StopOrPresetButtonLabel { get; set; }
public RelayControlledShade(string key, string name, RelayControlledShadeConfigProperties config)
@@ -35,6 +38,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
}
/// <summary>
/// CustomActivate method
/// </summary>
/// <inheritdoc />
public override bool CustomActivate()
{
//Create ISwitchedOutput objects based on props
@@ -46,6 +53,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
return base.CustomActivate();
}
/// <summary>
/// Open method
/// </summary>
/// <inheritdoc />
public override void Open()
{
Debug.LogMessage(LogEventLevel.Debug, this, "Opening Shade: '{0}'", this.Name);
@@ -53,6 +64,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
PulseOutput(OpenRelay, RelayPulseTime);
}
/// <summary>
/// Stop method
/// </summary>
/// <inheritdoc />
public override void Stop()
{
Debug.LogMessage(LogEventLevel.Debug, this, "Stopping Shade: '{0}'", this.Name);
@@ -60,6 +75,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
PulseOutput(StopOrPresetRelay, RelayPulseTime);
}
/// <summary>
/// Close method
/// </summary>
/// <inheritdoc />
public override void Close()
{
Debug.LogMessage(LogEventLevel.Debug, this, "Closing Shade: '{0}'", this.Name);
@@ -95,20 +114,47 @@ namespace PepperDash.Essentials.Devices.Common.Shades
}
/// <summary>
/// Represents a RelayControlledShadeConfigProperties
/// </summary>
public class RelayControlledShadeConfigProperties
{
/// <summary>
/// Gets or sets the RelayPulseTime
/// </summary>
public int RelayPulseTime { get; set; }
/// <summary>
/// Gets or sets the Relays
/// </summary>
public ShadeRelaysConfig Relays { get; set; }
/// <summary>
/// Gets or sets the StopOrPresetLabel
/// </summary>
public string StopOrPresetLabel { get; set; }
/// <summary>
/// Represents a ShadeRelaysConfig
/// </summary>
public class ShadeRelaysConfig
{
/// <summary>
/// Gets or sets the Open
/// </summary>
public IOPortConfig Open { get; set; }
/// <summary>
/// Gets or sets the StopOrPreset
/// </summary>
public IOPortConfig StopOrPreset { get; set; }
/// <summary>
/// Gets or sets the Close
/// </summary>
public IOPortConfig Close { get; set; }
}
}
/// <summary>
/// Represents a RelayControlledShadeFactory
/// </summary>
public class RelayControlledShadeFactory : EssentialsDeviceFactory<RelayControlledShade>
{
public RelayControlledShadeFactory()
@@ -116,6 +162,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
TypeNames = new List<string>() { "relaycontrolledshade" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Comm Device");

View File

@@ -24,6 +24,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
Shades = new List<IShadesOpenCloseStop>();
}
/// <summary>
/// CustomActivate method
/// </summary>
/// <inheritdoc />
public override bool CustomActivate()
{
foreach (var shadeConfig in Config.Shades)
@@ -44,17 +48,32 @@ namespace PepperDash.Essentials.Devices.Common.Shades
}
}
/// <summary>
/// Represents a ShadeControllerConfigProperties
/// </summary>
public class ShadeControllerConfigProperties
{
/// <summary>
/// Gets or sets the Shades
/// </summary>
public List<ShadeConfig> Shades { get; set; }
/// <summary>
/// Represents a ShadeConfig
/// </summary>
public class ShadeConfig
{
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; set; }
}
}
/// <summary>
/// Represents a ShadeControllerFactory
/// </summary>
public class ShadeControllerFactory : EssentialsDeviceFactory<ShadeController>
{
public ShadeControllerFactory()
@@ -62,6 +81,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
TypeNames = new List<string>() { "shadecontroller" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new ShadeController Device");