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

@ -7,10 +7,19 @@ using Serilog.Events;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a CrestronGlobalSecretsProvider
/// </summary>
public class CrestronGlobalSecretsProvider : ISecretProvider
{
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; set; }
//Added for reference
/// <summary>
/// Gets or sets the Description
/// </summary>
public string Description { get; private set; }
public CrestronGlobalSecretsProvider(string key)
@ -71,6 +80,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key">Secret Key</param>
/// <returns>ISecret Object containing key, provider, and value</returns>
/// <summary>
/// GetSecret method
/// </summary>
public ISecret GetSecret(string key)
{
string mySecret;
@ -93,6 +105,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key">Secret Key</param>
/// <returns>bool if present</returns>
/// <summary>
/// TestSecret method
/// </summary>
public bool TestSecret(string key)
{
string mySecret;

View file

@ -8,10 +8,19 @@ using Serilog.Events;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a CrestronLocalSecretsProvider
/// </summary>
public class CrestronLocalSecretsProvider : ISecretProvider
{
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; set; }
//Added for reference
/// <summary>
/// Gets or sets the Description
/// </summary>
public string Description { get; private set; }
@ -72,6 +81,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key">Secret Key</param>
/// <returns>ISecret Object containing key, provider, and value</returns>
/// <summary>
/// GetSecret method
/// </summary>
public ISecret GetSecret(string key)
{
string mySecret;
@ -94,6 +106,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key">Secret Key</param>
/// <returns>bool if present</returns>
/// <summary>
/// TestSecret method
/// </summary>
public bool TestSecret(string key)
{
string mySecret;

View file

@ -3,7 +3,7 @@
namespace PepperDash.Essentials.Core
{
/// <summary>
/// All ISecrecretProvider classes must implement this interface.
/// Defines the contract for ISecretProvider
/// </summary>
public interface ISecretProvider : IKeyed
{

View file

@ -12,7 +12,7 @@ namespace PepperDash.Essentials.Core
public static Dictionary<string, ISecretProvider> Secrets { get; private set; }
/// <summary>
/// Initialize the SecretsManager
/// Initialize method
/// </summary>
public static void Initialize()
{
@ -52,6 +52,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key">Dictionary Key for provider</param>
/// <returns>ISecretProvider</returns>
/// <summary>
/// GetSecretProviderByKey method
/// </summary>
public static ISecretProvider GetSecretProviderByKey(string key)
{
ISecretProvider secret;
@ -65,6 +68,9 @@ namespace PepperDash.Essentials.Core
return secret;
}
/// <summary>
/// GetProviderInfo method
/// </summary>
public static void GetProviderInfo(string cmd)
{
string response;
@ -104,6 +110,9 @@ namespace PepperDash.Essentials.Core
/// Console Command that returns all valid secrets in the essentials program.
/// </summary>
/// <param name="cmd"></param>
/// <summary>
/// ListProviders method
/// </summary>
public static void ListProviders(string cmd)
{
var response = String.Empty;
@ -143,6 +152,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key">Key of new entry</param>
/// <param name="provider">New Provider Entry</param>
/// <summary>
/// AddSecretProvider method
/// </summary>
public static void AddSecretProvider(string key, ISecretProvider provider)
{
if (!Secrets.ContainsKey(key))
@ -160,6 +172,9 @@ namespace PepperDash.Essentials.Core
/// <param name="key">Key of new entry</param>
/// <param name="provider">New provider entry</param>
/// <param name="overwrite">true to overwrite any existing providers in the dictionary</param>
/// <summary>
/// AddSecretProvider method
/// </summary>
public static void AddSecretProvider(string key, ISecretProvider provider, bool overwrite)
{
if (!Secrets.ContainsKey(key))