Add basic docs for keyboardpaninteraction

2015-04-22 14:19:30 +02:00
parent 1917193ea9
commit 98c6a24861
1 changed files with 3 additions and 0 deletions
--- a/src/ol/interaction/keyboardpaninteraction.js
+++ b/src/ol/interaction/keyboardpaninteraction.js
@@ -61,6 +61,9 @@ goog.inherits(ol.interaction.KeyboardPan, ol.interaction.Interaction);


 /**
+ * Handles the {@link ol.MapBrowserEvent map browser event} if it was a
+ * `KeyEvent`, and decides the direction to pan to (if an arrow key was
+ * pressed).
 * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
 * @return {boolean} `false` to stop event propagation.
 * @this {ol.interaction.KeyboardPan}