Add XML documentation

This commit is contained in:
ConfusedPolarBear 2020-06-08 17:14:20 -05:00
parent 0d6a63bf84
commit 001c78573e
2 changed files with 24 additions and 4 deletions

View File

@ -1,20 +1,33 @@
#pragma warning disable CS1591
using System.Collections.Generic; using System.Collections.Generic;
using MediaBrowser.Common.Configuration; using MediaBrowser.Common.Configuration;
namespace Emby.Server.Implementations.QuickConnect namespace Emby.Server.Implementations.QuickConnect
{ {
/// <summary>
/// Configuration extension to support persistent quick connect configuration
/// </summary>
public static class ConfigurationExtension public static class ConfigurationExtension
{ {
/// <summary>
/// Return the current quick connect configuration
/// </summary>
/// <param name="manager">Configuration manager</param>
/// <returns></returns>
public static QuickConnectConfiguration GetQuickConnectConfiguration(this IConfigurationManager manager) public static QuickConnectConfiguration GetQuickConnectConfiguration(this IConfigurationManager manager)
{ {
return manager.GetConfiguration<QuickConnectConfiguration>("quickconnect"); return manager.GetConfiguration<QuickConnectConfiguration>("quickconnect");
} }
} }
/// <summary>
/// Configuration factory for quick connect
/// </summary>
public class QuickConnectConfigurationFactory : IConfigurationFactory public class QuickConnectConfigurationFactory : IConfigurationFactory
{ {
/// <summary>
/// Returns the current quick connect configuration
/// </summary>
/// <returns></returns>
public IEnumerable<ConfigurationStore> GetConfigurations() public IEnumerable<ConfigurationStore> GetConfigurations()
{ {
return new ConfigurationStore[] return new ConfigurationStore[]

View File

@ -1,15 +1,22 @@
#pragma warning disable CS1591
using MediaBrowser.Model.QuickConnect; using MediaBrowser.Model.QuickConnect;
namespace Emby.Server.Implementations.QuickConnect namespace Emby.Server.Implementations.QuickConnect
{ {
/// <summary>
/// Persistent quick connect configuration
/// </summary>
public class QuickConnectConfiguration public class QuickConnectConfiguration
{ {
/// <summary>
/// Quick connect configuration object
/// </summary>
public QuickConnectConfiguration() public QuickConnectConfiguration()
{ {
} }
/// <summary>
/// Persistent quick connect availability state
/// </summary>
public QuickConnectState State { get; set; } public QuickConnectState State { get; set; }
} }
} }