wip: update XML comments

2026-02-12 03:05:01 +00:00 · 2026-01-28 17:09:45 -05:00
parent fed60eba29
commit 1bbd4f15bf
22 changed files with 308 additions and 151 deletions
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs
@@ -4,16 +4,16 @@ using Newtonsoft.Json;
 namespace PepperDash.Essentials.Room.Config
 {

-    /// <summary>
-    /// Represents a EssentialsHuddleVtc1PropertiesConfig
-    /// </summary>
-    public class EssentialsHuddleVtc1PropertiesConfig : EssentialsConferenceRoomPropertiesConfig
-    {
-		[JsonProperty("defaultDisplayKey")]
  /// <summary>
-  /// Gets or sets the DefaultDisplayKey
+  /// Represents a EssentialsHuddleVtc1PropertiesConfig
  /// </summary>
-		public string DefaultDisplayKey { get; set; }
+  public class EssentialsHuddleVtc1PropertiesConfig : EssentialsConferenceRoomPropertiesConfig
+  {
+    /// <summary>
+    /// Gets or sets the DefaultDisplayKey
+    /// </summary>
+    [JsonProperty("defaultDisplayKey")]
+    public string DefaultDisplayKey { get; set; }

-    }
+  }
 }
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs
@@ -11,13 +11,27 @@ namespace PepperDash.Essentials.Room.Config
    /// </summary>
    public class EssentialsNDisplayRoomPropertiesConfig : EssentialsConferenceRoomPropertiesConfig
    {
+        /// <summary>
+        /// Gets or sets the DefaultAudioBehavior
+        /// </summary>
        [JsonProperty("defaultAudioBehavior")]
        public string DefaultAudioBehavior { get; set; }
+
+        /// <summary>
+        /// Gets or sets the DefaultVideoBehavior
+        /// </summary>
        [JsonProperty("defaultVideoBehavior")]
        public string DefaultVideoBehavior { get; set; }
+
+        /// <summary>
+        /// Gets or sets the Displays
+        /// </summary>
        [JsonProperty("displays")]
        public Dictionary<eSourceListItemDestinationTypes, DisplayItem> Displays { get; set; }

+        /// <summary>
+        /// Constructor
+        /// </summary>
        public EssentialsNDisplayRoomPropertiesConfig()
        {
            Displays = new Dictionary<eSourceListItemDestinationTypes, DisplayItem>();
@@ -34,6 +48,7 @@ namespace PepperDash.Essentials.Room.Config
        /// Gets or sets the Key
        /// </summary>
        public string Key { get; set; }
+        
        /// <summary>
        /// Gets or sets the Name
        /// </summary>
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs
@@ -11,15 +11,35 @@ namespace PepperDash.Essentials.Room.Config
        /// Gets or sets the DefaultAudioBehavior
        /// </summary>
        public string DefaultAudioBehavior { get; set; }
+
        /// <summary>
        /// Gets or sets the DefaultAudioKey
        /// </summary>
        public string DefaultAudioKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the DefaultVideoBehavior
+        /// </summary>
        public string DefaultVideoBehavior { get; set; }
+
+        /// <summary>
+        /// Gets or sets the DisplayKeys
+        /// </summary>
        public List<string> DisplayKeys { get; set; }
+
+        /// <summary>
+        /// Gets or sets the SourceListKey
+        /// </summary>
        public string SourceListKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the room has a DSP
+        /// </summary>
        public bool HasDsp { get; set; }

+        /// <summary>
+        /// Constructor
+        /// </summary>
        public EssentialsPresentationRoomPropertiesConfig()
        {
            DisplayKeys = new List<string>();
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs
@@ -25,11 +25,15 @@
        /// contact,versiport
        /// </summary>
        public string Type { get; set; }
+
        /// <summary>
        /// Input number if contact
        /// </summary>
        public int Number { get; set; }

+        /// <summary>
+        /// TriggerOnClose indicates if the trigger is on close
+        /// </summary>
        public bool TriggerOnClose { get; set; }

    }
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs
@@ -13,10 +13,10 @@ namespace PepperDash.Essentials.Room.Config
    /// </summary>
    public class EssentialsRoomScheduledEventsConfig
    {
-        [JsonProperty("scheduledEvents")]
        /// <summary>
        /// Gets or sets the ScheduledEvents
        /// </summary>
+        [JsonProperty("scheduledEvents")]
        public List<ScheduledEventConfig> ScheduledEvents;
    }

@@ -25,49 +25,52 @@ namespace PepperDash.Essentials.Room.Config
    /// </summary>
    public class ScheduledEventConfig
    {
-        [JsonProperty("key")]
        /// <summary>
        /// Gets or sets the Key
        /// </summary>
+        [JsonProperty("key")]
        public string Key;

-        [JsonProperty("name")]
        /// <summary>
        /// Gets or sets the Name
        /// </summary>
+        [JsonProperty("name")]
        public string Name;

+        /// <summary>
+        /// Gets or sets the Days
+        /// </summary>
        [JsonProperty("days")]
        public ScheduledEventCommon.eWeekDays Days;

-        [JsonProperty("time")]
        /// <summary>
        /// Gets or sets the Time
        /// </summary>
+        [JsonProperty("time")]
        public string Time;

-        [JsonProperty("actions")]
        /// <summary>
        /// Gets or sets the Actions
        /// </summary>
+        [JsonProperty("actions")]
        public List<DeviceActionWrapper> Actions;

-        [JsonProperty("persistent")]
        /// <summary>
        /// Gets or sets the Persistent
        /// </summary>
+        [JsonProperty("persistent")]
        public bool Persistent;

-        [JsonProperty("acknowledgeable")]
        /// <summary>
        /// Gets or sets the Acknowledgeable
        /// </summary>
+        [JsonProperty("acknowledgeable")]
        public bool Acknowledgeable;

-        [JsonProperty("enable")]
        /// <summary>
        /// Gets or sets the Enable
        /// </summary>
+        [JsonProperty("enable")]
        public bool Enable;
    }
 }
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs
@@ -14,9 +14,6 @@ namespace PepperDash.Essentials.Room.Config
        /// The key of the dummy device used to enable routing
        /// </summary>
        [JsonProperty("dummySourceKey")]
-        /// <summary>
-        /// Gets or sets the DummySourceKey
-        /// </summary>
        public string DummySourceKey { get; set; }

        /// <summary>
@@ -26,7 +23,7 @@ namespace PepperDash.Essentials.Room.Config
        public List<string> Displays { get; set; }
        
        /// <summary>
-        /// The keys of the tuners assinged to this room
+        /// The keys of the tuners assigned to this room
        /// </summary>
        [JsonProperty("tuners")]
        public List<string> Tuners { get; set; }
@@ -49,19 +46,16 @@ namespace PepperDash.Essentials.Room.Config
        [JsonProperty("presetsFileName")]
        public string PresetsFileName { get; set; }

-        [JsonProperty("scheduledEvents")]
        /// <summary>
        /// Gets or sets the ScheduledEvents
        /// </summary>
+        [JsonProperty("scheduledEvents")]
        public List<ScheduledEventConfig> ScheduledEvents { get; set; }

        /// <summary>
        /// Indicates that the room is the primary when true
        /// </summary>
        [JsonProperty("isPrimary")]
-        /// <summary>
-        /// Gets or sets the IsPrimary
-        /// </summary>
        public bool IsPrimary { get; set; }

        /// <summary>
@@ -70,21 +64,21 @@ namespace PepperDash.Essentials.Room.Config
        [JsonProperty("mirroredTuners")]
        public Dictionary<uint, string> MirroredTuners { get; set; }

-        [JsonProperty("helpMessage")]
        /// <summary>
        /// Gets or sets the HelpMessage
        /// </summary>
+        [JsonProperty("helpMessage")]
        public string HelpMessage { get; set; }

-        /// <summary>
-        /// Indicates the room 
-        /// </summary>
-        [JsonProperty("isTvPresetsProvider")] 
        /// <summary>
        /// Gets or sets the IsTvPresetsProvider
        /// </summary>
+        [JsonProperty("isTvPresetsProvider")] 
        public bool IsTvPresetsProvider;

+        /// <summary>
+        /// Constructor
+        /// </summary>
        public EssentialsTechRoomConfig()
        {
            Displays = new List<string>();
--- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs
@@ -12,8 +12,20 @@ namespace PepperDash.Essentials.Room.Config
        /// Gets or sets the Master
        /// </summary>
        public EssentialsVolumeLevelConfig Master { get; set; }
+
+        /// <summary>
+        /// Gets or sets the Program
+        /// </summary>
        public EssentialsVolumeLevelConfig Program { get; set; }
+
+        /// <summary>
+        /// Gets or sets the AudioCallRx
+        /// </summary>
        public EssentialsVolumeLevelConfig AudioCallRx { get; set; }
+
+        /// <summary>
+        /// Gets or sets the AudioCallTx
+        /// </summary>
        public EssentialsVolumeLevelConfig AudioCallTx { get; set; }
    }

--- a/src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs
+++ b/src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs
@@ -8,42 +8,46 @@ namespace PepperDash.Essentials.Room.Config
 /// </summary>
 	public class SimplRoomPropertiesConfig : EssentialsHuddleVtc1PropertiesConfig
 	{
+        /// <summary>
+        /// Gets or sets the RoomPhoneNumber
+        /// </summary>
 		[JsonProperty("roomPhoneNumber")]
-  /// <summary>
-  /// Gets or sets the RoomPhoneNumber
-  /// </summary>
 		public string RoomPhoneNumber { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the RoomURI
+        /// </summary>
 		[JsonProperty("roomURI")]
-  /// <summary>
-  /// Gets or sets the RoomURI
-  /// </summary>
 		public string RoomURI { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the SpeedDials
+        /// </summary>
 		[JsonProperty("speedDials")]
-  /// <summary>
-  /// Gets or sets the SpeedDials
-  /// </summary>
 		public List<SimplSpeedDial> SpeedDials { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the VolumeSliderNames
+        /// </summary>
 		[JsonProperty("volumeSliderNames")]
-  /// <summary>
-  /// Gets or sets the VolumeSliderNames
-  /// </summary>
 		public List<string> VolumeSliderNames { get; set; }
 	}

- /// <summary>
- /// Represents a SimplSpeedDial
- /// </summary>
+    /// <summary>
+    /// Represents a SimplSpeedDial
+    /// </summary>
 	public class SimplSpeedDial
 	{
+        /// <summary>
+        /// Gets or sets the Name
+        /// </summary>
 		[JsonProperty("name")]
-  /// <summary>
-  /// Gets or sets the Name
-  /// </summary>
 		public string Name { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the Number
+        /// </summary>
 		[JsonProperty("number")]
-  /// <summary>
-  /// Gets or sets the Number
-  /// </summary>
 		public string Number { get; set; }
 	}
 }