From 7e3caec5836c0afeec58215ac33d625fa7f6fefa Mon Sep 17 00:00:00 2001
From: Mark Monteiro <marknr.monteiro@protonmail.com>
Date: Sun, 15 Mar 2020 15:29:39 +0100
Subject: Make PackageCreator.ModifyHtml() static and clean up XML
 documentation

This eliminates the need to create a dummy instance to call this method
---
 MediaBrowser.WebDashboard/Api/PackageCreator.cs | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

(limited to 'MediaBrowser.WebDashboard/Api/PackageCreator.cs')

diff --git a/MediaBrowser.WebDashboard/Api/PackageCreator.cs b/MediaBrowser.WebDashboard/Api/PackageCreator.cs
index 133bf61e8..e8eb0389f 100644
--- a/MediaBrowser.WebDashboard/Api/PackageCreator.cs
+++ b/MediaBrowser.WebDashboard/Api/PackageCreator.cs
@@ -28,7 +28,8 @@ namespace MediaBrowser.WebDashboard.Api
 
             if (resourceStream != null && IsCoreHtml(virtualPath))
             {
-                resourceStream = await ModifyHtml(virtualPath, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);
+                bool isMainIndexPage = string.Equals(virtualPath, "index.html", StringComparison.OrdinalIgnoreCase);
+                resourceStream = await ModifyHtml(isMainIndexPage, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);
             }
 
             return resourceStream;
@@ -45,18 +46,19 @@ namespace MediaBrowser.WebDashboard.Api
         }
 
         /// <summary>
-        /// Modifies the HTML by adding common meta tags, css and js.
+        /// Modifies the source HTML stream by adding common meta tags, css and js.
         /// </summary>
-        /// <returns>Task{Stream}.</returns>
-        public async Task<Stream> ModifyHtml(
-            string path,
+        /// <returns>
+        /// A task that represents the async operation to read and modify the input stream.
+        /// The task result contains a stream containing the modified HTML content.
+        /// </returns>
+        public static async Task<Stream> ModifyHtml(
+            bool isMainIndexPage,
             Stream sourceStream,
             string mode,
             string appVersion,
             string localizationCulture)
         {
-            var isMainIndexPage = string.Equals(path, "index.html", StringComparison.OrdinalIgnoreCase);
-
             string html;
             using (var reader = new StreamReader(sourceStream, Encoding.UTF8))
             {
-- 
cgit v1.2.3