Permalink
Browse files

Update comments

  • Loading branch information...
ccampbell committed Jul 10, 2012
1 parent e21a90c commit d8822d1ba25b81309197d043db90c6f592286041
Showing with 9 additions and 1 deletion.
  1. +9 −1 mousetrap.js
View
@@ -24,6 +24,10 @@ window.Mousetrap = (function() {
/**
* mapping of special keycodes to their corresponding keys
*
+ * everything in this dictionary cannot use keypress events
+ * so it has to be here to map to the correct keycodes for
+ * keyup/keydown events
+ *
* @type {Object}
*/
var _MAP = {
@@ -53,7 +57,9 @@ window.Mousetrap = (function() {
/**
* mapping for special characters so they can support
- * keydown and keyup events
+ *
+ * this dictionary is only used incase you want to bind a
+ * keyup or keydown event to one of these keys
*
* @type {Object}
*/
@@ -82,6 +88,8 @@ window.Mousetrap = (function() {
*
* this is so you can use keyup events with these keys
*
+ * note that this will only work on US keyboards
+ *
* @type {Object}
*/
_SHIFT_MAP = {

0 comments on commit d8822d1

Please sign in to comment.