docs: XML comments for Devices.Common

src/PepperDash.Essentials.Devices.Common/Room/IEssentialsHuddleSpaceRoom.cs

@@ -9,10 +9,20 @@ namespace PepperDash.Essentials.Devices.Common.Room
     public interface IEssentialsHuddleSpaceRoom : IEssentialsRoom, IHasCurrentSourceInfoChange, IRunRouteAction, IHasDefaultDisplay, IHasCurrentVolumeControls, IRoomOccupancy,
         IEmergency, IMicrophonePrivacy
     {
+        /// <summary>
+        /// Gets whether to exclude this room from global functions
+        /// </summary>
         bool ExcludeFromGlobalFunctions { get; }
 
+        /// <summary>
+        /// Runs the route action for the given routeKey and sourceListKey
+        /// </summary>
+        /// <param name="routeKey">The route key</param>
         void RunRouteAction(string routeKey);
 
+        /// <summary>
+        /// Gets the PropertiesConfig
+        /// </summary>
         EssentialsHuddleRoomPropertiesConfig PropertiesConfig { get; }
     }
 }

src/PepperDash.Essentials.Devices.Common/Room/IEssentialsHuddleVtc1Room.cs

@@ -12,18 +12,40 @@ namespace PepperDash.Essentials.Devices.Common.Room
     public interface IEssentialsHuddleVtc1Room : IEssentialsRoom, IHasCurrentSourceInfoChange, IHasCurrentVolumeControls, IRunRouteAction, IRunDefaultCallRoute, IHasVideoCodec, IHasAudioCodec, IHasDefaultDisplay, IHasInCallFeedback,
         IRoomOccupancy, IEmergency, IMicrophonePrivacy
     {
+        /// <summary>
+        /// Gets the PropertiesConfig
+        /// </summary>
         EssentialsHuddleVtc1PropertiesConfig PropertiesConfig { get; }
 
+        /// <summary>
+        /// Gets whether to exclude this room from global functions
+        /// </summary>
         bool ExcludeFromGlobalFunctions { get; }
 
+        /// <summary>
+        /// Runs the route action for the given routeKey and sourceListKey
+        /// </summary>
+        /// <param name="routeKey">The route key</param>
         void RunRouteAction(string routeKey);
 
+        /// <summary>
+        /// Gets the ScheduleSource
+        /// </summary>
         IHasScheduleAwareness ScheduleSource { get; }
 
+        /// <summary>
+        /// Gets the InCallFeedback
+        /// </summary>
         new BoolFeedback InCallFeedback { get; }
 
+        /// <summary>
+        /// Gets the PrivacyModeIsOnFeedback
+        /// </summary>
         new BoolFeedback PrivacyModeIsOnFeedback { get; }
 
+        /// <summary>
+        /// Gets the DefaultCodecRouteString
+        /// </summary>
         string DefaultCodecRouteString { get; }
     }
 }

src/PepperDash.Essentials.Devices.Common/Room/IEssentialsRoomPropertiesConfig.cs

@@ -1,9 +1,4 @@
 using PepperDash.Essentials.Room.Config;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace PepperDash.Essentials.Devices.Common.Room
 {
@@ -12,6 +7,9 @@ namespace PepperDash.Essentials.Devices.Common.Room
     /// </summary>
     public interface IEssentialsRoomPropertiesConfig
     {
+        /// <summary>
+        /// Gets the PropertiesConfig
+        /// </summary>
         EssentialsRoomPropertiesConfig PropertiesConfig { get; }
     }
 }

src/PepperDash.Essentials.Devices.Common/Room/IEssentialsTechRoom.cs

@@ -1,9 +1,9 @@
-using PepperDash.Essentials.Core;
+using System.Collections.Generic;
+using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Bridges;
 using PepperDash.Essentials.Core.DeviceTypeInterfaces;
+using PepperDash.Essentials.Devices.Common.Displays;
 using PepperDash.Essentials.Room.Config;
-using System.Collections.Generic;
-using TwoWayDisplayBase = PepperDash.Essentials.Devices.Common.Displays.TwoWayDisplayBase;
 
 
 namespace PepperDash.Essentials.Devices.Common.Room
@@ -11,15 +11,31 @@ namespace PepperDash.Essentials.Devices.Common.Room
     /// <summary>
     /// Defines the contract for IEssentialsTechRoom
     /// </summary>
-    public interface IEssentialsTechRoom:IEssentialsRoom, ITvPresetsProvider,IBridgeAdvanced,IRunDirectRouteAction
+    public interface IEssentialsTechRoom : IEssentialsRoom, ITvPresetsProvider, IBridgeAdvanced, IRunDirectRouteAction
     {
+        /// <summary>
+        /// Gets the PropertiesConfig
+        /// </summary>
         EssentialsTechRoomConfig PropertiesConfig { get; }
+
+        /// <summary>
+        /// Gets the Tuners
+        /// </summary>
         Dictionary<string, IRSetTopBoxBase> Tuners { get; }
 
+        /// <summary>
+        /// Gets the Displays
+        /// </summary>
         Dictionary<string, TwoWayDisplayBase> Displays { get; }
 
+        /// <summary>
+        /// Powers on the room
+        /// </summary>
         void RoomPowerOn();
 
+        /// <summary>
+        /// Powers off the room
+        /// </summary>
         void RoomPowerOff();
     }
 }