Improve explanation of ImageResizer#resize's force parameter
authorTim Düsterhus <duesterhus@woltlab.com>
Fri, 29 Mar 2019 14:23:59 +0000 (15:23 +0100)
committerTim Düsterhus <duesterhus@woltlab.com>
Fri, 29 Mar 2019 14:23:59 +0000 (15:23 +0100)
wcfsetup/install/files/js/WoltLabSuite/Core/ImageResizer.js

index 5b98006808f62fb971bc45a0073998b38a937c9a..6a914e6d0bc5e140525d101ad85889d0345c2643 100644 (file)
@@ -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
                 */