mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-04-13 12:37:07 +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
|
|
@ -10,18 +10,28 @@ using Serilog.Events;
|
|||
|
||||
namespace PepperDash.Essentials.Core.Devices
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a GenericCommunicationMonitoredDevice
|
||||
/// </summary>
|
||||
/// <summary>
|
||||
/// Represents a GenericCommunicationMonitoredDevice
|
||||
/// </summary>
|
||||
public class GenericCommunicationMonitoredDevice : Device, ICommunicationMonitor
|
||||
{
|
||||
IBasicCommunication Client;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the CommunicationMonitor
|
||||
/// </summary>
|
||||
/// <summary>
|
||||
/// Gets or sets the CommunicationMonitor
|
||||
/// </summary>
|
||||
public StatusMonitorBase CommunicationMonitor { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="key">key of the device</param>
|
||||
/// <param name="name">name of the device</param>
|
||||
/// <param name="comm">communication client</param>
|
||||
/// <param name="pollString">poll string</param>
|
||||
/// <param name="pollTime">poll time</param>
|
||||
/// <param name="warningTime">warning time</param>
|
||||
/// <param name="errorTime">error time</param>
|
||||
public GenericCommunicationMonitoredDevice(string key, string name, IBasicCommunication comm, string pollString,
|
||||
long pollTime, long warningTime, long errorTime)
|
||||
: base(key, name)
|
||||
|
|
@ -37,6 +47,13 @@ namespace PepperDash.Essentials.Core.Devices
|
|||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor with default times
|
||||
/// </summary>
|
||||
/// <param name="key">key of the device</param>
|
||||
/// <param name="name">name of the device</param>
|
||||
/// <param name="comm">communication client</param>
|
||||
/// <param name="pollString">poll string</param>
|
||||
public GenericCommunicationMonitoredDevice(string key, string name, IBasicCommunication comm, string pollString)
|
||||
: this(key, name, comm, pollString, 30000, 120000, 300000)
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue