Add basic docs for pointerinteraction

2015-04-22 14:20:18 +02:00
parent 5a6c95b13c
commit 340d4805af
1 changed files with 3 additions and 0 deletions
--- a/src/ol/interaction/pointerinteraction.js
+++ b/src/ol/interaction/pointerinteraction.js
@@ -171,6 +171,9 @@ ol.interaction.Pointer.handleMoveEvent = goog.nullFunction;


 /**
+ * Handles the {@link ol.MapBrowserEvent map browser event} and may call into
+ * other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are
+ * detected.
 * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
 * @return {boolean} `false` to stop event propagation.
 * @this {ol.interaction.Pointer}