docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>

src/PepperDash.Essentials.Core/Room/Config/EssentialsDualDisplayRoomPropertiesConfig.cs

@@ -1,6 +1,9 @@
 
 namespace PepperDash.Essentials.Room.Config
 {
+    /// <summary>
+    /// Represents a EssentialsDualDisplayRoomPropertiesConfig
+    /// </summary>
     public class EssentialsDualDisplayRoomPropertiesConfig : EssentialsNDisplayRoomPropertiesConfig
     {
 

src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleRoomPropertiesConfig.cs

@@ -3,7 +3,7 @@
 namespace PepperDash.Essentials.Room.Config
 {
     /// <summary>
-    /// 
+    /// Represents a EssentialsHuddleRoomPropertiesConfig
     /// </summary>
     public class EssentialsHuddleRoomPropertiesConfig : EssentialsRoomPropertiesConfig
     {

src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs

@@ -4,9 +4,15 @@ 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
+  /// </summary>
 		public string DefaultDisplayKey { get; set; }
 
     }

src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs

@@ -25,9 +25,18 @@ namespace PepperDash.Essentials.Room.Config
 
     }
 
+    /// <summary>
+    /// Represents a DisplayItem
+    /// </summary>
     public class DisplayItem : IKeyName
     {
+        /// <summary>
+        /// Gets or sets the Key
+        /// </summary>
         public string Key { get; set; }
+        /// <summary>
+        /// Gets or sets the Name
+        /// </summary>
         public string Name { get; set; }
     }
 

src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs

@@ -3,11 +3,17 @@
 namespace PepperDash.Essentials.Room.Config
 {
     /// <summary>
-    /// 
+    /// Represents a EssentialsPresentationRoomPropertiesConfig
     /// </summary>
     public class EssentialsPresentationRoomPropertiesConfig : EssentialsRoomPropertiesConfig
     {
+        /// <summary>
+        /// Gets or sets the DefaultAudioBehavior
+        /// </summary>
         public string DefaultAudioBehavior { get; set; }
+        /// <summary>
+        /// Gets or sets the DefaultAudioKey
+        /// </summary>
         public string DefaultAudioKey { get; set; }
         public string DefaultVideoBehavior { get; set; }
         public List<string> DisplayKeys { get; set; }

src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomConfig.cs

@@ -9,11 +9,13 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Room.Config
 {
+ /// <summary>
+ /// Represents a EssentialsRoomConfigHelper
+ /// </summary>
 	public class EssentialsRoomConfigHelper
 	{
         /// <summary>
-        /// Gets and operating, standalone emergegncy object that can be plugged into a room.
-        /// Returns null if there is no emergency defined
+        /// GetEmergency method
         /// </summary>
         public static EssentialsRoomEmergencyBase GetEmergency(EssentialsRoomPropertiesConfig props, IEssentialsRoom room)
         {
@@ -35,6 +37,9 @@ namespace PepperDash.Essentials.Room.Config
 		/// <param name="props"></param>
 		/// <param name="room"></param>
 		/// <returns></returns>
+  /// <summary>
+  /// GetMicrophonePrivacy method
+  /// </summary>
 		public static MicrophonePrivacyController GetMicrophonePrivacy(
 			EssentialsRoomPropertiesConfig props, IPrivacy room)
 		{
@@ -95,9 +100,9 @@ namespace PepperDash.Essentials.Room.Config
 	
 	}
 
-    /// <summary>
-    /// 
-    /// </summary>
+ /// <summary>
+ /// Represents a EssentialsRoomPropertiesConfig
+ /// </summary>
 	public class EssentialsRoomPropertiesConfig
 	{
 		[JsonProperty("addresses")]
@@ -110,9 +115,15 @@ namespace PepperDash.Essentials.Room.Config
 		public EssentialsRoomEmergencyConfig Emergency { get; set; }
 
 		[JsonProperty("help")]
+  /// <summary>
+  /// Gets or sets the Help
+  /// </summary>
 		public EssentialsHelpPropertiesConfig Help { get; set; }
 
 		[JsonProperty("helpMessage")]
+  /// <summary>
+  /// Gets or sets the HelpMessage
+  /// </summary>
 		public string HelpMessage { get; set; }
 
         /// <summary>
@@ -134,48 +145,90 @@ namespace PepperDash.Essentials.Room.Config
         }
 
 		[JsonProperty("environment")]
+  /// <summary>
+  /// Gets or sets the Environment
+  /// </summary>
 		public EssentialsEnvironmentPropertiesConfig Environment { get; set; }
 
 		[JsonProperty("logo")]
+  /// <summary>
+  /// Gets or sets the LogoLight
+  /// </summary>
 		public EssentialsLogoPropertiesConfig LogoLight { get; set; }
 
         [JsonProperty("logoDark")]
+        /// <summary>
+        /// Gets or sets the LogoDark
+        /// </summary>
         public EssentialsLogoPropertiesConfig LogoDark { get; set; }
 	
 		[JsonProperty("microphonePrivacy")]
+  /// <summary>
+  /// Gets or sets the MicrophonePrivacy
+  /// </summary>
 		public EssentialsRoomMicrophonePrivacyConfig MicrophonePrivacy { get; set; }
 
 		[JsonProperty("occupancy")]
+  /// <summary>
+  /// Gets or sets the Occupancy
+  /// </summary>
 		public EssentialsRoomOccSensorConfig Occupancy { get; set; }
 
 		[JsonProperty("oneButtonMeeting")]
+  /// <summary>
+  /// Gets or sets the OneButtonMeeting
+  /// </summary>
 		public EssentialsOneButtonMeetingPropertiesConfig OneButtonMeeting { get; set; }
 
 		[JsonProperty("shutdownVacancySeconds")]
+  /// <summary>
+  /// Gets or sets the ShutdownVacancySeconds
+  /// </summary>
 		public int ShutdownVacancySeconds { get; set; }
 
 		[JsonProperty("shutdownPromptSeconds")]
+  /// <summary>
+  /// Gets or sets the ShutdownPromptSeconds
+  /// </summary>
 		public int ShutdownPromptSeconds { get; set; }
 
 		[JsonProperty("tech")]
+  /// <summary>
+  /// Gets or sets the Tech
+  /// </summary>
 		public EssentialsRoomTechConfig Tech { get; set; }
 
 		[JsonProperty("volumes")]
+  /// <summary>
+  /// Gets or sets the Volumes
+  /// </summary>
 		public EssentialsRoomVolumesConfig Volumes { get; set; }
 
         [JsonProperty("fusion")]
+        /// <summary>
+        /// Gets or sets the Fusion
+        /// </summary>
         public EssentialsRoomFusionConfig Fusion { get; set; }
 
         [JsonProperty("essentialsRoomUiBehaviorConfig", NullValueHandling=NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the UiBehavior
+        /// </summary>
         public EssentialsRoomUiBehaviorConfig UiBehavior { get; set; }
 
 		[JsonProperty("zeroVolumeWhenSwtichingVolumeDevices")]
+  /// <summary>
+  /// Gets or sets the ZeroVolumeWhenSwtichingVolumeDevices
+  /// </summary>
 		public bool ZeroVolumeWhenSwtichingVolumeDevices { get; set; }
 
         /// <summary>
         /// Indicates if this room represents a combination of other rooms
         /// </summary>
         [JsonProperty("isRoomCombinationScenario")]
+        /// <summary>
+        /// Gets or sets the IsRoomCombinationScenario
+        /// </summary>
         public bool IsRoomCombinationScenario { get; set; }
 
         public EssentialsRoomPropertiesConfig()
@@ -185,58 +238,109 @@ namespace PepperDash.Essentials.Room.Config
         }
 	}
 
+    /// <summary>
+    /// Represents a EssentialsRoomUiBehaviorConfig
+    /// </summary>
     public class EssentialsRoomUiBehaviorConfig
     {
         [JsonProperty("disableActivityButtonsWhileWarmingCooling")]
+        /// <summary>
+        /// Gets or sets the DisableActivityButtonsWhileWarmingCooling
+        /// </summary>
         public bool DisableActivityButtonsWhileWarmingCooling { get; set; }
     }
 
+    /// <summary>
+    /// Represents a EssentialsAvRoomPropertiesConfig
+    /// </summary>
     public class EssentialsAvRoomPropertiesConfig : EssentialsRoomPropertiesConfig
     {
         [JsonProperty("defaultAudioKey")]
+        /// <summary>
+        /// Gets or sets the DefaultAudioKey
+        /// </summary>
         public string DefaultAudioKey { get; set; }
         [JsonProperty("sourceListKey")]
+        /// <summary>
+        /// Gets or sets the SourceListKey
+        /// </summary>
         public string SourceListKey { get; set; }
         [JsonProperty("destinationListKey")]
+        /// <summary>
+        /// Gets or sets the DestinationListKey
+        /// </summary>
         public string DestinationListKey { get; set; }
         [JsonProperty("audioControlPointListKey")]
+        /// <summary>
+        /// Gets or sets the AudioControlPointListKey
+        /// </summary>
         public string AudioControlPointListKey { get; set; }
         [JsonProperty("cameraListKey")]
+        /// <summary>
+        /// Gets or sets the CameraListKey
+        /// </summary>
         public string CameraListKey { get; set; }
 
 
         [JsonProperty("defaultSourceItem")]
+        /// <summary>
+        /// Gets or sets the DefaultSourceItem
+        /// </summary>
         public string DefaultSourceItem { get; set; }
         /// <summary>
         /// Indicates if the room supports advanced sharing
         /// </summary>
         [JsonProperty("supportsAdvancedSharing")]
+        /// <summary>
+        /// Gets or sets the SupportsAdvancedSharing
+        /// </summary>
         public bool SupportsAdvancedSharing { get; set; }
         /// <summary>
         /// Indicates if non-tech users can change the share mode
         /// </summary>
         [JsonProperty("userCanChangeShareMode")]
+        /// <summary>
+        /// Gets or sets the UserCanChangeShareMode
+        /// </summary>
         public bool UserCanChangeShareMode { get; set; }
 
 
         [JsonProperty("matrixRoutingKey", NullValueHandling = NullValueHandling.Ignore)]
+        /// <summary>
+        /// Gets or sets the MatrixRoutingKey
+        /// </summary>
         public string MatrixRoutingKey { get; set; }
     }
 
     public class EssentialsConferenceRoomPropertiesConfig : EssentialsAvRoomPropertiesConfig
     {
         [JsonProperty("videoCodecKey")]
+        /// <summary>
+        /// Gets or sets the VideoCodecKey
+        /// </summary>
         public string VideoCodecKey { get; set; }
         [JsonProperty("audioCodecKey")]
+        /// <summary>
+        /// Gets or sets the AudioCodecKey
+        /// </summary>
         public string AudioCodecKey { get; set; }
 
     }
 
+ /// <summary>
+ /// Represents a EssentialsEnvironmentPropertiesConfig
+ /// </summary>
 	public class EssentialsEnvironmentPropertiesConfig
 	{
+  /// <summary>
+  /// Gets or sets the Enabled
+  /// </summary>
 		public bool Enabled { get; set; }
 
         [JsonProperty("deviceKeys")]
+        /// <summary>
+        /// Gets or sets the DeviceKeys
+        /// </summary>
         public List<string> DeviceKeys { get; set; }
 
         public EssentialsEnvironmentPropertiesConfig()
@@ -246,6 +350,9 @@ namespace PepperDash.Essentials.Room.Config
 
 	}
 
+    /// <summary>
+    /// Represents a EssentialsRoomFusionConfig
+    /// </summary>
     public class EssentialsRoomFusionConfig
     {
         public uint IpIdInt
@@ -265,28 +372,46 @@ namespace PepperDash.Essentials.Room.Config
         }
 
         [JsonProperty("ipId")]
+        /// <summary>
+        /// Gets or sets the IpId
+        /// </summary>
         public string IpId { get; set; }
 
         [JsonProperty("joinMapKey")]
+        /// <summary>
+        /// Gets or sets the JoinMapKey
+        /// </summary>
         public string JoinMapKey { get; set; }
 
     }
 
+    /// <summary>
+    /// Represents a EssentialsRoomMicrophonePrivacyConfig
+    /// </summary>
     public class EssentialsRoomMicrophonePrivacyConfig
     {
 		[JsonProperty("deviceKey")]
+  /// <summary>
+  /// Gets or sets the DeviceKey
+  /// </summary>
 		public string DeviceKey { get; set; }
 
 		[JsonProperty("behaviour")]
+  /// <summary>
+  /// Gets or sets the Behaviour
+  /// </summary>
 		public string Behaviour { get; set; }
     }
 
     /// <summary>
-    /// Properties for the help text box
+    /// Represents a EssentialsHelpPropertiesConfig
     /// </summary>
     public class EssentialsHelpPropertiesConfig
     {
 		[JsonProperty("message")]
+  /// <summary>
+  /// Gets or sets the Message
+  /// </summary>
 		public string Message { get; set; }
 
 		[JsonProperty("showCallButton")]
@@ -296,6 +421,9 @@ namespace PepperDash.Essentials.Room.Config
         /// Defaults to "Call Help Desk"
         /// </summary>
 		[JsonProperty("callButtonText")]
+  /// <summary>
+  /// Gets or sets the CallButtonText
+  /// </summary>
 		public string CallButtonText { get; set; }
 
         public EssentialsHelpPropertiesConfig()
@@ -305,11 +433,14 @@ namespace PepperDash.Essentials.Room.Config
     }
 
     /// <summary>
-    /// 
+    /// Represents a EssentialsOneButtonMeetingPropertiesConfig
     /// </summary>
     public class EssentialsOneButtonMeetingPropertiesConfig
     {
 		[JsonProperty("enable")]
+  /// <summary>
+  /// Gets or sets the Enable
+  /// </summary>
 		public bool Enable { get; set; }
     }
 
@@ -319,22 +450,28 @@ namespace PepperDash.Essentials.Room.Config
 		public string PhoneNumber { get; set; }
 
 		[JsonProperty("sipAddress")]
+  /// <summary>
+  /// Gets or sets the SipAddress
+  /// </summary>
 		public string SipAddress { get; set; }
     }
 
 
     /// <summary>
-    /// Properties for the room's logo on panels
+    /// Represents a EssentialsLogoPropertiesConfig
     /// </summary>
     public class EssentialsLogoPropertiesConfig
     {
 		[JsonProperty("type")]
+  /// <summary>
+  /// Gets or sets the Type
+  /// </summary>
 		public string Type { get; set; }
 
 		[JsonProperty("url")]
 		public string Url { get; set; }
         /// <summary>
-        /// Gets either the custom URL, a local-to-processor URL, or null if it's a default logo
+        /// GetLogoUrlLight method
         /// </summary>
         public string GetLogoUrlLight()
         {
@@ -346,6 +483,9 @@ namespace PepperDash.Essentials.Room.Config
             return null;
         }
 
+        /// <summary>
+        /// GetLogoUrlDark method
+        /// </summary>
         public string GetLogoUrlDark()
         {
             if (Type == "url")
@@ -358,11 +498,14 @@ namespace PepperDash.Essentials.Room.Config
     }
 
     /// <summary>
-    /// Represents occupancy sensor(s) setup for a room
+    /// Represents a EssentialsRoomOccSensorConfig
     /// </summary>
     public class EssentialsRoomOccSensorConfig
     {
 		[JsonProperty("deviceKey")]
+  /// <summary>
+  /// Gets or sets the DeviceKey
+  /// </summary>
 		public string DeviceKey { get; set; }
 
 		[JsonProperty("timeoutMinutes")]
@@ -372,6 +515,9 @@ namespace PepperDash.Essentials.Room.Config
 	public class EssentialsRoomTechConfig
 	{
 		[JsonProperty("password")]
+  /// <summary>
+  /// Gets or sets the Password
+  /// </summary>
 		public string Password { get; set; }
 	}
 }

src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs

@@ -1,17 +1,23 @@
 namespace PepperDash.Essentials.Room.Config
 {
     /// <summary>
-    /// 
+    /// Represents a EssentialsRoomEmergencyConfig
     /// </summary>
     public class EssentialsRoomEmergencyConfig
     {
+        /// <summary>
+        /// Gets or sets the Trigger
+        /// </summary>
         public EssentialsRoomEmergencyTriggerConfig Trigger { get; set; }
 
+        /// <summary>
+        /// Gets or sets the Behavior
+        /// </summary>
         public string Behavior { get; set; }
     }
 
     /// <summary>
-    /// 
+    /// Represents a EssentialsRoomEmergencyTriggerConfig
     /// </summary>
     public class EssentialsRoomEmergencyTriggerConfig
     {

src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs

@@ -8,36 +8,66 @@ using PepperDash.Essentials.Core;
 
 namespace PepperDash.Essentials.Room.Config
 {
+    /// <summary>
+    /// Represents a EssentialsRoomScheduledEventsConfig
+    /// </summary>
     public class EssentialsRoomScheduledEventsConfig
     {
         [JsonProperty("scheduledEvents")]
+        /// <summary>
+        /// Gets or sets the ScheduledEvents
+        /// </summary>
         public List<ScheduledEventConfig> ScheduledEvents;
     }
 
+    /// <summary>
+    /// Represents a ScheduledEventConfig
+    /// </summary>
     public class ScheduledEventConfig
     {
         [JsonProperty("key")]
+        /// <summary>
+        /// Gets or sets the Key
+        /// </summary>
         public string Key;
 
         [JsonProperty("name")]
+        /// <summary>
+        /// Gets or sets the Name
+        /// </summary>
         public string Name;
 
         [JsonProperty("days")]
         public ScheduledEventCommon.eWeekDays Days;
 
         [JsonProperty("time")]
+        /// <summary>
+        /// Gets or sets the Time
+        /// </summary>
         public string Time;
 
         [JsonProperty("actions")]
+        /// <summary>
+        /// Gets or sets the Actions
+        /// </summary>
         public List<DeviceActionWrapper> Actions;
 
         [JsonProperty("persistent")]
+        /// <summary>
+        /// Gets or sets the Persistent
+        /// </summary>
         public bool Persistent;
 
         [JsonProperty("acknowledgeable")]
+        /// <summary>
+        /// Gets or sets the Acknowledgeable
+        /// </summary>
         public bool Acknowledgeable;
 
         [JsonProperty("enable")]
+        /// <summary>
+        /// Gets or sets the Enable
+        /// </summary>
         public bool Enable;
     }
 }

src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs

@@ -5,12 +5,18 @@ using PepperDash.Essentials.Room.Config;
 
 namespace PepperDash.Essentials.Room.Config
 {
+    /// <summary>
+    /// Represents a EssentialsTechRoomConfig
+    /// </summary>
     public class EssentialsTechRoomConfig
     {
         /// <summary>
         /// 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>
@@ -44,12 +50,18 @@ namespace PepperDash.Essentials.Room.Config
         public string PresetsFileName { get; set; }
 
         [JsonProperty("scheduledEvents")]
+        /// <summary>
+        /// Gets or sets the ScheduledEvents
+        /// </summary>
         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>
@@ -59,12 +71,18 @@ namespace PepperDash.Essentials.Room.Config
         public Dictionary<uint, string> MirroredTuners { get; set; }
 
         [JsonProperty("helpMessage")]
+        /// <summary>
+        /// Gets or sets the HelpMessage
+        /// </summary>
         public string HelpMessage { get; set; }
 
         /// <summary>
         /// Indicates the room 
         /// </summary>
         [JsonProperty("isTvPresetsProvider")] 
+        /// <summary>
+        /// Gets or sets the IsTvPresetsProvider
+        /// </summary>
         public bool IsTvPresetsProvider;
 
         public EssentialsTechRoomConfig()

src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs

@@ -4,10 +4,13 @@ using PepperDash.Essentials.Core;
 namespace PepperDash.Essentials.Room.Config
 {
     /// <summary>
-    /// 
+    /// Represents a EssentialsRoomVolumesConfig
     /// </summary>
     public class EssentialsRoomVolumesConfig
     {
+        /// <summary>
+        /// Gets or sets the Master
+        /// </summary>
         public EssentialsVolumeLevelConfig Master { get; set; }
         public EssentialsVolumeLevelConfig Program { get; set; }
         public EssentialsVolumeLevelConfig AudioCallRx { get; set; }
@@ -15,12 +18,21 @@ namespace PepperDash.Essentials.Room.Config
     }
 
     /// <summary>
-    /// 
+    /// Represents a EssentialsVolumeLevelConfig
     /// </summary>
     public class EssentialsVolumeLevelConfig
     {
+        /// <summary>
+        /// Gets or sets the DeviceKey
+        /// </summary>
         public string DeviceKey { get; set; }
+        /// <summary>
+        /// Gets or sets the Label
+        /// </summary>
         public string Label { get; set; }
+        /// <summary>
+        /// Gets or sets the Level
+        /// </summary>
         public int Level { get; set; }
 
         /// <summary>

src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs

@@ -3,23 +3,47 @@ using Newtonsoft.Json;
 
 namespace PepperDash.Essentials.Room.Config
 {
+ /// <summary>
+ /// Represents a SimplRoomPropertiesConfig
+ /// </summary>
 	public class SimplRoomPropertiesConfig : EssentialsHuddleVtc1PropertiesConfig
 	{
 		[JsonProperty("roomPhoneNumber")]
+  /// <summary>
+  /// Gets or sets the RoomPhoneNumber
+  /// </summary>
 		public string RoomPhoneNumber { get; set; }
 		[JsonProperty("roomURI")]
+  /// <summary>
+  /// Gets or sets the RoomURI
+  /// </summary>
 		public string RoomURI { get; set; }
 		[JsonProperty("speedDials")]
+  /// <summary>
+  /// Gets or sets the SpeedDials
+  /// </summary>
 		public List<SimplSpeedDial> SpeedDials { get; set; }
 		[JsonProperty("volumeSliderNames")]
+  /// <summary>
+  /// Gets or sets the VolumeSliderNames
+  /// </summary>
 		public List<string> VolumeSliderNames { get; set; }
 	}
 
+ /// <summary>
+ /// Represents a SimplSpeedDial
+ /// </summary>
 	public class SimplSpeedDial
 	{
 		[JsonProperty("name")]
+  /// <summary>
+  /// Gets or sets the Name
+  /// </summary>
 		public string Name { get; set; }
 		[JsonProperty("number")]
+  /// <summary>
+  /// Gets or sets the Number
+  /// </summary>
 		public string Number { get; set; }
 	}
 }