Bug 1256603. Fix comment for imgIContainer::RequestDecodeForSize to match reality. r=aosmond
authorTimothy Nikkel <tnikkel@gmail.com>
Sat, 13 Oct 2018 00:31:03 -0500
changeset 489365 d8bb90ade0d68eaf309127cb51840c722e4008b5
parent 489364 479653ce6d8c31dd5cddc815f9ad19a5b06b7fda
child 489366 2cc5b3f51ec4fa0501af01e4ece67be0eed814c4
push id247
push userfmarier@mozilla.com
push dateSat, 27 Oct 2018 01:06:44 +0000
reviewersaosmond
bugs1256603
milestone64.0a1
Bug 1256603. Fix comment for imgIContainer::RequestDecodeForSize to match reality. r=aosmond
image/imgIContainer.idl
--- a/image/imgIContainer.idl
+++ b/image/imgIContainer.idl
@@ -471,21 +471,17 @@ interface imgIContainer : nsISupports
   /*
    * This method triggers decoding for an image, but unlike startDecoding() it
    * enables the caller to provide more detailed information about the decode
    * request.
    *
    * @param aSize The size to which the image should be scaled while decoding,
    *              if possible. If the image cannot be scaled to this size while
    *              being decoded, it will be decoded at its intrinsic size.
-   * @param aFlags Flags of the FLAG_* variety. Only the decode flags
-   *               (FLAG_DECODE_*) and FLAG_SYNC_DECODE (which will
-   *               synchronously decode images that can be decoded "quickly",
-   *               just like startDecoding() does) are accepted; others will be
-   *               ignored.
+   * @param aFlags Flags of the FLAG_* variety.
    */
   [noscript] void requestDecodeForSize([const] in nsIntSize aSize,
                                        in uint32_t aFlags);
 
   /**
     * Increments the lock count on the image. An image will not be discarded
     * as long as the lock count is nonzero. Note that it is still possible for
     * the image to be undecoded if decode-on-draw is enabled and the image