From: Tim Düsterhus <duesterhus@woltlab.com>
Date: Fri, 29 Mar 2019 14:23:59 +0000 (+0100)
Subject: Improve explanation of ImageResizer#resize's force parameter
X-Git-Tag: 5.2.0_Alpha_1~124^2~7
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=4ee8c68ca484752eeea13f02a707b9b095afae53;p=GitHub%2FWoltLab%2FWCF.git

Improve explanation of ImageResizer#resize's force parameter
---

diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/ImageResizer.js b/wcfsetup/install/files/js/WoltLabSuite/Core/ImageResizer.js
index 5b98006808..6a914e6d0b 100644
--- a/wcfsetup/install/files/js/WoltLabSuite/Core/ImageResizer.js
+++ b/wcfsetup/install/files/js/WoltLabSuite/Core/ImageResizer.js
@@ -112,7 +112,7 @@ define([
 		 * @param       {Number}      [maxWidth]        maximum width
 		 * @param       {Number}      [maxHeight]       maximum height
 		 * @param       {Number}      [quality]         quality in percent
-		 * @param       {boolean}     [force]           whether to force scaling even if unneeded
+		 * @param       {boolean}     [force]           whether to force scaling even if unneeded (thus re-encoding with a possibly smaller file size)
 		 * @param       {Promise}     cancelPromise     a Promise used to cancel pica's operation
 		 * @returns     {Promise<{exif: any, image: any} | never>} a Promise resolving with the resized image as Canvas and optional EXIF data
 		 */