Fix doc releated warnings

Emby.Server.Implementations/AppBase/BaseApplicationPaths.cs

@@ -10,6 +10,8 @@ namespace Emby.Server.Implementations.AppBase
     /// </summary>
     public abstract class BaseApplicationPaths : IApplicationPaths
     {
+        private string _dataPath;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseApplicationPaths"/> class.
         /// </summary>
@@ -30,27 +32,27 @@ namespace Emby.Server.Implementations.AppBase
         }
 
         /// <summary>
-        /// Gets the path to the program data folder
+        /// Gets the path to the program data folder.
         /// </summary>
         /// <value>The program data path.</value>
-        public string ProgramDataPath { get; private set; }
+        public string ProgramDataPath { get; }
 
         /// <summary>
-        /// Gets the path to the web UI resources folder
+        /// Gets the path to the web UI resources folder.
         /// </summary>
         /// <value>The web UI resources path.</value>
-        public string WebPath { get; set; }
+        public string WebPath { get; }
 
         /// <summary>
-        /// Gets the path to the system folder
+        /// Gets the path to the system folder.
         /// </summary>
+        /// <value>The path to the system folder.</value>
         public string ProgramSystemPath { get; } = AppContext.BaseDirectory;
 
         /// <summary>
-        /// Gets the folder path to the data directory
+        /// Gets the folder path to the data directory.
         /// </summary>
         /// <value>The data directory.</value>
-        private string _dataPath;
         public string DataPath
         {
             get => _dataPath;
@@ -58,8 +60,9 @@ namespace Emby.Server.Implementations.AppBase
         }
 
         /// <summary>
-        /// Gets the magic strings used for virtual path manipulation.
+        /// Gets the magic string used for virtual path manipulation.
         /// </summary>
+        /// <value>The magic string used for virtual path manipulation.</value>
         public string VirtualDataPath { get; } = "%AppDataPath%";
 
         /// <summary>
@@ -69,43 +72,43 @@ namespace Emby.Server.Implementations.AppBase
         public string ImageCachePath => Path.Combine(CachePath, "images");
 
         /// <summary>
-        /// Gets the path to the plugin directory
+        /// Gets the path to the plugin directory.
         /// </summary>
         /// <value>The plugins path.</value>
         public string PluginsPath => Path.Combine(ProgramDataPath, "plugins");
 
         /// <summary>
-        /// Gets the path to the plugin configurations directory
+        /// Gets the path to the plugin configurations directory.
         /// </summary>
         /// <value>The plugin configurations path.</value>
         public string PluginConfigurationsPath => Path.Combine(PluginsPath, "configurations");
 
         /// <summary>
-        /// Gets the path to the log directory
+        /// Gets the path to the log directory.
         /// </summary>
         /// <value>The log directory path.</value>
-        public string LogDirectoryPath { get; private set; }
+        public string LogDirectoryPath { get; }
 
         /// <summary>
-        /// Gets the path to the application configuration root directory
+        /// Gets the path to the application configuration root directory.
         /// </summary>
         /// <value>The configuration directory path.</value>
-        public string ConfigurationDirectoryPath { get; private set; }
+        public string ConfigurationDirectoryPath { get; }
 
         /// <summary>
-        /// Gets the path to the system configuration file
+        /// Gets the path to the system configuration file.
         /// </summary>
         /// <value>The system configuration file path.</value>
         public string SystemConfigurationFilePath => Path.Combine(ConfigurationDirectoryPath, "system.xml");
 
         /// <summary>
-        /// Gets the folder path to the cache directory
+        /// Gets or sets the folder path to the cache directory.
         /// </summary>
         /// <value>The cache directory.</value>
         public string CachePath { get; set; }
 
         /// <summary>
-        /// Gets the folder path to the temp directory within the cache folder
+        /// Gets the folder path to the temp directory within the cache folder.
         /// </summary>
         /// <value>The temp directory.</value>
         public string TempDirectory => Path.Combine(CachePath, "temp");

