chore: added some additional documentation

This commit is contained in:
Nick Genovese
2024-02-01 13:16:15 -05:00
parent e8408add14
commit 0548d3b3ea
7 changed files with 12 additions and 12 deletions

View File

@@ -10,7 +10,7 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.Devices namespace PepperDash.Essentials.Core.Devices
{ {
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public class InRoomPc : EssentialsDevice, IHasFeedback, IRoutingOutputs, IAttachVideoStatus, IUiDisplayInfo, IUsageTracking public class InRoomPc : EssentialsDevice, IHasFeedback, IRoutingOutputs, IAttachVideoStatus, IUiDisplayInfo, IUsageTracking
{ {
public uint DisplayUiType { get { return DisplayUiConstants.TypeLaptop; } } public uint DisplayUiType { get { return DisplayUiConstants.TypeLaptop; } }
@@ -63,7 +63,7 @@ namespace PepperDash.Essentials.Core.Devices
#endregion #endregion
} }
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public class InRoomPcFactory : EssentialsDeviceFactory<InRoomPc> public class InRoomPcFactory : EssentialsDeviceFactory<InRoomPc>
{ {
public InRoomPcFactory() public InRoomPcFactory()

View File

@@ -11,7 +11,7 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.Devices namespace PepperDash.Essentials.Core.Devices
{ {
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public class Laptop : EssentialsDevice, IHasFeedback, IRoutingOutputs, IAttachVideoStatus, IUiDisplayInfo, IUsageTracking public class Laptop : EssentialsDevice, IHasFeedback, IRoutingOutputs, IAttachVideoStatus, IUiDisplayInfo, IUsageTracking
{ {
public uint DisplayUiType { get { return DisplayUiConstants.TypeLaptop; } } public uint DisplayUiType { get { return DisplayUiConstants.TypeLaptop; } }
@@ -64,7 +64,7 @@ namespace PepperDash.Essentials.Core.Devices
#endregion #endregion
} }
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public class LaptopFactory : EssentialsDeviceFactory<Laptop> public class LaptopFactory : EssentialsDeviceFactory<Laptop>
{ {
public LaptopFactory() public LaptopFactory()

View File

@@ -14,7 +14,7 @@ using PepperDash.Essentials.Core.Routing;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
[Obsolete("Please use PepperDash.Essentials.Device.Common")] [Obsolete("Please use PepperDash.Essentials.Device.Common, this will be removed in 2.1")]
public class BasicIrDisplay : DisplayBase, IBasicVolumeControls, IBridgeAdvanced public class BasicIrDisplay : DisplayBase, IBasicVolumeControls, IBridgeAdvanced
{ {
public IrOutputPortController IrPort { get; private set; } public IrOutputPortController IrPort { get; private set; }
@@ -203,7 +203,7 @@ namespace PepperDash.Essentials.Core
} }
} }
[Obsolete("Please use PepperDash.Essentials.Device.Common")] [Obsolete("Please use PepperDash.Essentials.Device.Common, this will be removed in 2.1")]
public class BasicIrDisplayFactory : EssentialsDeviceFactory<BasicIrDisplay> public class BasicIrDisplayFactory : EssentialsDeviceFactory<BasicIrDisplay>
{ {
public BasicIrDisplayFactory() public BasicIrDisplayFactory()

View File

@@ -12,7 +12,7 @@ using PepperDash.Essentials.Core.Bridges;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public abstract class DisplayBase : EssentialsDevice, IHasFeedback, IRoutingSinkWithSwitching, IHasPowerControl, IWarmingCooling, IUsageTracking public abstract class DisplayBase : EssentialsDevice, IHasFeedback, IRoutingSinkWithSwitching, IHasPowerControl, IWarmingCooling, IUsageTracking
{ {
public event SourceInfoChangeHandler CurrentSourceChange; public event SourceInfoChangeHandler CurrentSourceChange;
@@ -250,7 +250,7 @@ namespace PepperDash.Essentials.Core
} }
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public abstract class TwoWayDisplayBase : DisplayBase, IRoutingFeedback, IHasPowerControlWithFeedback public abstract class TwoWayDisplayBase : DisplayBase, IRoutingFeedback, IHasPowerControlWithFeedback
{ {
public StringFeedback CurrentInputFeedback { get; private set; } public StringFeedback CurrentInputFeedback { get; private set; }

View File

@@ -16,7 +16,7 @@ using PepperDash.Essentials.Core.Config;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public class MockDisplay : TwoWayDisplayBase, IBasicVolumeWithFeedback, IBridgeAdvanced public class MockDisplay : TwoWayDisplayBase, IBasicVolumeWithFeedback, IBridgeAdvanced
{ {
@@ -219,7 +219,7 @@ namespace PepperDash.Essentials.Core
} }
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public class MockDisplayFactory : EssentialsDeviceFactory<MockDisplay> public class MockDisplayFactory : EssentialsDeviceFactory<MockDisplay>
{ {
public MockDisplayFactory() public MockDisplayFactory()

View File

@@ -13,7 +13,7 @@ using PepperDash.Essentials.Core.Bridges;
namespace PepperDash.Essentials.Core.Lighting namespace PepperDash.Essentials.Core.Lighting
{ {
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public abstract class LightingBase : EssentialsBridgeableDevice, ILightingScenes public abstract class LightingBase : EssentialsBridgeableDevice, ILightingScenes
{ {
#region ILightingScenes Members #region ILightingScenes Members

View File

@@ -10,7 +10,7 @@ using PepperDash.Essentials.Core.CrestronIO;
namespace PepperDash.Essentials.Core.Shades namespace PepperDash.Essentials.Core.Shades
{ {
[Obsolete("Please use PepperDash.Essentials.Devices.Common")] [Obsolete("Please use PepperDash.Essentials.Devices.Common, this will be removed in 2.1")]
public abstract class ShadeBase : EssentialsDevice, IShadesOpenCloseStop public abstract class ShadeBase : EssentialsDevice, IShadesOpenCloseStop
{ {
public ShadeBase(string key, string name) public ShadeBase(string key, string name)