From 4b1654ae3bb2977e1ec1978a3ea07d6f2e96b477 Mon Sep 17 00:00:00 2001
From: Shadowghost <Ghost_of_Stone@web.de>
Date: Fri, 15 Apr 2022 20:10:37 +0200
Subject: [PATCH] Add xmldocs for studio image provider

---
 .../Configuration/PluginConfiguration.cs      | 10 ++++---
 .../Plugins/StudioImages/Plugin.cs            | 24 ++++++++++++++++-
 .../StudioImages/StudiosImageProvider.cs      | 27 +++++++++++++++++--
 3 files changed, 55 insertions(+), 6 deletions(-)

diff --git a/MediaBrowser.Providers/Plugins/StudioImages/Configuration/PluginConfiguration.cs b/MediaBrowser.Providers/Plugins/StudioImages/Configuration/PluginConfiguration.cs
index cb422ef3d6..0bfab98245 100644
--- a/MediaBrowser.Providers/Plugins/StudioImages/Configuration/PluginConfiguration.cs
+++ b/MediaBrowser.Providers/Plugins/StudioImages/Configuration/PluginConfiguration.cs
@@ -1,13 +1,17 @@
-#pragma warning disable CS1591
-
-using MediaBrowser.Model.Plugins;
+using MediaBrowser.Model.Plugins;
 
 namespace MediaBrowser.Providers.Plugins.StudioImages.Configuration
 {
+    /// <summary>
+    /// Plugin configuration class for the studio image provider.
+    /// </summary>
     public class PluginConfiguration : BasePluginConfiguration
     {
         private string _repository = Plugin.DefaultServer;
 
+        /// <summary>
+        /// Gets or sets the studio image repository URL.
+        /// </summary>
         public string RepositoryUrl
         {
             get
diff --git a/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs b/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs
index 5e653d039f..f5ea6d103d 100644
--- a/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs
+++ b/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs
@@ -1,5 +1,4 @@
 #nullable disable
-#pragma warning disable CS1591
 
 using System;
 using System.Collections.Generic;
@@ -11,27 +10,50 @@ using MediaBrowser.Providers.Plugins.StudioImages.Configuration;
 
 namespace MediaBrowser.Providers.Plugins.StudioImages
 {
+    /// <summary>
+    /// Artwork Plugin class.
+    /// </summary>
     public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
     {
+        /// <summary>
+        /// Artwork repository URL.
+        /// </summary>
         public const string DefaultServer = "https://raw.github.com/jellyfin/emby-artwork/master/studios";
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Plugin"/> class.
+        /// </summary>
+        /// <param name="applicationPaths">application paths.</param>
+        /// <param name="xmlSerializer">xml serializer.</param>
         public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
             : base(applicationPaths, xmlSerializer)
         {
             Instance = this;
         }
 
+        /// <summary>
+        /// Gets the instance of Artwork plugin.
+        /// </summary>
         public static Plugin Instance { get; private set; }
 
+        /// <inheritdoc/>
         public override Guid Id => new Guid("872a7849-1171-458d-a6fb-3de3d442ad30");
 
+        /// <inheritdoc/>
         public override string Name => "Studio Images";
 
+        /// <inheritdoc/>
         public override string Description => "Get artwork for studios from any Jellyfin-compatible repository.";
 
         // TODO remove when plugin removed from server.
+
+        /// <inheritdoc/>
         public override string ConfigurationFileName => "Jellyfin.Plugin.StudioImages.xml";
 
+        /// <summary>
+        /// Return the plugin configuration page.
+        /// </summary>
+        /// <returns>PluginPageInfo.</returns>
         public IEnumerable<PluginPageInfo> GetPages()
         {
             yield return new PluginPageInfo
diff --git a/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs b/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs
index ef822a22ad..88bbdadb46 100644
--- a/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs
+++ b/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs
@@ -1,7 +1,5 @@
 #nullable disable
 
-#pragma warning disable CS1591
-
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -21,12 +19,21 @@ using MediaBrowser.Model.Providers;
 
 namespace MediaBrowser.Providers.Plugins.StudioImages
 {
+    /// <summary>
+    /// Studio image provider.
+    /// </summary>
     public class StudiosImageProvider : IRemoteImageProvider
     {
         private readonly IServerConfigurationManager _config;
         private readonly IHttpClientFactory _httpClientFactory;
         private readonly IFileSystem _fileSystem;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="StudiosImageProvider"/> class.
+        /// </summary>
+        /// <param name="config">The <see cref="IServerConfigurationManager"/>.</param>
+        /// <param name="httpClientFactory">The <see cref="IHttpClientFactory"/>.</param>
+        /// <param name="fileSystem">The <see cref="IFileSystem"/>.</param>
         public StudiosImageProvider(IServerConfigurationManager config, IHttpClientFactory httpClientFactory, IFileSystem fileSystem)
         {
             _config = config;
@@ -34,13 +41,16 @@ namespace MediaBrowser.Providers.Plugins.StudioImages
             _fileSystem = fileSystem;
         }
 
+        /// <inheritdoc />
         public string Name => "Artwork Repository";
 
+        /// <inheritdoc />
         public bool Supports(BaseItem item)
         {
             return item is Studio;
         }
 
+        /// <inheritdoc />
         public IEnumerable<ImageType> GetSupportedImages(BaseItem item)
         {
             return new List<ImageType>
@@ -49,6 +59,7 @@ namespace MediaBrowser.Providers.Plugins.StudioImages
             };
         }
 
+        /// <inheritdoc />
         public async Task<IEnumerable<RemoteImageInfo>> GetImages(BaseItem item, CancellationToken cancellationToken)
         {
             var thumbsPath = Path.Combine(_config.ApplicationPaths.CachePath, "imagesbyname", "remotestudiothumbs.txt");
@@ -103,6 +114,7 @@ namespace MediaBrowser.Providers.Plugins.StudioImages
             return EnsureList(url, file, _fileSystem, cancellationToken);
         }
 
+        /// <inheritdoc />
         public Task<HttpResponseMessage> GetImageResponse(string url, CancellationToken cancellationToken)
         {
             var httpClient = _httpClientFactory.CreateClient(NamedClient.Default);
@@ -134,6 +146,12 @@ namespace MediaBrowser.Providers.Plugins.StudioImages
             return file;
         }
 
+        /// <summary>
+        /// Get matching image for an item.
+        /// </summary>
+        /// <param name="item">The <see cref="BaseItem"/>.</param>
+        /// <param name="images">The enumerable of image strings.</param>
+        /// <returns>String.</returns>
         public string FindMatch(BaseItem item, IEnumerable<string> images)
         {
             var name = GetComparableName(item.Name);
@@ -151,6 +169,11 @@ namespace MediaBrowser.Providers.Plugins.StudioImages
                 .Replace("/", string.Empty, StringComparison.Ordinal);
         }
 
+        /// <summary>
+        /// Get available images for a file.
+        /// </summary>
+        /// <param name="file">The file.</param>
+        /// <returns>IEnumerable{string}.</returns>
         public IEnumerable<string> GetAvailableImages(string file)
         {
             using var fileStream = File.OpenRead(file);