diff --git a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
index 9b4ed772db..07ca2b58ba 100644
--- a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
+++ b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
@@ -1,25 +1,47 @@
-#pragma warning disable CS1591
-#pragma warning disable SA1600
-
using System;
using System.Collections.Generic;
namespace MediaBrowser.Common.Configuration
{
+ ///
+ /// Provides an interface to retrieve a configuration store. Classes with this interface are scanned for at
+ /// application start to dynamically register configuration for various modules/plugins.
+ ///
public interface IConfigurationFactory
{
+ ///
+ /// Get the configuration store for this module.
+ ///
+ /// The configuration store.
IEnumerable GetConfigurations();
}
+ ///
+ /// Describes a single entry in the application configuration.
+ ///
public class ConfigurationStore
{
+ ///
+ /// Gets or sets the unique identifier for the configuration.
+ ///
public string Key { get; set; }
+ ///
+ /// Gets or sets the type used to store the data for this configuration entry.
+ ///
public Type ConfigurationType { get; set; }
}
+ ///
+ /// A configuration store that can be validated.
+ ///
public interface IValidatingConfiguration
{
+ ///
+ /// Validation method to be invoked before saving the configuration.
+ ///
+ /// The old configuration.
+ /// The new configuration.
void Validate(object oldConfig, object newConfig);
}
}
diff --git a/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs b/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs
index e57929989a..1e8654c4dc 100644
--- a/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs
+++ b/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs
@@ -4,16 +4,22 @@ using System.Threading.Tasks;
namespace MediaBrowser.Controller.Plugins
{
///
- /// Interface IServerEntryPoint
+ /// Represents an entry point for a module in the application. This interface is scanned for automatically and
+ /// provides a hook to initialize the module at application start.
+ /// The entry point can additionally be flagged as a pre-startup task by implementing the
+ /// interface.
///
public interface IServerEntryPoint : IDisposable
{
///
- /// Runs this instance.
+ /// Run the initialization for this module. This method is invoked at application start.
///
Task RunAsync();
}
+ ///
+ /// Indicates that a should be invoked as a pre-startup task.
+ ///
public interface IRunBeforeStartup
{
diff --git a/MediaBrowser.Model/Services/ApiMemberAttribute.cs b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
index 7267fce247..8e50836f4d 100644
--- a/MediaBrowser.Model/Services/ApiMemberAttribute.cs
+++ b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
@@ -1,10 +1,10 @@
-#pragma warning disable CS1591
-#pragma warning disable SA1600
-
using System;
namespace MediaBrowser.Model.Services
{
+ ///
+ /// Identifies a single API endpoint.
+ ///
[AttributeUsage(AttributeTargets.Property, AllowMultiple = true, Inherited = true)]
public class ApiMemberAttribute : Attribute
{