瀏覽代碼

Doc improvements

Bond-009 5 年之前
父節點
當前提交
126165080b

+ 10 - 11
Emby.Server.Implementations/Updates/InstallationManager.cs

@@ -50,12 +50,12 @@ namespace Emby.Server.Implementations.Updates
         /// <summary>
         /// <summary>
         /// The current installations.
         /// The current installations.
         /// </summary>
         /// </summary>
-        private List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations;
+        private readonly List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations;
 
 
         /// <summary>
         /// <summary>
         /// The completed installations.
         /// The completed installations.
         /// </summary>
         /// </summary>
-        private ConcurrentBag<InstallationInfo> _completedInstallationsInternal;
+        private readonly ConcurrentBag<InstallationInfo> _completedInstallationsInternal;
 
 
         public InstallationManager(
         public InstallationManager(
             ILogger<InstallationManager> logger,
             ILogger<InstallationManager> logger,
@@ -85,29 +85,28 @@ namespace Emby.Server.Implementations.Updates
             _zipClient = zipClient;
             _zipClient = zipClient;
         }
         }
 
 
+        /// <inheritdoc />
         public event EventHandler<InstallationEventArgs> PackageInstalling;
         public event EventHandler<InstallationEventArgs> PackageInstalling;
 
 
+        /// <inheritdoc />
         public event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
         public event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
 
 
+        /// <inheritdoc />
         public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
         public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
 
 
+        /// <inheritdoc />
         public event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
         public event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
 
 
-        /// <summary>
-        /// Occurs when a plugin is uninstalled.
-        /// </summary>
+        /// <inheritdoc />
         public event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
         public event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
 
 
-        /// <summary>
-        /// Occurs when a plugin plugin is updated.
-        /// </summary>
+        /// <inheritdoc />
         public event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated;
         public event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated;
 
 
-        /// <summary>
-        /// Occurs when a plugin plugin is installed.
-        /// </summary>
+        /// <inheritdoc />
         public event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
         public event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
 
 
+        /// <inheritdoc />
         public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal;
         public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal;
 
 
         /// <inheritdoc />
         /// <inheritdoc />

+ 7 - 4
MediaBrowser.Common/Updates/IInstallationManager.cs

@@ -13,27 +13,30 @@ namespace MediaBrowser.Common.Updates
     public interface IInstallationManager : IDisposable
     public interface IInstallationManager : IDisposable
     {
     {
         event EventHandler<InstallationEventArgs> PackageInstalling;
         event EventHandler<InstallationEventArgs> PackageInstalling;
+
         event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
         event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
+
         event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
         event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
+
         event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
         event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
 
 
         /// <summary>
         /// <summary>
-        /// Occurs when [plugin uninstalled].
+        /// Occurs when a plugin is uninstalled.
         /// </summary>
         /// </summary>
         event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
         event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
 
 
         /// <summary>
         /// <summary>
-        /// Occurs when [plugin updated].
+        /// Occurs when a plugin is updated.
         /// </summary>
         /// </summary>
         event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated;
         event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated;
 
 
         /// <summary>
         /// <summary>
-        /// Occurs when [plugin updated].
+        /// Occurs when a plugin is installed.
         /// </summary>
         /// </summary>
         event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
         event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
 
 
         /// <summary>
         /// <summary>
-        /// The completed installations
+        /// Gets the completed installations
         /// </summary>
         /// </summary>
         IEnumerable<InstallationInfo> CompletedInstallations { get; }
         IEnumerable<InstallationInfo> CompletedInstallations { get; }