mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-08-31 19:08:29 +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
|
|
@ -22,6 +22,10 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public string Description { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constructor for CrestronGlobalSecretsProvider
|
||||
/// </summary>
|
||||
/// <param name="key">The key for the secret provider</param>
|
||||
public CrestronGlobalSecretsProvider(string key)
|
||||
{
|
||||
Key = key;
|
||||
|
|
|
|||
|
|
@ -23,7 +23,10 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public string Description { get; private set; }
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Constructor for CrestronLocalSecretsProvider
|
||||
/// </summary>
|
||||
/// <param name="key">The key for the secret provider</param>
|
||||
public CrestronLocalSecretsProvider(string key)
|
||||
{
|
||||
Key = key;
|
||||
|
|
|
|||
|
|
@ -11,11 +11,27 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public class CrestronSecret : ISecret
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the Provider
|
||||
/// </summary>
|
||||
public ISecretProvider Provider { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Key
|
||||
/// </summary>
|
||||
public string Key { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Value
|
||||
/// </summary>
|
||||
public object Value { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constructor for CrestronSecret
|
||||
/// </summary>
|
||||
/// <param name="key">key for the secret</param>
|
||||
/// <param name="value">value of the secret</param>
|
||||
/// <param name="provider">provider of the secret</param>
|
||||
public CrestronSecret(string key, string value, ISecretProvider provider)
|
||||
{
|
||||
Key = key;
|
||||
|
|
|
|||
|
|
@ -7,8 +7,14 @@ using Serilog.Events;
|
|||
|
||||
namespace PepperDash.Essentials.Core
|
||||
{
|
||||
/// <summary>
|
||||
/// SecretsManager static class
|
||||
/// </summary>
|
||||
public static class SecretsManager
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the Secrets dictionary
|
||||
/// </summary>
|
||||
public static Dictionary<string, ISecretProvider> Secrets { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
|
|
|
|||
|
|
@ -14,8 +14,15 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public class SecretsPropertiesConfig
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the Provider
|
||||
/// </summary>
|
||||
[JsonProperty("provider")]
|
||||
public string Provider { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the Key
|
||||
/// </summary>
|
||||
[JsonProperty("key")]
|
||||
public string Key { get; set; }
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue