Issue 3274 - Unbreak toolbar icon tooltip

lib/child/requestNotifier.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 78 matching lines @@
       responseID,
       stats
     });
   }
 }
 
 /**
  * Creates a notifier object for a particular window. After creation the window
  * will first be scanned for previously saved requests. Once that scan is
  * complete only new requests for this window will be reported.
- * @param {Window} wnd  window to attach the notifier to
- * @param {Integer} id  Parent notifier ID to be messaged
+ * @param {Window} window  window to attach the notifier to
+ * @param {Integer} notifierID  Parent notifier ID to be messaged
  */
 function RequestNotifier(window, notifierID)
 {
   this.window = window;
   this.id = notifierID;
   notifiers.set(this.id, this);
   this.nodes = new Map();
   this.startScan(window);
 }
 exports.RequestNotifier = RequestNotifier;
@@ skipping 60 matching lines @@
    * Starts the initial scan of the window (will recurse into frames).
    * @param {Window} wnd  the window to be scanned
    */
   startScan: function(wnd)
   {
     let doc = wnd.document;
     let walker = doc.createTreeWalker(doc, Ci.nsIDOMNodeFilter.SHOW_ELEMENT, null, false);
 
     let process = function()
     {
+      // Don't do anything if the notifier was shut down already.
       if (!this.window)
         return;
 
       let node = walker.currentNode;
       let data = nodeData.get(node);
       if (typeof data != "undefined")
         for (let k in data)
           this.notifyListener(node, data[k]);
 
       if (walker.nextNode())
@@ skipping 15 matching lines @@
 
     // Process each node in a separate event to allow other events to process
     this.eventsPosted++;
     Utils.runAsync(process);
   },
 
   /**
    * Makes the nodes associated with the given requests blink.
    * @param {number[]} requests  list of request IDs that were previously
    *                             reported by this notifier.
-   * @param {Boolean} scrollToItem  if true, scroll to first node
+   * @param {boolean} scrollToItem  if true, scroll to first node
    */
   flashNodes: function(requests, scrollToItem)
   {
     this.stopFlashing();
 
     let nodes = [];
     for (let id of requests)
     {
       if (!this.nodes.has(id))
         continue;
@@ skipping 58 matching lines @@
       responseID,
       size
     });
   }
 };
 
 /**
  * Attaches request data to a DOM node.
  * @param {Node} node   node to attach data to
  * @param {Window} topWnd   top-level window the node belongs to
- * @param {String} contentType   request type, e.g. "IMAGE"
- * @param {String} docDomain  domain of the document that initiated the request
- * @param {Boolean} thirdParty  will be true if a third-party server has been requested
- * @param {String} location   the address that has been requested
- * @param {String} filter   filter applied to the request or null if none
- * @param {String} filterType  type of filter applied to the request
+ * @param {Object} hitData
+ * @param {String} hitData.contentType   request type, e.g. "IMAGE"
+ * @param {String} hitData.docDomain  domain of the document that initiated the request
+ * @param {Boolean} hitData.thirdParty  will be true if a third-party server has been requested
+ * @param {String} hitData.location   the address that has been requested
+ * @param {String} hitData.filter   filter applied to the request or null if none
+ * @param {String} hitData.filterType  type of filter applied to the request
  */
 RequestNotifier.addNodeData = function(node, topWnd, {contentType, docDomain, thirdParty, location, filter, filterType})
 {
   let entry = {
     id: ++requestEntryMaxId,
     type: contentType,
     docDomain, thirdParty, location, filter
   };
 
   let existingData = nodeData.get(node);
@@ skipping 37 matching lines @@
   }
 
   // Notify listeners
   for (let notifier of notifiers.values())
     if (!notifier.window || notifier.window == topWnd)
       notifier.notifyListener(node, entry);
 }
 
 /**
  * Retrieves the statistics for a window.
- * @result {Object} Object with the properties items, blocked, whitelisted, hidden, filters containing statistics for the window (might be null)

[Thomas Greiner, 2015/11/24 17:45:27]

Detail: `@result` doesn't exist.

+ * @return {Object} Object with the properties items, blocked, whitelisted, hidden, filters containing statistics for the window (might be null)
  */
 RequestNotifier.getWindowStatistics = function(/**Window*/ wnd)
 {
   if (windowStats.has(wnd.document))
     return windowStats.get(wnd.document);
   else
     return null;
 }