From 857b946f3ec1cae2a11d62586eafe5fea3bcce19 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Mon, 19 Mar 2018 11:57:48 +0100 Subject: [PATCH] Module type for ol.events.Event --- src/ol/interaction/DragAndDrop.js | 2 +- src/ol/layer/Group.js | 2 +- src/ol/pointer/PointerEvent.js | 2 +- src/ol/render/Event.js | 2 +- src/ol/renderer/Layer.js | 2 +- src/ol/renderer/canvas/VectorLayer.js | 4 ++-- src/ol/renderer/canvas/VectorTileLayer.js | 4 ++-- src/ol/renderer/vector.js | 2 +- src/ol/renderer/webgl/Map.js | 2 +- src/ol/renderer/webgl/VectorLayer.js | 2 +- src/ol/source/Image.js | 4 ++-- src/ol/source/Raster.js | 2 +- src/ol/source/Tile.js | 2 +- src/ol/source/UrlTile.js | 2 +- src/ol/source/Vector.js | 4 ++-- src/ol/structs/LRUCache.js | 2 +- src/ol/style/Image.js | 4 ++-- 17 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/ol/interaction/DragAndDrop.js b/src/ol/interaction/DragAndDrop.js index 3d7dfcc535..8929b954db 100644 --- a/src/ol/interaction/DragAndDrop.js +++ b/src/ol/interaction/DragAndDrop.js @@ -44,7 +44,7 @@ const DragAndDropEventType = { * of this type. * * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @implements {oli.interaction.DragAndDropEvent} * @param {module:ol/interaction/DragAndDrop~DragAndDropEventType} type Type. * @param {File} file File. diff --git a/src/ol/layer/Group.js b/src/ol/layer/Group.js index 375c027e13..ee52d7acad 100644 --- a/src/ol/layer/Group.js +++ b/src/ol/layer/Group.js @@ -89,7 +89,7 @@ LayerGroup.prototype.handleLayerChange_ = function() { /** - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. * @private */ LayerGroup.prototype.handleLayersChanged_ = function(event) { diff --git a/src/ol/pointer/PointerEvent.js b/src/ol/pointer/PointerEvent.js index f0d2d3017f..413821b9bd 100644 --- a/src/ol/pointer/PointerEvent.js +++ b/src/ol/pointer/PointerEvent.js @@ -41,7 +41,7 @@ import Event from '../events/Event.js'; * touch events and even native pointer events. * * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @param {string} type The type of the event to create. * @param {Event} originalEvent The event. * @param {Object.=} opt_eventDict An optional dictionary of diff --git a/src/ol/render/Event.js b/src/ol/render/Event.js index 775eb0b35c..d02c89fbfd 100644 --- a/src/ol/render/Event.js +++ b/src/ol/render/Event.js @@ -6,7 +6,7 @@ import Event from '../events/Event.js'; /** * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @implements {oli.render.Event} * @param {ol.render.EventType} type Type. * @param {ol.render.VectorContext=} opt_vectorContext Vector context. diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js index d35eec3a5f..048261bb79 100644 --- a/src/ol/renderer/Layer.js +++ b/src/ol/renderer/Layer.js @@ -91,7 +91,7 @@ LayerRenderer.prototype.getLayer = function() { /** * Handle changes in image state. - * @param {ol.events.Event} event Image change event. + * @param {module:ol/events/Event~Event} event Image change event. * @private */ LayerRenderer.prototype.handleImageChange_ = function(event) { diff --git a/src/ol/renderer/canvas/VectorLayer.js b/src/ol/renderer/canvas/VectorLayer.js index dc0a1030ff..86f0d6c075 100644 --- a/src/ol/renderer/canvas/VectorLayer.js +++ b/src/ol/renderer/canvas/VectorLayer.js @@ -273,7 +273,7 @@ CanvasVectorLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordi /** - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. */ CanvasVectorLayerRenderer.prototype.handleFontsChanged_ = function(event) { const layer = this.getLayer(); @@ -285,7 +285,7 @@ CanvasVectorLayerRenderer.prototype.handleFontsChanged_ = function(event) { /** * Handle changes in image style state. - * @param {ol.events.Event} event Image style change event. + * @param {module:ol/events/Event~Event} event Image style change event. * @private */ CanvasVectorLayerRenderer.prototype.handleStyleImageChange_ = function(event) { diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 4336b02b02..817248c013 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -339,7 +339,7 @@ CanvasVectorTileLayerRenderer.prototype.getReplayTransform_ = function(tile, fra /** - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. */ CanvasVectorTileLayerRenderer.prototype.handleFontsChanged_ = function(event) { const layer = this.getLayer(); @@ -351,7 +351,7 @@ CanvasVectorTileLayerRenderer.prototype.handleFontsChanged_ = function(event) { /** * Handle changes in image style state. - * @param {ol.events.Event} event Image style change event. + * @param {module:ol/events/Event~Event} event Image style change event. * @private */ CanvasVectorTileLayerRenderer.prototype.handleStyleImageChange_ = function(event) { diff --git a/src/ol/renderer/vector.js b/src/ol/renderer/vector.js index bb74ff557e..d2478848b0 100644 --- a/src/ol/renderer/vector.js +++ b/src/ol/renderer/vector.js @@ -91,7 +91,7 @@ function renderCircleGeometry(replayGroup, geometry, style, feature) { * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature. * @param {ol.style.Style} style Style. * @param {number} squaredTolerance Squared tolerance. - * @param {function(this: T, ol.events.Event)} listener Listener function. + * @param {function(this: T, module:ol/events/Event~Event)} listener Listener function. * @param {T} thisArg Value to use as `this` when executing `listener`. * @return {boolean} `true` if style is loading. * @template T diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index 027f24e44d..b2d9c8a2d0 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -367,7 +367,7 @@ WebGLMapRenderer.prototype.getType = function() { /** - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. * @protected */ WebGLMapRenderer.prototype.handleWebGLContextLost = function(event) { diff --git a/src/ol/renderer/webgl/VectorLayer.js b/src/ol/renderer/webgl/VectorLayer.js index ed290037d8..6dadad36de 100644 --- a/src/ol/renderer/webgl/VectorLayer.js +++ b/src/ol/renderer/webgl/VectorLayer.js @@ -200,7 +200,7 @@ WebGLVectorLayerRenderer.prototype.forEachLayerAtPixel = function(pixel, frameSt /** * Handle changes in image style state. - * @param {ol.events.Event} event Image style change event. + * @param {module:ol/events/Event~Event} event Image style change event. * @private */ WebGLVectorLayerRenderer.prototype.handleStyleImageChange_ = function(event) { diff --git a/src/ol/source/Image.js b/src/ol/source/Image.js index 797b902103..a7982bd5a7 100644 --- a/src/ol/source/Image.js +++ b/src/ol/source/Image.js @@ -47,7 +47,7 @@ const ImageSourceEventType = { * type. * * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @implements {oli.source.ImageEvent} * @param {string} type Type. * @param {ol.Image} image The image. @@ -192,7 +192,7 @@ ImageSource.prototype.getImageInternal = function(extent, resolution, pixelRatio /** * Handle image change events. - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. * @protected */ ImageSource.prototype.handleImageChange = function(event) { diff --git a/src/ol/source/Raster.js b/src/ol/source/Raster.js index 96a5218e85..7425236340 100644 --- a/src/ol/source/Raster.js +++ b/src/ol/source/Raster.js @@ -48,7 +48,7 @@ const RasterEventType = { * type. * * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @implements {oli.source.RasterEvent} * @param {string} type Type. * @param {module:ol/PluggableMap~FrameState} frameState The frame state. diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js index c3aca84a9d..b075939e99 100644 --- a/src/ol/source/Tile.js +++ b/src/ol/source/Tile.js @@ -313,7 +313,7 @@ TileSource.prototype.useTile = UNDEFINED; * type. * * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @implements {oli.source.Tile.Event} * @param {string} type Type. * @param {module:ol/Tile~Tile} tile The tile. diff --git a/src/ol/source/UrlTile.js b/src/ol/source/UrlTile.js index 42a7e5b170..7c43c8bc91 100644 --- a/src/ol/source/UrlTile.js +++ b/src/ol/source/UrlTile.js @@ -112,7 +112,7 @@ UrlTile.prototype.getUrls = function() { /** * Handle tile change events. - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. * @protected */ UrlTile.prototype.handleTileChange = function(event) { diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 02b3d9337e..ca4d115dc9 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -28,7 +28,7 @@ import RBush from '../structs/RBush.js'; * type. * * @constructor - * @extends {ol.events.Event} + * @extends {module:ol/events/Event~Event} * @implements {oli.source.Vector.Event} * @param {string} type Type. * @param {module:ol/Feature~Feature=} opt_feature Feature. @@ -690,7 +690,7 @@ VectorSource.prototype.getUrl = function() { /** - * @param {ol.events.Event} event Event. + * @param {module:ol/events/Event~Event} event Event. * @private */ VectorSource.prototype.handleFeatureChange_ = function(event) { diff --git a/src/ol/structs/LRUCache.js b/src/ol/structs/LRUCache.js index e16e9fa88b..944fc71994 100644 --- a/src/ol/structs/LRUCache.js +++ b/src/ol/structs/LRUCache.js @@ -12,7 +12,7 @@ import EventType from '../events/EventType.js'; * items from the cache is the responsibility of the user. * @constructor * @extends {module:ol/events/EventTarget~EventTarget} - * @fires ol.events.Event + * @fires module:ol/events/Event~Event * @struct * @template T * @param {number=} opt_highWaterMark High water mark. diff --git a/src/ol/style/Image.js b/src/ol/style/Image.js index aa64a9f50b..b235926f86 100644 --- a/src/ol/style/Image.js +++ b/src/ol/style/Image.js @@ -215,7 +215,7 @@ ImageStyle.prototype.setSnapToPixel = function(snapToPixel) { /** * @abstract - * @param {function(this: T, ol.events.Event)} listener Listener function. + * @param {function(this: T, module:ol/events/Event~Event)} listener Listener function. * @param {T} thisArg Value to use as `this` when executing `listener`. * @return {module:ol/events~EventsKey|undefined} Listener key. * @template T @@ -232,7 +232,7 @@ ImageStyle.prototype.load = function() {}; /** * @abstract - * @param {function(this: T, ol.events.Event)} listener Listener function. + * @param {function(this: T, module:ol/events/Event~Event)} listener Listener function. * @param {T} thisArg Value to use as `this` when executing `listener`. * @template T */