pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-11 02:35:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add XML documentation to PepperDash.Core project

Browse Source 
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:48:23 +00:00
parent eeb0e84dc7
commit 260677a37f
59 changed files with 1072 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/PepperDash.Core/SystemInfo/EventArgs and Constants.cs
View File

@@ -71,6 +71,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Processor Change Event Args Class
/// </summary>
/// <summary>
/// Represents a ProcessorChangeEventArgs
/// </summary>
public class ProcessorChangeEventArgs : EventArgs
{
/// <summary>
@@ -117,6 +120,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Ethernet Change Event Args Class
/// </summary>
/// <summary>
/// Represents a EthernetChangeEventArgs
/// </summary>
public class EthernetChangeEventArgs : EventArgs
{
/// <summary>
@@ -168,6 +174,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Control Subnet Chage Event Args Class
/// </summary>
/// <summary>
/// Represents a ControlSubnetChangeEventArgs
/// </summary>
public class ControlSubnetChangeEventArgs : EventArgs
{
/// <summary>
@@ -214,6 +223,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Program Change Event Args Class
/// </summary>
/// <summary>
/// Represents a ProgramChangeEventArgs
/// </summary>
public class ProgramChangeEventArgs : EventArgs
{
/// <summary>

18
src/PepperDash.Core/SystemInfo/SystemInfoToSimpl.cs
View File

@@ -103,6 +103,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Gets the current ethernet info
/// </summary>
/// <summary>
/// GetEthernetInfo method
/// </summary>
public void GetEthernetInfo()
{
OnBoolChange(true, 0, SystemInfoConstants.BusyBoolChange);
@@ -164,6 +167,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Gets the current control subnet info
/// </summary>
/// <summary>
/// GetControlSubnetInfo method
/// </summary>
public void GetControlSubnetInfo()
{
OnBoolChange(true, 0, SystemInfoConstants.BusyBoolChange);
@@ -206,6 +212,9 @@ namespace PepperDash.Core.SystemInfo
/// Gets the program info by index
/// </summary>
/// <param name="index"></param>
/// <summary>
/// GetProgramInfoByIndex method
/// </summary>
public void GetProgramInfoByIndex(ushort index)
{
if (index < 1 || index > 10)
@@ -266,6 +275,9 @@ namespace PepperDash.Core.SystemInfo
/// <summary>
/// Gets the processor uptime and passes it to S+
/// </summary>
/// <summary>
/// RefreshProcessorUptime method
/// </summary>
public void RefreshProcessorUptime()
{
try
@@ -287,6 +299,9 @@ namespace PepperDash.Core.SystemInfo
/// Gets the program uptime, by index, and passes it to S+
/// </summary>
/// <param name="index"></param>
/// <summary>
/// RefreshProgramUptimeByIndex method
/// </summary>
public void RefreshProgramUptimeByIndex(int index)
{
try
@@ -308,6 +323,9 @@ namespace PepperDash.Core.SystemInfo
/// Sends command to console, passes response back using string change event
/// </summary>
/// <param name="cmd"></param>
/// <summary>
/// SendConsoleCommand method
/// </summary>
public void SendConsoleCommand(string cmd)
{
if (string.IsNullOrEmpty(cmd))