Add basic docs for doubleclickzoominteraction

2015-04-22 14:18:01 +02:00
parent 75e642738f
commit 134d8e6c18
1 changed files with 2 additions and 0 deletions
--- a/src/ol/interaction/doubleclickzoominteraction.js
+++ b/src/ol/interaction/doubleclickzoominteraction.js
@@ -41,6 +41,8 @@ goog.inherits(ol.interaction.DoubleClickZoom, ol.interaction.Interaction);


 /**
+ * Handles the {@link ol.MapBrowserEvent map browser event} (if it was a
+ * doubleclick) and eventually zooms the map.
 * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
 * @return {boolean} `false` to stop event propagation.
 * @this {ol.interaction.DoubleClickZoom}