Emby.Server.Implementations/AppBase/BaseConfigurationManager.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Threading;
@@ -19,11 +20,44 @@ namespace Emby.Server.Implementations.AppBase
     /// </summary>
     public abstract class BaseConfigurationManager : IConfigurationManager
     {
+        private readonly IFileSystem _fileSystem;
+
+        private readonly ConcurrentDictionary<string, object> _configurations = new ConcurrentDictionary<string, object>();
+
+        private ConfigurationStore[] _configurationStores = Array.Empty<ConfigurationStore>();
+        private IConfigurationFactory[] _configurationFactories = Array.Empty<IConfigurationFactory>();
+
         /// <summary>
-        /// Gets the type of the configuration.
+        /// The _configuration loaded.
         /// </summary>
-        /// <value>The type of the configuration.</value>
-        protected abstract Type ConfigurationType { get; }
+        private bool _configurationLoaded;
+
+        /// <summary>
+        /// The _configuration sync lock.
+        /// </summary>
+        private object _configurationSyncLock = new object();
+
+        /// <summary>
+        /// The _configuration.
+        /// </summary>
+        private BaseApplicationConfiguration _configuration;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BaseConfigurationManager" /> class.
+        /// </summary>
+        /// <param name="applicationPaths">The application paths.</param>
+        /// <param name="loggerFactory">The logger factory.</param>
+        /// <param name="xmlSerializer">The XML serializer.</param>
+        /// <param name="fileSystem">The file system</param>
+        protected BaseConfigurationManager(IApplicationPaths applicationPaths, ILoggerFactory loggerFactory, IXmlSerializer xmlSerializer, IFileSystem fileSystem)
+        {
+            CommonApplicationPaths = applicationPaths;
+            XmlSerializer = xmlSerializer;
+            _fileSystem = fileSystem;
+            Logger = loggerFactory.CreateLogger(GetType().Name);
+
+            UpdateCachePath();
+        }
 
         /// <summary>
         /// Occurs when [configuration updated].
@@ -40,6 +74,12 @@ namespace Emby.Server.Implementations.AppBase
         /// </summary>
         public event EventHandler<ConfigurationUpdateEventArgs> NamedConfigurationUpdated;
 
+        /// <summary>
+        /// Gets the type of the configuration.
+        /// </summary>
+        /// <value>The type of the configuration.</value>
+        protected abstract Type ConfigurationType { get; }
+
         /// <summary>
         /// Gets the logger.
         /// </summary>
@@ -56,20 +96,7 @@ namespace Emby.Server.Implementations.AppBase
         /// </summary>
         /// <value>The application paths.</value>
         public IApplicationPaths CommonApplicationPaths { get; private set; }
-        public readonly IFileSystem FileSystem;
 
-        /// <summary>
-        /// The _configuration loaded
-        /// </summary>
-        private bool _configurationLoaded;
-        /// <summary>
-        /// The _configuration sync lock
-        /// </summary>
-        private object _configurationSyncLock = new object();
-        /// <summary>
-        /// The _configuration
-        /// </summary>
-        private BaseApplicationConfiguration _configuration;
         /// <summary>
         /// Gets the system configuration
         /// </summary>
@@ -90,26 +117,6 @@ namespace Emby.Server.Implementations.AppBase
             }
         }
 
