From 51bb56a0439de93a7e79b05d231c84fd6844a8a3 Mon Sep 17 00:00:00 2001
From: Jez Ng
Date: Sun, 2 Sep 2012 22:58:34 -0400
Subject: Add comments describing the focusInput behavior.

---
 content_scripts/vimium_frontend.coffee | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'content_scripts')

diff --git a/content_scripts/vimium_frontend.coffee b/content_scripts/vimium_frontend.coffee
index 577aa0c5..54a3bb2e 100644
--- a/content_scripts/vimium_frontend.coffee
+++ b/content_scripts/vimium_frontend.coffee
@@ -301,6 +301,9 @@ extend window,
     HUD.showForDuration("Yanked URL", 1000)
 
   focusInput: (count) ->
+    # Focus the first input element on the page, and create overlays to highlight all the input elements, with
+    # the currently-focused element highlighted specially. Tabbing will shift focus to the next input element.
+    # Pressing any other key will remove the overlays and the special tab behavior.
     resultSet = DomUtils.evaluateXPath(textInputXPath, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE)
     visibleInputs =
       for i in [0...resultSet.snapshotLength] by 1
-- 
cgit v1.2.3