docs: XML comments for Devices.Common

This commit is contained in:
Andrew Welker
2025-10-09 13:18:36 -05:00
parent a5d409e93a
commit f9d9df9d5c
115 changed files with 5772 additions and 4292 deletions

View File

@@ -1,10 +1,18 @@
using PepperDash.Essentials.Core.Shades;
using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core.Shades;
namespace PepperDash.Essentials.Devices.Common.Shades
{
/// <summary>
/// Base class for shade devices
/// </summary>
public abstract class ShadeBase : EssentialsDevice, IShadesOpenCloseStop
{
/// <summary>
/// Initializes a new instance of the ShadeBase class
/// </summary>
/// <param name="key">The device key</param>
/// <param name="name">The device name</param>
public ShadeBase(string key, string name)
: base(key, name)
{
@@ -13,8 +21,17 @@ namespace PepperDash.Essentials.Devices.Common.Shades
#region iShadesOpenClose Members
/// <summary>
/// Opens the shade
/// </summary>
public abstract void Open();
/// <summary>
/// Stops the shade
/// </summary>
public abstract void Stop();
/// <summary>
/// Closes the shade
/// </summary>
public abstract void Close();
#endregion