From 42ffddc26932bcf2da762bf4fe1ec4bdc42e8166 Mon Sep 17 00:00:00 2001
From: Bond_009 <bond.009@outlook.com>
Date: Fri, 1 Nov 2019 18:38:54 +0100
Subject: Fix more warnings

---
 .../AppBase/BaseConfigurationManager.cs             | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs')

diff --git a/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs b/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
index 67bb25b07..f5ca8e144 100644
--- a/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
+++ b/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
@@ -84,6 +84,7 @@ namespace Emby.Server.Implementations.AppBase
         /// </summary>
         /// <value>The logger.</value>
         protected ILogger Logger { get; private set; }
+
         /// <summary>
         /// Gets the XML serializer.
         /// </summary>
@@ -131,6 +132,10 @@ namespace Emby.Server.Implementations.AppBase
             }
         }
 
+        /// <summary>
+        /// Adds parts.
+        /// </summary>
+        /// <param name="factories">The configuration factories.</param>
         public virtual void AddParts(IEnumerable<IConfigurationFactory> factories)
         {
             _configurationFactories = factories.ToArray();
@@ -223,7 +228,7 @@ namespace Emby.Server.Implementations.AppBase
         /// Replaces the cache path.
         /// </summary>
         /// <param name="newConfig">The new configuration.</param>
-        /// <exception cref="DirectoryNotFoundException"></exception>
+        /// <exception cref="DirectoryNotFoundException">The new cache path doesn't exist.</exception>
         private void ValidateCachePath(BaseApplicationConfiguration newConfig)
         {
             var newPath = newConfig.CachePath;
@@ -234,7 +239,7 @@ namespace Emby.Server.Implementations.AppBase
                 // Validate
                 if (!Directory.Exists(newPath))
                 {
-                    throw new FileNotFoundException(
+                    throw new DirectoryNotFoundException(
                         string.Format(
                             CultureInfo.InvariantCulture,
                             "{0} does not exist.",
@@ -245,6 +250,10 @@ namespace Emby.Server.Implementations.AppBase
             }
         }
 
+        /// <summary>
+        /// Ensures that we have write access to the path.
+        /// </summary>
+        /// <param name="path">The path.</param>
         protected void EnsureWriteAccess(string path)
         {
             var file = Path.Combine(path, Guid.NewGuid().ToString());
@@ -257,6 +266,7 @@ namespace Emby.Server.Implementations.AppBase
             return Path.Combine(CommonApplicationPaths.ConfigurationDirectoryPath, key.ToLowerInvariant() + ".xml");
         }
 
+        /// <inheritdoc />
         public object GetConfiguration(string key)
         {
             return _configurations.GetOrAdd(key, k =>
@@ -303,6 +313,7 @@ namespace Emby.Server.Implementations.AppBase
             }
         }
 
+        /// <inheritdoc />
         public void SaveConfiguration(string key, object configuration)
         {
             var configurationStore = GetConfigurationStore(key);
@@ -339,6 +350,11 @@ namespace Emby.Server.Implementations.AppBase
             OnNamedConfigurationUpdated(key, configuration);
         }
 
+        /// <summary>
+        /// Event handler for when a named configuration got updates.
+        /// </summary>
+        /// <param name="key">The key of the configuration.</param>
+        /// <param name="configuration">The old configuration.</param>
         protected virtual void OnNamedConfigurationUpdated(string key, object configuration)
         {
             NamedConfigurationUpdated?.Invoke(this, new ConfigurationUpdateEventArgs
@@ -348,6 +364,7 @@ namespace Emby.Server.Implementations.AppBase
             });
         }
 
+        /// <inheritdoc />
         public Type GetConfigurationType(string key)
         {
             return GetConfigurationStore(key)
-- 
cgit v1.2.3


From affb58ef9e11f7f14192c76074b1199604f6bd67 Mon Sep 17 00:00:00 2001
From: Bond-009 <bond.009@outlook.com>
Date: Tue, 10 Dec 2019 16:22:03 +0100
Subject: Apply suggestions from code review

Co-Authored-By: dkanada <dkanada@users.noreply.github.com>
---
 Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs   | 2 +-
 .../Configuration/ServerConfigurationManager.cs                   | 2 +-
 Emby.Server.Implementations/Data/BaseSqliteRepository.cs          | 2 +-
 Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs   | 2 +-
 Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs    | 8 ++++----
 Emby.Server.Implementations/EntryPoints/StartupWizard.cs          | 4 ++--
 Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs    | 2 +-
 Emby.Server.Implementations/HttpServer/HttpResultFactory.cs       | 2 +-
 Emby.Server.Implementations/HttpServer/StreamWriter.cs            | 2 +-
 Emby.Server.Implementations/HttpServer/WebSocketConnection.cs     | 6 +++---
 Emby.Server.Implementations/Library/UserManager.cs                | 2 +-
 .../Library/Validators/ArtistsValidator.cs                        | 4 ++--
 Emby.Server.Implementations/Library/Validators/GenresValidator.cs | 4 ++--
 .../Library/Validators/MusicGenresPostScanTask.cs                 | 2 +-
 .../Library/Validators/MusicGenresValidator.cs                    | 4 ++--
 .../Library/Validators/StudiosValidator.cs                        | 4 ++--
 16 files changed, 26 insertions(+), 26 deletions(-)

(limited to 'Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs')

diff --git a/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs b/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
index f5ca8e144..edf68cf7c 100644
--- a/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
+++ b/Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs
@@ -351,7 +351,7 @@ namespace Emby.Server.Implementations.AppBase
         }
 
         /// <summary>
-        /// Event handler for when a named configuration got updates.
+        /// Event handler for when a named configuration has been updated.
         /// </summary>
         /// <param name="key">The key of the configuration.</param>
         /// <param name="configuration">The old configuration.</param>
diff --git a/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs b/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs
index 4def7ca40..3d8d15d19 100644
--- a/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs
+++ b/Emby.Server.Implementations/Configuration/ServerConfigurationManager.cs
@@ -150,7 +150,7 @@ namespace Emby.Server.Implementations.Configuration
         }
 
         /// <summary>
-        /// Sets all config values to the optimal value.
+        /// Sets all configuration values to their optimal values.
         /// </summary>
         /// <returns>If the configuration changed.</returns>
         public bool SetOptimalValues()
diff --git a/Emby.Server.Implementations/Data/BaseSqliteRepository.cs b/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
index 30f29beee..0654132f4 100644
--- a/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
+++ b/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
@@ -16,7 +16,7 @@ namespace Emby.Server.Implementations.Data
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseSqliteRepository"/> class.
         /// </summary>
-        /// <param name="logger">The ogger.</param>
+        /// <param name="logger">The logger.</param>
         protected BaseSqliteRepository(ILogger logger)
         {
             Logger = logger;
diff --git a/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs b/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs
index 1ca25ba6f..f00996b5f 100644
--- a/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs
+++ b/Emby.Server.Implementations/EntryPoints/RefreshUsersMetadata.cs
@@ -18,7 +18,7 @@ namespace Emby.Server.Implementations.EntryPoints
         private readonly ILogger _logger;
 
         /// <summary>
-        /// The _user manager.
+        /// The user manager.
         /// </summary>
         private readonly IUserManager _userManager;
 
diff --git a/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs b/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs
index 9ccbf7535..e1dbb663b 100644
--- a/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs
+++ b/Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs
@@ -21,22 +21,22 @@ namespace Emby.Server.Implementations.EntryPoints
     public class ServerEventNotifier : IServerEntryPoint
     {
         /// <summary>
-        /// The _user manager.
+        /// The user manager.
         /// </summary>
         private readonly IUserManager _userManager;
 
         /// <summary>
-        /// The _installation manager.
+        /// The installation manager.
         /// </summary>
         private readonly IInstallationManager _installationManager;
 
         /// <summary>
-        /// The _kernel.
+        /// The kernel.
         /// </summary>
         private readonly IServerApplicationHost _appHost;
 
         /// <summary>
-        /// The _task manager.
+        /// The task manager.
         /// </summary>
         private readonly ITaskManager _taskManager;
 
diff --git a/Emby.Server.Implementations/EntryPoints/StartupWizard.cs b/Emby.Server.Implementations/EntryPoints/StartupWizard.cs
index 9cef77dc8..161788c63 100644
--- a/Emby.Server.Implementations/EntryPoints/StartupWizard.cs
+++ b/Emby.Server.Implementations/EntryPoints/StartupWizard.cs
@@ -13,12 +13,12 @@ namespace Emby.Server.Implementations.EntryPoints
     public class StartupWizard : IServerEntryPoint
     {
         /// <summary>
-        /// The _app host.
+        /// The app host.
         /// </summary>
         private readonly IServerApplicationHost _appHost;
 
         /// <summary>
-        /// The _user manager.
+        /// The user manager.
         /// </summary>
         private readonly ILogger _logger;
 
diff --git a/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs b/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
index 24ac6d1fd..9ee219854 100644
--- a/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
+++ b/Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
@@ -20,7 +20,7 @@ namespace Emby.Server.Implementations.EntryPoints
         public const int PortNumber = 7359;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly ISocketFactory _socketFactory;
diff --git a/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs b/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
index f9eb3a897..a62b4e7af 100644
--- a/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
+++ b/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
@@ -29,7 +29,7 @@ namespace Emby.Server.Implementations.HttpServer
     public class HttpResultFactory : IHttpResultFactory
     {
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly IFileSystem _fileSystem;
diff --git a/Emby.Server.Implementations/HttpServer/StreamWriter.cs b/Emby.Server.Implementations/HttpServer/StreamWriter.cs
index eda236028..5afc51dbc 100644
--- a/Emby.Server.Implementations/HttpServer/StreamWriter.cs
+++ b/Emby.Server.Implementations/HttpServer/StreamWriter.cs
@@ -15,7 +15,7 @@ namespace Emby.Server.Implementations.HttpServer
     public class StreamWriter : IAsyncStreamWriter, IHasHeaders
     {
         /// <summary>
-        /// The _options.
+        /// The options.
         /// </summary>
         private readonly IDictionary<string, string> _options = new Dictionary<string, string>();
 
diff --git a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
index 5d657b8a7..2292d86a4 100644
--- a/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
+++ b/Emby.Server.Implementations/HttpServer/WebSocketConnection.cs
@@ -24,12 +24,12 @@ namespace Emby.Server.Implementations.HttpServer
         private readonly ILogger _logger;
 
         /// <summary>
-        /// The _json serializer.
+        /// The json serializer.
         /// </summary>
         private readonly IJsonSerializer _jsonSerializer;
 
         /// <summary>
-        /// The _socket.
+        /// The socket.
         /// </summary>
         private readonly IWebSocket _socket;
 
@@ -78,7 +78,7 @@ namespace Emby.Server.Implementations.HttpServer
         public event EventHandler<EventArgs> Closed;
 
         /// <summary>
-        /// Gets or sets the _remote end point.
+        /// Gets or sets the remote end point.
         /// </summary>
         public string RemoteEndPoint { get; private set; }
 
diff --git a/Emby.Server.Implementations/Library/UserManager.cs b/Emby.Server.Implementations/Library/UserManager.cs
index 1233dcc43..eaad05f92 100644
--- a/Emby.Server.Implementations/Library/UserManager.cs
+++ b/Emby.Server.Implementations/Library/UserManager.cs
@@ -43,7 +43,7 @@ namespace Emby.Server.Implementations.Library
     public class UserManager : IUserManager
     {
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
diff --git a/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs b/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs
index dbadaeefb..1497f4a3a 100644
--- a/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/ArtistsValidator.cs
@@ -17,12 +17,12 @@ namespace Emby.Server.Implementations.Library.Validators
     public class ArtistsValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly IItemRepository _itemRepo;
diff --git a/Emby.Server.Implementations/Library/Validators/GenresValidator.cs b/Emby.Server.Implementations/Library/Validators/GenresValidator.cs
index 6478f1873..b0cd5f87a 100644
--- a/Emby.Server.Implementations/Library/Validators/GenresValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/GenresValidator.cs
@@ -13,13 +13,13 @@ namespace Emby.Server.Implementations.Library.Validators
     public class GenresValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
         private readonly IItemRepository _itemRepo;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
diff --git a/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs b/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs
index 1b5c83f1e..58549e9d7 100644
--- a/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs
+++ b/Emby.Server.Implementations/Library/Validators/MusicGenresPostScanTask.cs
@@ -13,7 +13,7 @@ namespace Emby.Server.Implementations.Library.Validators
     public class MusicGenresPostScanTask : ILibraryPostScanTask
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
         private readonly ILogger _logger;
diff --git a/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs b/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs
index 23a28e936..5ee4ca72e 100644
--- a/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/MusicGenresValidator.cs
@@ -13,12 +13,12 @@ namespace Emby.Server.Implementations.Library.Validators
     public class MusicGenresValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
         private readonly IItemRepository _itemRepo;
diff --git a/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs b/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs
index 887eef5c3..15e7a0dbb 100644
--- a/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs
+++ b/Emby.Server.Implementations/Library/Validators/StudiosValidator.cs
@@ -15,14 +15,14 @@ namespace Emby.Server.Implementations.Library.Validators
     public class StudiosValidator
     {
         /// <summary>
-        /// The _library manager.
+        /// The library manager.
         /// </summary>
         private readonly ILibraryManager _libraryManager;
 
         private readonly IItemRepository _itemRepo;
 
         /// <summary>
-        /// The _logger.
+        /// The logger.
         /// </summary>
         private readonly ILogger _logger;
 
-- 
cgit v1.2.3