docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions

View File

@@ -1,11 +1,29 @@
namespace PepperDash.Essentials.Core.DeviceInfo
{
/// <summary>
/// Represents a DeviceInfo
/// </summary>
public class DeviceInfo
{
/// <summary>
/// Gets or sets the HostName
/// </summary>
public string HostName { get; set; }
/// <summary>
/// Gets or sets the IpAddress
/// </summary>
public string IpAddress { get; set; }
/// <summary>
/// Gets or sets the MacAddress
/// </summary>
public string MacAddress { get; set; }
/// <summary>
/// Gets or sets the SerialNumber
/// </summary>
public string SerialNumber { get; set; }
/// <summary>
/// Gets or sets the FirmwareVersion
/// </summary>
public string FirmwareVersion { get; set; }
}
}

View File

@@ -2,8 +2,14 @@
namespace PepperDash.Essentials.Core.DeviceInfo
{
/// <summary>
/// Represents a DeviceInfoEventArgs
/// </summary>
public class DeviceInfoEventArgs:EventArgs
{
/// <summary>
/// Gets or sets the DeviceInfo
/// </summary>
public DeviceInfo DeviceInfo { get; set; }
public DeviceInfoEventArgs()

View File

@@ -3,6 +3,9 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.DeviceInfo
{
/// <summary>
/// Defines the contract for IDeviceInfoProvider
/// </summary>
public interface IDeviceInfoProvider:IKeyed
{
DeviceInfo DeviceInfo { get; }
@@ -12,5 +15,8 @@ namespace PepperDash.Essentials.Core.DeviceInfo
void UpdateDeviceInfo();
}
/// <summary>
/// Delegate for DeviceInfoChangeHandler
/// </summary>
public delegate void DeviceInfoChangeHandler(IKeyed device, DeviceInfoEventArgs args);
}

View File

@@ -27,12 +27,12 @@ namespace PepperDash.Essentials.Core.DeviceInfo
private static readonly CCriticalSection Lock = new CCriticalSection();
/// <summary>
/// Last resolved ARP table - it is recommended to refresh the arp before using this.
/// Gets or sets the ArpTable
/// </summary>
public static List<ArpEntry> ArpTable { get; private set; }
/// <summary>
/// Force recheck of ARP table
/// RefreshArp method
/// </summary>
public static void RefreshArp()
{
@@ -98,6 +98,9 @@ namespace PepperDash.Essentials.Core.DeviceInfo
/// </summary>
/// <param name="ipAddressIn">Ip Address to Santitize</param>
/// <returns>Sanitized Ip Address</returns>
/// <summary>
/// SanitizeIpAddress method
/// </summary>
public static string SanitizeIpAddress(string ipAddressIn)
{
try
@@ -117,6 +120,9 @@ namespace PepperDash.Essentials.Core.DeviceInfo
/// </summary>
/// <param name="ipAddress">IP Address to resolve from</param>
/// <returns>Resolved Hostname - on failure to determine hostname, will return IP Address</returns>
/// <summary>
/// ResolveHostnameFromIp method
/// </summary>
public static string ResolveHostnameFromIp(string ipAddress)
{
try
@@ -137,6 +143,9 @@ namespace PepperDash.Essentials.Core.DeviceInfo
/// </summary>
/// <param name="hostName">Hostname to resolve from</param>
/// <returns>Resolved IP Address - on a failure to determine IP Address, will return hostname</returns>
/// <summary>
/// ResolveIpFromHostname method
/// </summary>
public static string ResolveIpFromHostname(string hostName)
{
try
@@ -154,7 +163,7 @@ namespace PepperDash.Essentials.Core.DeviceInfo
}
/// <summary>
/// Object to hold data about an arp entry
/// Represents a ArpEntry
/// </summary>
public class ArpEntry
{
@@ -182,7 +191,7 @@ namespace PepperDash.Essentials.Core.DeviceInfo
}
/// <summary>
/// Arguments passed by the ArpTableUpdated event
/// Represents a ArpTableEventArgs
/// </summary>
public class ArpTableEventArgs : EventArgs
{