Bug 792821 - Add more informative documentation to getImgCacheForDocument. r=joe
authorJosh Matthews <josh@joshmatthews.net>
Tue, 25 Sep 2012 23:51:18 -0400
changeset 115583 0ea0cfc7f6f4acec3c6174828e8ecfeafac14bce
parent 115582 e94dbc151121ef4fefeda5a2655238c0d6c6f065
child 115584 e619280855e5f91edb92d7c2e7f52ea215dd7679
push id1
push usersledru@mozilla.com
push dateThu, 04 Dec 2014 17:57:20 +0000
reviewersjoe
bugs792821
milestone18.0a1
Bug 792821 - Add more informative documentation to getImgCacheForDocument. r=joe
image/public/imgITools.idl
--- a/image/public/imgITools.idl
+++ b/image/public/imgITools.idl
@@ -85,17 +85,19 @@ interface imgITools : nsISupports
     imgILoader getImgLoaderForDocument(in nsIDOMDocument doc);
 
     /**
      * getImgLoaderForDocument
      * Retrieve an image cache that reflects the privacy status of the given
      * document.
      *
      * @param doc
-     *        A document. Must not be null.
+     *        A document. Null is allowed, but must _only_ be passed
+     *        when there is no way to obtain a relevant document for
+     *        the current context in which a cache is desired.
      */
     imgICache getImgCacheForDocument(in nsIDOMDocument doc);
 
     /**
      * encodeCroppedImage
      * Caller provides an image container, and the mime type it should be
      * encoded to. We return an input stream for the encoded image data.
      * The encoded image is cropped to the specified dimensions.