Merge pull request #2394 from mark-monteiro/xml-documentation

Add Some XML Documentation
This commit is contained in:
Bond-009
2020-02-12 20:43:51 +01:00
committed by GitHub
3 changed files with 36 additions and 8 deletions

View File

@@ -4,16 +4,22 @@ using System.Threading.Tasks;
namespace MediaBrowser.Controller.Plugins
{
/// <summary>
/// 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
/// <see cref="IRunBeforeStartup"/> interface.
/// </summary>
public interface IServerEntryPoint : IDisposable
{
/// <summary>
/// Runs this instance.
/// Run the initialization for this module. This method is invoked at application start.
/// </summary>
Task RunAsync();
}
/// <summary>
/// Indicates that a <see cref="IServerEntryPoint"/> should be invoked as a pre-startup task.
/// </summary>
public interface IRunBeforeStartup
{