Bug 597031. Correct comment about the docshell passed to createTaskbarTabPreview. a=comment
authorTimothy Nikkel <tnikkel@gmail.com>
Wed, 24 Nov 2010 19:35:01 -0600
changeset 58203 9cc9952ecc898cc258a50ac8074dc7fa54dfa7f1
parent 58202 c198cabd2743bc3b417461e1ce0da960d02eea0a
child 58204 a352c0afa63175292938f9392e2c5fb39ec58251
push id1
push usershaver@mozilla.com
push dateTue, 04 Jan 2011 17:58:04 +0000
reviewerscomment
bugs597031
milestone2.0b8pre
Bug 597031. Correct comment about the docshell passed to createTaskbarTabPreview. a=comment
widget/public/nsIWinTaskbar.idl
--- a/widget/public/nsIWinTaskbar.idl
+++ b/widget/public/nsIWinTaskbar.idl
@@ -100,18 +100,19 @@ interface nsIWinTaskbar : nsISupports
    */
   readonly attribute AString defaultGroupId;
 
   /**
    * Taskbar window and tab preview management
    */
 
   /**
-   * Creates a taskbar preview. The docshell is used to find the toplevel window.
-   * See the documentation for nsITaskbarTabPreview for more information.
+   * Creates a taskbar preview. The docshell should be a toplevel docshell and
+   * is used to find the toplevel window. See the documentation for
+   * nsITaskbarTabPreview for more information.
    */
   nsITaskbarTabPreview createTaskbarTabPreview(in nsIDocShell shell,
                                                in nsITaskbarPreviewController controller);
 
   /**
    * Gets the taskbar preview for a window. The docshell is used to find the
    * toplevel window. See the documentation for nsITaskbarTabPreview for more
    * information.