-        private ConfigurationStore[] _configurationStores = { };
-        private IConfigurationFactory[] _configurationFactories = { };
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="BaseConfigurationManager" /> class.
-        /// </summary>
-        /// <param name="applicationPaths">The application paths.</param>
-        /// <param name="loggerFactory">The logger factory.</param>
-        /// <param name="xmlSerializer">The XML serializer.</param>
-        /// <param name="fileSystem">The file system</param>
-        protected BaseConfigurationManager(IApplicationPaths applicationPaths, ILoggerFactory loggerFactory, IXmlSerializer xmlSerializer, IFileSystem fileSystem)
-        {
-            CommonApplicationPaths = applicationPaths;
-            XmlSerializer = xmlSerializer;
-            FileSystem = fileSystem;
-            Logger = loggerFactory.CreateLogger(GetType().Name);
-
-            UpdateCachePath();
-        }
-
         public virtual void AddParts(IEnumerable<IConfigurationFactory> factories)
         {
             _configurationFactories = factories.ToArray();
@@ -171,6 +178,7 @@ namespace Emby.Server.Implementations.AppBase
         private void UpdateCachePath()
         {
             string cachePath;
+
             // If the configuration file has no entry (i.e. not set in UI)
             if (string.IsNullOrWhiteSpace(CommonConfiguration.CachePath))
             {
@@ -207,12 +215,16 @@ namespace Emby.Server.Implementations.AppBase
             var newPath = newConfig.CachePath;
 
             if (!string.IsNullOrWhiteSpace(newPath)
-                && !string.Equals(CommonConfiguration.CachePath ?? string.Empty, newPath))
+                && !string.Equals(CommonConfiguration.CachePath ?? string.Empty, newPath, StringComparison.Ordinal))
             {
                 // Validate
                 if (!Directory.Exists(newPath))
                 {
-                    throw new FileNotFoundException(string.Format("{0} does not exist.", newPath));
+                    throw new FileNotFoundException(
+                        string.Format(
+                            CultureInfo.InvariantCulture,
+                            "{0} does not exist.",
+                            newPath));
                 }
 
                 EnsureWriteAccess(newPath);
@@ -223,11 +235,9 @@ namespace Emby.Server.Implementations.AppBase
         {
             var file = Path.Combine(path, Guid.NewGuid().ToString());
             File.WriteAllText(file, string.Empty);
-            FileSystem.DeleteFile(file);
+            _fileSystem.DeleteFile(file);
         }
 
-        private readonly ConcurrentDictionary<string, object> _configurations = new ConcurrentDictionary<string, object>();
-
         private string GetConfigurationFile(string key)
         {
             return Path.Combine(CommonApplicationPaths.ConfigurationDirectoryPath, key.ToLowerInvariant() + ".xml");

Emby.Server.Implementations/ApplicationHost.cs

@@ -418,7 +418,7 @@ namespace Emby.Server.Implementations
         public string ApplicationVersion { get; } = typeof(ApplicationHost).Assembly.GetName().Version.ToString(3);
 
         /// <summary>
-        /// Gets the current application user agent
+        /// Gets the current application user agent.
         /// </summary>
         /// <value>The application user agent.</value>
         public string ApplicationUserAgent => Name.Replace(' ', '-') + "/" + ApplicationVersion;
@@ -467,8 +467,8 @@ namespace Emby.Server.Implementations
         /// <summary>
         /// Creates an instance of type and resolves all constructor dependencies
         /// </summary>
-        /// /// <typeparam name="T">The type</typeparam>
-        /// <returns>T</returns>
+        /// /// <typeparam name="T">The type.</typeparam>
+        /// <returns>T.</returns>
         public T CreateInstance<T>()
             => ActivatorUtilities.CreateInstance<T>(_serviceProvider);
 

Emby.Server.Implementations/ConfigurationOptions.cs

@@ -6,8 +6,8 @@ namespace Emby.Server.Implementations
     {
         public static readonly Dictionary<string, string> Configuration = new Dictionary<string, string>
         {
-            {"HttpListenerHost:DefaultRedirectPath", "web/index.html"},
-            {"MusicBrainz:BaseUrl", "https://www.musicbrainz.org"}
+            { "HttpListenerHost:DefaultRedirectPath", "web/index.html" },
+            { "MusicBrainz:BaseUrl", "https://www.musicbrainz.org" }
         };
     }
 }

Emby.Server.Implementations/Emby.Server.Implementations.csproj

@@ -44,6 +44,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">

Emby.Server.Implementations/ServerApplicationPaths.cs

@@ -10,8 +10,12 @@ namespace Emby.Server.Implementations
     /// </summary>
     public class ServerApplicationPaths : BaseApplicationPaths, IServerApplicationPaths
     {
+        private string _defaultTranscodingTempPath;
+        private string _transcodingTempPath;
+        private string _internalMetadataPath;
+
         /// <summary>
-        /// Initializes a new instance of the <see cref="BaseApplicationPaths" /> class.
+        /// Initializes a new instance of the <see cref="ServerApplicationPaths" /> class.
         /// </summary>
         public ServerApplicationPaths(
             string programDataPath,
@@ -30,7 +34,7 @@ namespace Emby.Server.Implementations
         public string ApplicationResourcesPath { get; } = AppContext.BaseDirectory;
 
         /// <summary>
-        /// Gets the path to the base root media directory
+        /// Gets the path to the base root media directory.
         /// </summary>
         /// <value>The root folder path.</value>
         public string RootFolderPath => Path.Combine(ProgramDataPath, "root");
@@ -48,7 +52,7 @@ namespace Emby.Server.Implementations
         public string LocalizationPath => Path.Combine(ProgramDataPath, "localization");
 
         /// <summary>
-        /// Gets the path to the People directory
+        /// Gets the path to the People directory.
         /// </summary>
         /// <value>The people path.</value>
         public string PeoplePath => Path.Combine(InternalMetadataPath, "People");
@@ -56,37 +60,37 @@ namespace Emby.Server.Implementations
         public string ArtistsPath => Path.Combine(InternalMetadataPath, "artists");
 
         /// <summary>
-        /// Gets the path to the Genre directory
+        /// Gets the path to the Genre directory.
         /// </summary>
         /// <value>The genre path.</value>
         public string GenrePath => Path.Combine(InternalMetadataPath, "Genre");
 
         /// <summary>
-        /// Gets the path to the Genre directory
+        /// Gets the path to the Genre directory.
         /// </summary>
         /// <value>The genre path.</value>
         public string MusicGenrePath => Path.Combine(InternalMetadataPath, "MusicGenre");
 
         /// <summary>
-        /// Gets the path to the Studio directory
+        /// Gets the path to the Studio directory.
         /// </summary>
         /// <value>The studio path.</value>
         public string StudioPath => Path.Combine(InternalMetadataPath, "Studio");
 
         /// <summary>
-        /// Gets the path to the Year directory
+        /// Gets the path to the Year directory.
         /// </summary>
         /// <value>The year path.</value>
         public string YearPath => Path.Combine(InternalMetadataPath, "Year");
 
         /// <summary>
-        /// Gets the path to the General IBN directory
+        /// Gets the path to the General IBN directory.
         /// </summary>
         /// <value>The general path.</value>
         public string GeneralPath => Path.Combine(InternalMetadataPath, "general");
 
         /// <summary>
-        /// Gets the path to the Ratings IBN directory
+        /// Gets the path to the Ratings IBN directory.
         /// </summary>
         /// <value>The ratings path.</value>
         public string RatingsPath => Path.Combine(InternalMetadataPath, "ratings");
@@ -98,15 +102,13 @@ namespace Emby.Server.Implementations
         public string MediaInfoImagesPath => Path.Combine(InternalMetadataPath, "mediainfo");
 
         /// <summary>
-        /// Gets the path to the user configuration directory
+        /// Gets the path to the user configuration directory.
         /// </summary>
         /// <value>The user configuration directory path.</value>
         public string UserConfigurationDirectoryPath => Path.Combine(ConfigurationDirectoryPath, "users");
 
-        private string _defaultTranscodingTempPath;
         public string DefaultTranscodingTempPath => _defaultTranscodingTempPath ?? (_defaultTranscodingTempPath = Path.Combine(ProgramDataPath, "transcoding-temp"));
 
-        private string _transcodingTempPath;
         public string TranscodingTempPath
         {
             get => _transcodingTempPath ?? (_transcodingTempPath = DefaultTranscodingTempPath);
@@ -139,7 +141,6 @@ namespace Emby.Server.Implementations
             return path;
         }
 
-        private string _internalMetadataPath;
         public string InternalMetadataPath
         {
             get => _internalMetadataPath ?? (_internalMetadataPath = Path.Combine(DataPath, "metadata"));