Bug 792821 - Add more informative documentation to getImgCacheForDocument. r=joe
authorJosh Matthews <josh@joshmatthews.net>
Tue, 25 Sep 2012 23:51:18 -0400
changeset 109262 0ea0cfc7f6f4
parent 109261 e94dbc151121
child 109263 e619280855e5
push id15943
push userjosh@joshmatthews.net
push dateThu, 04 Oct 2012 20:20:52 +0000
treeherdermozilla-inbound@0ea0cfc7f6f4 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjoe
bugs792821
milestone18.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
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.