From dcd2e425a25a086ff137ef84b9dc3f35fcee6c7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Mon, 25 Aug 2014 17:24:00 +0200 Subject: [PATCH 1/4] Add @api stable to ol.events.ConditionType --- src/ol/events/condition.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ol/events/condition.js b/src/ol/events/condition.js index ddc5c54b37..1ef6ff7a89 100644 --- a/src/ol/events/condition.js +++ b/src/ol/events/condition.js @@ -13,7 +13,7 @@ goog.require('ol.MapBrowserPointerEvent'); * `{boolean}`. If the condition is met, true should be returned. * * @typedef {function(ol.MapBrowserEvent): boolean} - * @api + * @api stable */ ol.events.ConditionType; From 43ee0158f83faba7f018f65c1b11142332bbccc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Mon, 25 Aug 2014 17:24:32 +0200 Subject: [PATCH 2/4] Add @api stable to ol.events.condition built-ins --- src/ol/events/condition.js | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/ol/events/condition.js b/src/ol/events/condition.js index 1ef6ff7a89..b6f4a61089 100644 --- a/src/ol/events/condition.js +++ b/src/ol/events/condition.js @@ -21,7 +21,7 @@ ol.events.ConditionType; /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt key is pressed. - * @api + * @api stable */ ol.events.condition.altKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -35,7 +35,7 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt and shift keys are pressed. - * @api + * @api stable */ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -51,7 +51,7 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True. * @function - * @api + * @api stable */ ol.events.condition.always = goog.functions.TRUE; @@ -59,7 +59,7 @@ ol.events.condition.always = goog.functions.TRUE; /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event is a map `click` event. - * @api + * @api stable */ ol.events.condition.click = function(mapBrowserEvent) { return mapBrowserEvent.type == ol.MapBrowserEvent.EventType.CLICK; @@ -81,7 +81,7 @@ ol.events.condition.mouseMove = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} False. * @function - * @api + * @api stable */ ol.events.condition.never = goog.functions.FALSE; @@ -89,7 +89,7 @@ ol.events.condition.never = goog.functions.FALSE; /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event is a map `singleclick` event. - * @api + * @api stable */ ol.events.condition.singleClick = function(mapBrowserEvent) { return mapBrowserEvent.type == ol.MapBrowserEvent.EventType.SINGLECLICK; @@ -99,7 +99,7 @@ ol.events.condition.singleClick = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True only if there no modifier keys are pressed. - * @api + * @api stable */ ol.events.condition.noModifierKeys = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -113,7 +113,7 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the platform modifier key is pressed. - * @api + * @api stable */ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -127,7 +127,7 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the shift key is pressed. - * @api + * @api stable */ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -157,7 +157,7 @@ ol.events.condition.targetNotEditable = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event originates from a mouse device. - * @api + * @api stable */ ol.events.condition.mouseOnly = function(mapBrowserEvent) { goog.asserts.assertInstanceof(mapBrowserEvent, ol.MapBrowserPointerEvent); From db452759c9e31af040ef2ab019eee06705966066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Mon, 25 Aug 2014 17:36:10 +0200 Subject: [PATCH 3/4] Add @api stable to ol.MapBrowserEvent --- src/ol/mapbrowserevent.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js index cbd625612f..a3969cf16d 100644 --- a/src/ol/mapbrowserevent.js +++ b/src/ol/mapbrowserevent.js @@ -45,19 +45,19 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) { /** * @const * @type {Event} - * @api + * @api stable */ this.originalEvent = browserEvent.getBrowserEvent(); /** * @type {ol.Pixel} - * @api + * @api stable */ this.pixel = map.getEventPixel(this.originalEvent); /** * @type {ol.Coordinate} - * @api + * @api stable */ this.coordinate = map.getCoordinateFromPixel(this.pixel); @@ -69,7 +69,7 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent); * Prevents the default browser action. * @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault * @override - * @api + * @api stable */ ol.MapBrowserEvent.prototype.preventDefault = function() { goog.base(this, 'preventDefault'); @@ -81,7 +81,7 @@ ol.MapBrowserEvent.prototype.preventDefault = function() { * Prevents further propagation of the current event. * @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation * @override - * @api + * @api stable */ ol.MapBrowserEvent.prototype.stopPropagation = function() { goog.base(this, 'stopPropagation'); From c02793e42b76aaa7b5410cd84fe7222ff961619e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Mon, 25 Aug 2014 17:36:22 +0200 Subject: [PATCH 4/4] Add @api stable to ol.MapEvent --- src/ol/mapevent.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ol/mapevent.js b/src/ol/mapevent.js index f0744c5243..260d002ac5 100644 --- a/src/ol/mapevent.js +++ b/src/ol/mapevent.js @@ -43,7 +43,7 @@ ol.MapEvent = function(type, map, opt_frameState) { /** * The map where the event occurred. * @type {ol.Map} - * @api + * @api stable */ this.map = map;