docs: update XML comments for Essentials Core

src/PepperDash.Essentials.Core/PartitionSensor/EssentialsPartitionController.cs

@@ -14,10 +14,16 @@ namespace PepperDash.Essentials.Core
     {
         private IPartitionStateProvider _partitionSensor;
 
+        /// <summary>
+        /// Indicates whether the controller is in Auto mode or Manual mode
+        /// </summary>
         public bool IsInAutoMode { get; private set; }
 
         private bool _partitionPresent;
 
+        /// <summary>
+        /// Gets or sets the PartitionPresent state
+        /// </summary>
         public bool PartitionPresent
         {
             get
@@ -45,6 +51,14 @@ namespace PepperDash.Essentials.Core
             }
         }
 
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="key">key for the partition controller</param>
+        /// <param name="name">name of the partition controller</param>
+        /// <param name="sensor">partition state provider sensor</param>
+        /// <param name="defaultToManualMode">whether to default to manual mode</param>
+        /// <param name="adjacentRoomKeys">list of adjacent room keys</param>
         public EssentialsPartitionController(string key, string name, IPartitionStateProvider sensor, bool defaultToManualMode, List<string> adjacentRoomKeys)
         {
             Key = key;

src/PepperDash.Essentials.Core/PartitionSensor/IPartitionStateProvider.cs

@@ -9,9 +9,15 @@ namespace PepperDash.Essentials.Core
     /// </summary>
     public interface IPartitionStateProvider : IKeyName
     {
+        /// <summary>
+        /// Feedback indicating whether the partition is present
+        /// </summary>
         [JsonIgnore]
         BoolFeedback PartitionPresentFeedback { get; }
 
+        /// <summary>
+        /// Indicates whether the partition is present
+        /// </summary>
         [JsonProperty("partitionPresent")]
         bool PartitionPresent { get; }
     }
@@ -21,20 +27,41 @@ namespace PepperDash.Essentials.Core
     /// </summary>
     public interface IPartitionController : IPartitionStateProvider
     {
+        /// <summary>
+        /// List of adjacent room keys
+        /// </summary>
         [JsonProperty("adjacentRoomKeys")]
         List<string> AdjacentRoomKeys { get; }
 
+        /// <summary>
+        /// Indicates whether the controller is in Auto mode or Manual mode
+        /// </summary>
         [JsonProperty("isInAutoMode")]
         bool IsInAutoMode { get; }
 
+        /// <summary>
+        /// Sets the PartitionPresent state
+        /// </summary>
         void SetPartitionStatePresent();
 
+        /// <summary>
+        /// Sets the PartitionPresent state to not present
+        /// </summary>
         void SetPartitionStateNotPresent();
 
+        /// <summary>
+        /// Toggles the PartitionPresent state
+        /// </summary>
         void ToggglePartitionState();
 
+        /// <summary>
+        /// Sets the controller to Manual mode
+        /// </summary>
         void SetManualMode();
 
+        /// <summary>
+        /// Sets the controller to Auto mode
+        /// </summary>
         void SetAutoMode();
     }
 }