From 838e5d05d51c4c171c07d512f741304a6dc58f24 Mon Sep 17 00:00:00 2001
From: Bond_009 <bond.009@outlook.com>
Date: Sun, 11 Aug 2019 16:52:37 +0200
Subject: Document all public/internal members of Emby.Drawing

Forces all new public/internal members to be documented.
Enables TreatWarningsAsErrors for Emby.Drawing
---
 MediaBrowser.Controller/Drawing/IImageEncoder.cs   | 21 +++++++--------
 MediaBrowser.Controller/Drawing/IImageProcessor.cs | 30 +++++++++-------------
 .../Drawing/ImageProcessingOptions.cs              |  5 ++--
 .../MediaBrowser.Controller.csproj                 |  1 +
 4 files changed, 27 insertions(+), 30 deletions(-)

(limited to 'MediaBrowser.Controller')

diff --git a/MediaBrowser.Controller/Drawing/IImageEncoder.cs b/MediaBrowser.Controller/Drawing/IImageEncoder.cs
index 4eaecd0a0..a0f9ae46e 100644
--- a/MediaBrowser.Controller/Drawing/IImageEncoder.cs
+++ b/MediaBrowser.Controller/Drawing/IImageEncoder.cs
@@ -17,16 +17,6 @@ namespace MediaBrowser.Controller.Drawing
         /// <value>The supported output formats.</value>
         IReadOnlyCollection<ImageFormat> SupportedOutputFormats { get; }
 
-        /// <summary>
-        /// Encodes the image.
-        /// </summary>
-        string EncodeImage(string inputPath, DateTime dateModified, string outputPath, bool autoOrient, ImageOrientation? orientation, int quality, ImageProcessingOptions options, ImageFormat outputFormat);
-
-        /// <summary>
-        /// Creates the image collage.
-        /// </summary>
-        /// <param name="options">The options.</param>
-        void CreateImageCollage(ImageCollageOptions options);
         /// <summary>
         /// Gets the name.
         /// </summary>
@@ -46,5 +36,16 @@ namespace MediaBrowser.Controller.Drawing
         bool SupportsImageEncoding { get; }
 
         ImageDimensions GetImageSize(string path);
+
+        /// <summary>
+        /// Encodes the image.
+        /// </summary>
+        string EncodeImage(string inputPath, DateTime dateModified, string outputPath, bool autoOrient, ImageOrientation? orientation, int quality, ImageProcessingOptions options, ImageFormat outputFormat);
+
+        /// <summary>
+        /// Creates the image collage.
+        /// </summary>
+        /// <param name="options">The options.</param>
+        void CreateImageCollage(ImageCollageOptions options);
     }
 }
diff --git a/MediaBrowser.Controller/Drawing/IImageProcessor.cs b/MediaBrowser.Controller/Drawing/IImageProcessor.cs
index a11e2186f..a58a11bd1 100644
--- a/MediaBrowser.Controller/Drawing/IImageProcessor.cs
+++ b/MediaBrowser.Controller/Drawing/IImageProcessor.cs
@@ -24,7 +24,15 @@ namespace MediaBrowser.Controller.Drawing
         /// Gets the image enhancers.
         /// </summary>
         /// <value>The image enhancers.</value>
-        IImageEnhancer[] ImageEnhancers { get; }
+        IReadOnlyCollection<IImageEnhancer> ImageEnhancers { get; set; }
+
+        /// <summary>
+        /// Gets a value indicating whether [supports image collage creation].
+        /// </summary>
+        /// <value><c>true</c> if [supports image collage creation]; otherwise, <c>false</c>.</value>
+        bool SupportsImageCollageCreation { get; }
+
+        IImageEncoder ImageEncoder { get; set; }
 
         /// <summary>
         /// Gets the dimensions of the image.
@@ -50,19 +58,13 @@ namespace MediaBrowser.Controller.Drawing
         /// <returns>ImageDimensions</returns>
         ImageDimensions GetImageDimensions(BaseItem item, ItemImageInfo info, bool updateItem);
 
-        /// <summary>
-        /// Adds the parts.
-        /// </summary>
-        /// <param name="enhancers">The enhancers.</param>
-        void AddParts(IEnumerable<IImageEnhancer> enhancers);
-
         /// <summary>
         /// Gets the supported enhancers.
         /// </summary>
         /// <param name="item">The item.</param>
         /// <param name="imageType">Type of the image.</param>
         /// <returns>IEnumerable{IImageEnhancer}.</returns>
-        IImageEnhancer[] GetSupportedEnhancers(BaseItem item, ImageType imageType);
+        IEnumerable<IImageEnhancer> GetSupportedEnhancers(BaseItem item, ImageType imageType);
 
         /// <summary>
         /// Gets the image cache tag.
@@ -80,7 +82,7 @@ namespace MediaBrowser.Controller.Drawing
         /// <param name="image">The image.</param>
         /// <param name="imageEnhancers">The image enhancers.</param>
         /// <returns>Guid.</returns>
-        string GetImageCacheTag(BaseItem item, ItemImageInfo image, IImageEnhancer[] imageEnhancers);
+        string GetImageCacheTag(BaseItem item, ItemImageInfo image, IReadOnlyCollection<IImageEnhancer> imageEnhancers);
 
         /// <summary>
         /// Processes the image.
@@ -109,7 +111,7 @@ namespace MediaBrowser.Controller.Drawing
         /// <summary>
         /// Gets the supported image output formats.
         /// </summary>
-        /// <returns>IReadOnlyCollection{ImageOutput}.</returns>
+        /// <returns><see cref="IReadOnlyCollection{ImageOutput}" />.</returns>
         IReadOnlyCollection<ImageFormat> GetSupportedImageOutputFormats();
 
         /// <summary>
@@ -118,14 +120,6 @@ namespace MediaBrowser.Controller.Drawing
         /// <param name="options">The options.</param>
         void CreateImageCollage(ImageCollageOptions options);
 
-        /// <summary>
-        /// Gets a value indicating whether [supports image collage creation].
-        /// </summary>
-        /// <value><c>true</c> if [supports image collage creation]; otherwise, <c>false</c>.</value>
-        bool SupportsImageCollageCreation { get; }
-
-        IImageEncoder ImageEncoder { get; set; }
-
         bool SupportsTransparency(string path);
     }
 }
diff --git a/MediaBrowser.Controller/Drawing/ImageProcessingOptions.cs b/MediaBrowser.Controller/Drawing/ImageProcessingOptions.cs
index db432f500..29addf6e6 100644
--- a/MediaBrowser.Controller/Drawing/ImageProcessingOptions.cs
+++ b/MediaBrowser.Controller/Drawing/ImageProcessingOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using MediaBrowser.Controller.Entities;
@@ -33,9 +34,9 @@ namespace MediaBrowser.Controller.Drawing
 
         public int Quality { get; set; }
 
-        public IImageEnhancer[] Enhancers { get; set; }
+        public IReadOnlyCollection<IImageEnhancer> Enhancers { get; set; }
 
-        public ImageFormat[] SupportedOutputFormats { get; set; }
+        public IReadOnlyCollection<ImageFormat> SupportedOutputFormats { get; set; }
 
         public bool AddPlayedIndicator { get; set; }
 
diff --git a/MediaBrowser.Controller/MediaBrowser.Controller.csproj b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
index 01893f1b5..c6bca2518 100644
--- a/MediaBrowser.Controller/MediaBrowser.Controller.csproj
+++ b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
@@ -19,6 +19,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
 </Project>
-- 
cgit v1.2.3