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

@@ -4,7 +4,7 @@ using System.Collections.Generic;
namespace PepperDash.Essentials.Core.Lighting
{
/// <summary>
/// Requirements for a device that implements lighting scene control
/// Defines the contract for ILightingScenes
/// </summary>
public interface ILightingScenes
{
@@ -18,13 +18,16 @@ namespace PepperDash.Essentials.Core.Lighting
}
/// <summary>
/// Defines the contract for ILightingScenesDynamic
/// </summary>
public interface ILightingScenesDynamic : ILightingScenes
{
event EventHandler LightingScenesUpdated;
}
/// <summary>
/// Requirements for a device that implements master raise/lower
/// Defines the contract for ILightingMasterRaiseLower
/// </summary>
public interface ILightingMasterRaiseLower
{
@@ -34,7 +37,7 @@ namespace PepperDash.Essentials.Core.Lighting
}
/// <summary>
/// Requiremnts for controlling a lighting load
/// Defines the contract for ILightingLoad
/// </summary>
public interface ILightingLoad
{
@@ -46,8 +49,14 @@ namespace PepperDash.Essentials.Core.Lighting
BoolFeedback LoadIsOnFeedback { get; }
}
/// <summary>
/// Represents a LightingSceneChangeEventArgs
/// </summary>
public class LightingSceneChangeEventArgs : EventArgs
{
/// <summary>
/// Gets or sets the CurrentLightingScene
/// </summary>
public LightingScene CurrentLightingScene { get; private set; }
public LightingSceneChangeEventArgs(LightingScene scene)

View File

@@ -5,11 +5,20 @@ using Newtonsoft.Json;
namespace PepperDash.Essentials.Core.Lighting
{
/// <summary>
/// Represents a LightingScene
/// </summary>
public class LightingScene
{
[JsonProperty("name", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; }
[JsonProperty("id", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
bool _IsActive;
[JsonProperty("isActive", NullValueHandling = NullValueHandling.Ignore)]
@@ -27,9 +36,15 @@ namespace PepperDash.Essentials.Core.Lighting
}
[JsonProperty("sortOrder", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the SortOrder
/// </summary>
public int SortOrder { get; set; }
[JsonIgnore]
/// <summary>
/// Gets or sets the IsActiveFeedback
/// </summary>
public BoolFeedback IsActiveFeedback { get; set; }
public LightingScene()