diff options
| author | Bond-009 <bond.009@outlook.com> | 2020-02-12 20:43:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-12 20:43:51 +0100 |
| commit | 64800de29da43aa74c2925d2a10b1f626b8c2eae (patch) | |
| tree | 621bc43b5b979777c93d9039361c0bee40ddfb09 /MediaBrowser.Controller/Plugins/IServerEntryPoint.cs | |
| parent | e241f83ff12aa2231443b78d39d1db2646aebdf9 (diff) | |
| parent | 8ffb073ccb7f6661c04e64836d90d86228937962 (diff) | |
Merge pull request #2394 from mark-monteiro/xml-documentation
Add Some XML Documentation
Diffstat (limited to 'MediaBrowser.Controller/Plugins/IServerEntryPoint.cs')
| -rw-r--r-- | MediaBrowser.Controller/Plugins/IServerEntryPoint.cs | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs b/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs index e57929989..1e8654c4d 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 { /// <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 { |
