[iOS] Cleanup comments in find_in_page.js

ios/chrome/browser/find_in_page/resources/find_in_page.js

 // Copyright 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
- * This file is lifted from the GoogleMobile find tool.
+ * Based heavily on code from the Google iOS app.
  *
  * @fileoverview A find in page tool.  It scans the DOM for elements with the
  * text being search for, and wraps them with a span that highlights them.
- *
- * @author bmcmahan@google.com (Benjamin McMahan)
- *
  */
 
 /**
  * Namespace for this file.  Depends on __gCrWeb having already been injected.
  */
 __gCrWeb['findInPage'] = {};
 
 /**
  * Index of the current highlighted choice.  -1 means none.
  * @type {number}
  */
 __gCrWeb['findInPage']['index'] = -1;
 
 /**
  * The list of found searches in span form.
  * @type {Array.<Element>}
  */
 __gCrWeb['findInPage']['spans'] = [];
 
 /**
  * The list of frame documents.
- * TODO(justincohen): x-domain frames won't work.
+ * TODO(ios): x-domain frames won't work.
  * @type {Array.<Document>}
  */
 __gCrWeb['findInPage'].frameDocs = [];
 
 /**
  * Associate array to stash element styles while the element is highlighted.
  * @type {Object.<Element,Object<string,string>>}
  */
 __gCrWeb['findInPage'].savedElementStyles = {};
 
@@ skipping 166 matching lines @@
 
 /**
  * Break up find in page DOM regex, DOM manipulation and visibility check
  * into sections that can be stopped and restarted later.  Because the js runs
  * in the main UI thread, anything over timeout will cause the UI to lock up.
  * @param {number} timeout Only run find in page until timeout.
  * @return {boolean} Whether find in page completed.
  */
 __gCrWeb['findInPage']['pumpSearch'] = function(timeout) {
   var opt_split = false;
-  // TODO(justincohen): It would be better if this DCHECKed.
+  // TODO(ios): It would be better if this DCHECKed.

[stuartmorgan, 2015/05/19 18:26:47]

We should *never* be adding TODO(ios); it's a bad habit left over from early
porting. Put the name of the person who knows the most about this TODO, which is
still justincohen. Please put an actual person below as well.

[sdefresne, 2015/05/20 08:05:32]

Acknowledged.

   if (__gCrWeb['findInPage'].searchInProgress == false)
     return __gCrWeb['findInPage'].NO_RESULTS;
 
   __gCrWeb['findInPage'].timeout = timeout;
   __gCrWeb['findInPage'].startTime = __gCrWeb['findInPage'].time();
 
   var regex = __gCrWeb['findInPage'].regex;
   // Go through every node in DFS fashion.
   while (__gCrWeb['findInPage'].node) {
     var node = __gCrWeb['findInPage'].node;
@@ skipping 628 matching lines @@
 
   var originalElement = elem;
   var nextOffsetParent = originalElement.offsetParent;
   var computedStyle =
       elem.ownerDocument.defaultView.getComputedStyle(elem, null);
 
   // We are currently handling all scrolling through the app, which means we can
   // only scroll the window, not any scrollable containers in the DOM itself. So
   // for now this function returns false if the element is scrolled outside the
   // viewable area of its ancestors.
-  // TODO (jonwall): handle scrolling within the DOM.
+  // TODO (ios): handle scrolling within the DOM.

[stuartmorgan, 2015/05/19 18:26:47]

TODO(

[sdefresne, 2015/05/20 08:05:32]

Acknowledged.

   var pageHeight = __gCrWeb['findInPage'].getBodyHeight();
   var pageWidth = __gCrWeb['findInPage'].getBodyWidth();
 
   while (elem && elem.nodeName != 'BODY') {
     if (elem.style.display === 'none' ||
         elem.style.visibility === 'hidden' ||
         elem.style.opacity === 0 ||
         computedStyle.display === 'none' ||
         computedStyle.visibility === 'hidden' ||
         computedStyle.opacity === 0) {
@@ skipping 74 matching lines @@
     var win = windowsToSearch.pop();
     for (var i = win.frames.length - 1; i >= 0; i--) {
       if (win.frames[i].document) {
         documents.push(win.frames[i].document);
         windowsToSearch.push(win.frames[i]);
       }
     }
   }
   return documents;
 };