From 77df0c943b342b4b8642809fc6dbfbd6e0e8d5a7 Mon Sep 17 00:00:00 2001
From: Patrick Barron <barronpm@gmail.com>
Date: Tue, 14 Apr 2020 15:50:48 -0400
Subject: Clean up and document CollectionImageProvider.cs

---
 .../Collections/CollectionImageProvider.cs          | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

(limited to 'Emby.Server.Implementations/Collections/CollectionImageProvider.cs')

diff --git a/Emby.Server.Implementations/Collections/CollectionImageProvider.cs b/Emby.Server.Implementations/Collections/CollectionImageProvider.cs
index 21ba0288e..4d9f865e0 100644
--- a/Emby.Server.Implementations/Collections/CollectionImageProvider.cs
+++ b/Emby.Server.Implementations/Collections/CollectionImageProvider.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591
-
 using System.Collections.Generic;
 using System.Linq;
 using Emby.Server.Implementations.Images;
@@ -15,8 +13,18 @@ using MediaBrowser.Model.IO;
 
 namespace Emby.Server.Implementations.Collections
 {
+    /// <summary>
+    /// A collection image provider.
+    /// </summary>
     public class CollectionImageProvider : BaseDynamicImageProvider<BoxSet>
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CollectionImageProvider"/> class.
+        /// </summary>
+        /// <param name="fileSystem">The filesystem.</param>
+        /// <param name="providerManager">The provider manager.</param>
+        /// <param name="applicationPaths">The application paths.</param>
+        /// <param name="imageProcessor">The image processor.</param>
         public CollectionImageProvider(
             IFileSystem fileSystem,
             IProviderManager providerManager,
@@ -48,13 +56,10 @@ namespace Emby.Server.Implementations.Collections
 
                     var episode = subItem as Episode;
 
-                    if (episode != null)
+                    var series = episode?.Series;
+                    if (series != null && series.HasImage(ImageType.Primary))
                     {
-                        var series = episode.Series;
-                        if (series != null && series.HasImage(ImageType.Primary))
-                        {
-                            return series;
-                        }
+                        return series;
                     }
 
                     if (subItem.HasImage(ImageType.Primary))
-- 
cgit v1.2.3


From a54dca09d8c581bc2f64235d2d9a07278f5c02c4 Mon Sep 17 00:00:00 2001
From: Patrick Barron <barronpm@gmail.com>
Date: Tue, 14 Apr 2020 19:34:38 -0400
Subject: Added the last missing documentation

---
 Emby.Server.Implementations/Collections/CollectionImageProvider.cs | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'Emby.Server.Implementations/Collections/CollectionImageProvider.cs')

diff --git a/Emby.Server.Implementations/Collections/CollectionImageProvider.cs b/Emby.Server.Implementations/Collections/CollectionImageProvider.cs
index 4d9f865e0..c69a07e83 100644
--- a/Emby.Server.Implementations/Collections/CollectionImageProvider.cs
+++ b/Emby.Server.Implementations/Collections/CollectionImageProvider.cs
@@ -34,6 +34,7 @@ namespace Emby.Server.Implementations.Collections
         {
         }
 
+        /// <inheritdoc />
         protected override bool Supports(BaseItem item)
         {
             // Right now this is the only way to prevent this image from getting created ahead of internet image providers
@@ -45,6 +46,7 @@ namespace Emby.Server.Implementations.Collections
             return base.Supports(item);
         }
 
+        /// <inheritdoc />
         protected override IReadOnlyList<BaseItem> GetItemsWithImages(BaseItem item)
         {
             var playlist = (BoxSet)item;
@@ -85,6 +87,7 @@ namespace Emby.Server.Implementations.Collections
                 .ToList();
         }
 
+        /// <inheritdoc />
         protected override string CreateImage(BaseItem item, IReadOnlyCollection<BaseItem> itemsWithImages, string outputPathWithoutExtension, ImageType imageType, int imageIndex)
         {
             return CreateSingleImage(itemsWithImages, outputPathWithoutExtension, ImageType.Primary);
-- 
cgit v1.2.3