From f32c550dbe75ded725f698c9cdf658218ec65d1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Sun, 9 Nov 2014 22:08:29 +0100 Subject: [PATCH] Better docs for handleMapBrowserEvent --- externs/oli.js | 2 +- src/ol/interaction/interaction.js | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/externs/oli.js b/externs/oli.js index 097ea7bf62..8346fbe7e2 100644 --- a/externs/oli.js +++ b/externs/oli.js @@ -138,7 +138,7 @@ oli.interaction.Interaction = function() {}; /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} Whether the map browser event should continue - * through the chain of interactions. false means stop, true + * through the chain of interactions. `false` means stop, `true` * means continue. */ oli.interaction.Interaction.prototype.handleMapBrowserEvent = function(e) {}; diff --git a/src/ol/interaction/interaction.js b/src/ol/interaction/interaction.js index 3cdc0c32d1..76b15d261b 100644 --- a/src/ol/interaction/interaction.js +++ b/src/ol/interaction/interaction.js @@ -77,10 +77,15 @@ ol.interaction.Interaction.prototype.getMap = function() { /** + * Method called by the map to notify the interaction that a browser + * event was dispatched on the map. If the interaction wants to handle + * that event it can return `false` to prevent the propagation of the + * event to other interactions in the map's interactions chain. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} Whether the map browser event should continue - * through the chain of interactions. false means stop, true + * through the chain of interactions. `false` means stop, `true` * means continue. + * @function * @api */ ol.interaction.Interaction.prototype.handleMapBrowserEvent =