From aa047d5b4b6124f7e2d1230ab590b9244db6ebb3 Mon Sep 17 00:00:00 2001
From: mrmr1993
Date: Thu, 18 Dec 2014 13:39:22 +0000
Subject: Improve comments for LinkHints.getVisibleClickableElements

---
 content_scripts/link_hints.coffee | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'content_scripts')

diff --git a/content_scripts/link_hints.coffee b/content_scripts/link_hints.coffee
index 95026cba..b1c44e42 100644
--- a/content_scripts/link_hints.coffee
+++ b/content_scripts/link_hints.coffee
@@ -125,9 +125,11 @@ LinkHints =
     marker
 
   #
-  # Returns all clickable elements that are not hidden and are in the current viewport.
-  # We prune invisible elements partly for performance reasons, but moreso it's to decrease the number
-  # of digits needed to enumerate all of the links on screen.
+  # Returns all clickable elements that are not hidden and are in the current viewport, along with rectangles
+  # at which (parts of) the elements are displayed.
+  # In the process, we try to find rects where elements do not overlap so that link hints are unambiguous.
+  # Because of this, the rects returned will frequently *NOT* be equivalent to the rects for the whole
+  # element.
   #
   getVisibleClickableElements: ->
     elements = document.documentElement.getElementsByTagName "*"
@@ -197,6 +199,7 @@ LinkHints =
     #
     # Remove rects from elements where another clickable element lies above it.
     nonOverlappingElements = []
+    # Traverse the DOM from first to last, since later elements show above earlier elements.
     visibleElements = visibleElements.reverse()
     while visibleElement = visibleElements.pop()
       rects = [visibleElement.rect]
-- 
cgit v1.2.3