From 177a12ca5ccfd08ca5576575611907bfd1f7f34f Mon Sep 17 00:00:00 2001
From: Stephen Blott
Date: Wed, 2 Mar 2016 10:26:38 +0000
Subject: Key bindings; document Commands.generateKeyStateMapping().

---
 background_scripts/commands.coffee | 1 +
 1 file changed, 1 insertion(+)

(limited to 'background_scripts/commands.coffee')

diff --git a/background_scripts/commands.coffee b/background_scripts/commands.coffee
index 08b8f449..7429b6f0 100644
--- a/background_scripts/commands.coffee
+++ b/background_scripts/commands.coffee
@@ -101,6 +101,7 @@ Commands =
     @keyToCommandRegistry = {}
     @mapKeyToCommand { key, command } for own key, command of defaultKeyMappings
 
+  # This generates a nested key-to-command mapping structure. There is an example in mode_key_handler.coffee.
   generateKeyStateMapping: ->
     # Keys are either literal characters, or "named" - for example <a-b> (alt+b), <left> (left arrow) or <f12>
     # This regular expression captures two groups: the first is a named key, the second is the remainder of
-- 
cgit v1.2.3