mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-01-24 01:45:07 +00:00
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:
@@ -68,8 +68,9 @@ namespace PepperDash.Essentials
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Entry point for the program
|
||||
/// InitializeSystem method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void InitializeSystem()
|
||||
{
|
||||
// If the control system is a DMPS type, we need to wait to exit this method until all devices have had time to activate
|
||||
@@ -165,9 +166,7 @@ namespace PepperDash.Essentials
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines if the program is running on a processor (appliance) or server (VC-4).
|
||||
///
|
||||
/// Sets Global.FilePathPrefix and Global.ApplicationDirectoryPathPrefix based on platform
|
||||
/// DeterminePlatform method
|
||||
/// </summary>
|
||||
public void DeterminePlatform()
|
||||
{
|
||||
@@ -252,7 +251,7 @@ namespace PepperDash.Essentials
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Begins the process of loading resources including plugins and configuration data
|
||||
/// GoWithLoad method
|
||||
/// </summary>
|
||||
public void GoWithLoad()
|
||||
{
|
||||
@@ -348,9 +347,9 @@ namespace PepperDash.Essentials
|
||||
return configExists;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
///
|
||||
/// </summary>
|
||||
/// <summary>
|
||||
/// TearDown method
|
||||
/// </summary>
|
||||
public void TearDown()
|
||||
{
|
||||
Debug.LogMessage(LogEventLevel.Information, "Tearing down existing system");
|
||||
@@ -386,7 +385,7 @@ namespace PepperDash.Essentials
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads all devices from config and adds them to DeviceManager
|
||||
/// LoadDevices method
|
||||
/// </summary>
|
||||
public void LoadDevices()
|
||||
{
|
||||
@@ -447,7 +446,7 @@ namespace PepperDash.Essentials
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Helper method to load tie lines. This should run after devices have loaded
|
||||
/// LoadTieLines method
|
||||
/// </summary>
|
||||
public void LoadTieLines()
|
||||
{
|
||||
@@ -473,7 +472,7 @@ namespace PepperDash.Essentials
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads all rooms from config and adds them to DeviceManager
|
||||
/// LoadRooms method
|
||||
/// </summary>
|
||||
public void LoadRooms()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user