Add basic docs for keyboardzoominteraction

2015-04-22 14:19:50 +02:00
parent 98c6a24861
commit f756246efc
1 changed files with 3 additions and 0 deletions
--- a/src/ol/interaction/keyboardzoominteraction.js
+++ b/src/ol/interaction/keyboardzoominteraction.js
@@ -57,6 +57,9 @@ goog.inherits(ol.interaction.KeyboardZoom, ol.interaction.Interaction);


 /**
+ * Handles the {@link ol.MapBrowserEvent map browser event} if it was a
+ * `KeyEvent`, and decides whether to zoom in or out (depending on whether the
+ * key pressed was '+' or '-').
 * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
 * @return {boolean} `false` to stop event propagation.
 * @this {ol.interaction.KeyboardZoom}