mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-04-15 05:27:16 +00:00
docs: update XML comments for Essentials Core
This commit is contained in:
parent
0764685c51
commit
f88bb13367
260 changed files with 7018 additions and 1318 deletions
|
|
@ -19,10 +19,20 @@ namespace PepperDash.Essentials.Core.Devices
|
|||
/// </summary>
|
||||
public abstract class ReconfigurableDevice : EssentialsDevice, IReconfigurableDevice
|
||||
{
|
||||
/// <summary>
|
||||
/// Event fired when the configuration changes
|
||||
/// </summary>
|
||||
public event EventHandler<EventArgs> ConfigChanged;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the current DeviceConfig
|
||||
/// </summary>
|
||||
public DeviceConfig Config { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="config">config of the device</param>
|
||||
protected ReconfigurableDevice(DeviceConfig config)
|
||||
: base(config.Key)
|
||||
{
|
||||
|
|
@ -64,19 +74,33 @@ namespace PepperDash.Essentials.Core.Devices
|
|||
/// <summary>
|
||||
/// Used by the extending class to allow for any custom actions to be taken (tell the ConfigWriter to write config, etc)
|
||||
/// </summary>
|
||||
/// <param name="config"></param>
|
||||
/// <param name="config">config of the device</param>
|
||||
protected virtual void CustomSetConfig(DeviceConfig config)
|
||||
{
|
||||
ConfigWriter.UpdateDeviceConfig(config);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A ReconfigurableDevice that is also bridgeable
|
||||
/// </summary>
|
||||
public abstract class ReconfigurableBridgableDevice : ReconfigurableDevice, IBridgeAdvanced
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="config">config of the device</param>
|
||||
protected ReconfigurableBridgableDevice(DeviceConfig config) : base(config)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// LinkToApi method
|
||||
/// </summary>
|
||||
/// <param name="trilist">trilist to link</param>
|
||||
/// <param name="joinStart">the join to start at</param>
|
||||
/// <param name="joinMapKey">key to the join map</param>
|
||||
/// <param name="bridge">the bridge to use</param>
|
||||
public abstract void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue