From 8c58bb43327877085d235dbb3ef3577ff17eff02 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Tue, 13 Mar 2018 16:06:46 +0100 Subject: [PATCH 1/6] Use 'module:ol/PluggableMap~FrameState' instead of 'olx.FrameState' --- src/ol/MapBrowserEvent.js | 2 +- src/ol/PluggableMap.js | 8 ++++---- src/ol/control/Attribution.js | 4 ++-- src/ol/render/Event.js | 4 ++-- src/ol/renderer/Layer.js | 10 +++++----- src/ol/renderer/Map.js | 18 +++++++++--------- src/ol/renderer/canvas/ImageLayer.js | 2 +- src/ol/renderer/canvas/Layer.js | 18 +++++++++--------- src/ol/renderer/canvas/Map.js | 4 ++-- src/ol/renderer/canvas/TileLayer.js | 2 +- src/ol/renderer/canvas/VectorTileLayer.js | 6 +++--- src/ol/renderer/webgl/Layer.js | 10 +++++----- src/ol/renderer/webgl/Map.js | 6 +++--- src/ol/source/Raster.js | 14 +++++++------- 14 files changed, 54 insertions(+), 54 deletions(-) diff --git a/src/ol/MapBrowserEvent.js b/src/ol/MapBrowserEvent.js index 39c8a7abd7..b5cbcf9903 100644 --- a/src/ol/MapBrowserEvent.js +++ b/src/ol/MapBrowserEvent.js @@ -16,7 +16,7 @@ import MapEvent from './MapEvent.js'; * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {Event} browserEvent Browser event. * @param {boolean=} opt_dragging Is the map currently being dragged? - * @param {?olx.FrameState=} opt_frameState Frame state. + * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state. */ const MapBrowserEvent = function(type, map, browserEvent, opt_dragging, opt_frameState) { diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 9978248f20..883183f38b 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -57,7 +57,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js /** - * @typedef {function(module:ol/PluggableMap~PluggableMap, ?olx.FrameState): boolean} PostRenderFunction + * @typedef {function(module:ol/PluggableMap~PluggableMap, ?module:ol/PluggableMap~FrameState): boolean} PostRenderFunction */ @@ -218,7 +218,7 @@ const PluggableMap = function(options) { /** * @private - * @type {?olx.FrameState} + * @type {?module:ol/PluggableMap~FrameState} */ this.frameState_ = null; @@ -1224,7 +1224,7 @@ PluggableMap.prototype.renderFrame_ = function(time) { const view = this.getView(); const extent = createEmpty(); const previousFrameState = this.frameState_; - /** @type {?olx.FrameState} */ + /** @type {?module:ol/PluggableMap~FrameState} */ let frameState = null; if (size !== undefined && hasArea(size) && view && view.isDef()) { const viewHints = view.getHints(this.frameState_ ? this.frameState_.viewHints : undefined); @@ -1241,7 +1241,7 @@ PluggableMap.prototype.renderFrame_ = function(time) { focus[0] = Math.round(focus[0] / pixelResolution) * pixelResolution; focus[1] = Math.round(focus[1] / pixelResolution) * pixelResolution; } - frameState = /** @type {olx.FrameState} */ ({ + frameState = /** @type {module:ol/PluggableMap~FrameState} */ ({ animate: false, coordinateToPixelTransform: this.coordinateToPixelTransform_, extent: extent, diff --git a/src/ol/control/Attribution.js b/src/ol/control/Attribution.js index b72d1a8dce..b4fb686f3c 100644 --- a/src/ol/control/Attribution.js +++ b/src/ol/control/Attribution.js @@ -148,7 +148,7 @@ inherits(Attribution, Control); /** * Get a list of visible attributions. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @return {Array.} Attributions. * @private */ @@ -219,7 +219,7 @@ export function render(mapEvent) { /** * @private - * @param {?olx.FrameState} frameState Frame state. + * @param {?module:ol/PluggableMap~FrameState} frameState Frame state. */ Attribution.prototype.updateElement_ = function(frameState) { if (!frameState) { diff --git a/src/ol/render/Event.js b/src/ol/render/Event.js index bcc026a067..775eb0b35c 100644 --- a/src/ol/render/Event.js +++ b/src/ol/render/Event.js @@ -10,7 +10,7 @@ import Event from '../events/Event.js'; * @implements {oli.render.Event} * @param {ol.render.EventType} type Type. * @param {ol.render.VectorContext=} opt_vectorContext Vector context. - * @param {olx.FrameState=} opt_frameState Frame state. + * @param {module:ol/PluggableMap~FrameState=} opt_frameState Frame state. * @param {?CanvasRenderingContext2D=} opt_context Context. * @param {?ol.webgl.Context=} opt_glContext WebGL Context. */ @@ -29,7 +29,7 @@ const RenderEvent = function( /** * An object representing the current render frame state. - * @type {olx.FrameState|undefined} + * @type {module:ol/PluggableMap~FrameState|undefined} * @api */ this.frameState = opt_frameState; diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js index 13907a0fa1..2d2d686ca9 100644 --- a/src/ol/renderer/Layer.js +++ b/src/ol/renderer/Layer.js @@ -34,7 +34,7 @@ inherits(LayerRenderer, Observable); /** * @param {module:ol/coordinate~Coordinate} coordinate Coordinate. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {number} hitTolerance Hit tolerance in pixels. * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature), ol.layer.Layer): T} * callback Feature callback. @@ -47,7 +47,7 @@ LayerRenderer.prototype.forEachFeatureAtCoordinate = UNDEFINED; /** * @param {module:ol/coordinate~Coordinate} coordinate Coordinate. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @return {boolean} Is there a feature at the given coordinate? */ LayerRenderer.prototype.hasFeatureAtCoordinate = FALSE; @@ -137,7 +137,7 @@ LayerRenderer.prototype.renderIfReadyAndVisible = function() { /** - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {ol.source.Tile} tileSource Tile source. * @protected */ @@ -146,7 +146,7 @@ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) { /** * @param {ol.source.Tile} tileSource Tile source. * @param {ol.PluggableMap} map Map. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. */ const postRenderFunction = function(tileSource, map, frameState) { const tileSourceKey = getUid(tileSource).toString(); @@ -194,7 +194,7 @@ LayerRenderer.prototype.updateUsedTiles = function(usedTiles, tileSource, z, til * - registers idle tiles in frameState.wantedTiles so that they are not * discarded by the tile queue * - enqueues missing tiles - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {ol.source.Tile} tileSource Tile source. * @param {ol.tilegrid.TileGrid} tileGrid Tile grid. * @param {number} pixelRatio Pixel ratio. diff --git a/src/ol/renderer/Map.js b/src/ol/renderer/Map.js index bf0ab8e1ed..566bca4db3 100644 --- a/src/ol/renderer/Map.js +++ b/src/ol/renderer/Map.js @@ -48,7 +48,7 @@ inherits(MapRenderer, Disposable); /** - * @param {olx.FrameState} frameState FrameState. + * @param {module:ol/PluggableMap~FrameState} frameState FrameState. * @protected */ MapRenderer.prototype.calculateMatrices2D = function(frameState) { @@ -79,7 +79,7 @@ MapRenderer.prototype.removeLayerRenderers = function() { /** * @param {ol.PluggableMap} map Map. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. */ function expireIconCache(map, frameState) { iconImageCache.expire(); @@ -88,7 +88,7 @@ function expireIconCache(map, frameState) { /** * @param {module:ol/coordinate~Coordinate} coordinate Coordinate. - * @param {olx.FrameState} frameState FrameState. + * @param {module:ol/PluggableMap~FrameState} frameState FrameState. * @param {number} hitTolerance Hit tolerance in pixels. * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature), * ol.layer.Layer): T} callback Feature callback. @@ -158,7 +158,7 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta /** * @abstract * @param {module:ol~Pixel} pixel Pixel. - * @param {olx.FrameState} frameState FrameState. + * @param {module:ol/PluggableMap~FrameState} frameState FrameState. * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer * callback. * @param {S} thisArg Value to use as `this` when executing `callback`. @@ -176,7 +176,7 @@ MapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, callback /** * @param {module:ol/coordinate~Coordinate} coordinate Coordinate. - * @param {olx.FrameState} frameState FrameState. + * @param {module:ol/PluggableMap~FrameState} frameState FrameState. * @param {number} hitTolerance Hit tolerance in pixels. * @param {function(this: U, ol.layer.Layer): boolean} layerFilter Layer filter * function, only layers which are visible and for which this function @@ -287,14 +287,14 @@ MapRenderer.prototype.removeLayerRendererByKey_ = function(layerKey) { /** * Render. - * @param {?olx.FrameState} frameState Frame state. + * @param {?module:ol/PluggableMap~FrameState} frameState Frame state. */ MapRenderer.prototype.renderFrame = UNDEFINED; /** * @param {ol.PluggableMap} map Map. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ MapRenderer.prototype.removeUnusedLayerRenderers_ = function(map, frameState) { @@ -307,7 +307,7 @@ MapRenderer.prototype.removeUnusedLayerRenderers_ = function(map, frameState) { /** - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @protected */ MapRenderer.prototype.scheduleExpireIconCache = function(frameState) { @@ -316,7 +316,7 @@ MapRenderer.prototype.scheduleExpireIconCache = function(frameState) { /** - * @param {!olx.FrameState} frameState Frame state. + * @param {!module:ol/PluggableMap~FrameState} frameState Frame state. * @protected */ MapRenderer.prototype.scheduleRemoveUnusedLayerRenderers = function(frameState) { diff --git a/src/ol/renderer/canvas/ImageLayer.js b/src/ol/renderer/canvas/ImageLayer.js index 2a7e6460df..777594ba22 100644 --- a/src/ol/renderer/canvas/ImageLayer.js +++ b/src/ol/renderer/canvas/ImageLayer.js @@ -149,7 +149,7 @@ CanvasImageLayerRenderer.prototype.prepareFrame = function(frameState, layerStat const vectorRenderer = this.vectorRenderer_; if (vectorRenderer) { const context = vectorRenderer.context; - const imageFrameState = /** @type {olx.FrameState} */ (assign({}, frameState, { + const imageFrameState = /** @type {module:ol/PluggableMap~FrameState} */ (assign({}, frameState, { size: [ getWidth(renderedExtent) / viewResolution, getHeight(renderedExtent) / viewResolution diff --git a/src/ol/renderer/canvas/Layer.js b/src/ol/renderer/canvas/Layer.js index ef9151efd5..375c106285 100644 --- a/src/ol/renderer/canvas/Layer.js +++ b/src/ol/renderer/canvas/Layer.js @@ -40,7 +40,7 @@ inherits(CanvasLayerRenderer, LayerRenderer); /** * @param {CanvasRenderingContext2D} context Context. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/extent~Extent} extent Clip extent. * @protected */ @@ -74,7 +74,7 @@ CanvasLayerRenderer.prototype.clip = function(context, frameState, extent) { /** * @param {ol.render.EventType} type Event type. * @param {CanvasRenderingContext2D} context Context. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/transform~Transform=} opt_transform Transform. * @private */ @@ -100,7 +100,7 @@ CanvasLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, fr /** * @param {module:ol/coordinate~Coordinate} coordinate Coordinate. - * @param {olx.FrameState} frameState FrameState. + * @param {module:ol/PluggableMap~FrameState} frameState FrameState. * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer * callback. * @param {S} thisArg Value to use as `this` when executing `callback`. @@ -120,7 +120,7 @@ CanvasLayerRenderer.prototype.forEachLayerAtCoordinate = function(coordinate, fr /** * @param {CanvasRenderingContext2D} context Context. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @param {module:ol/transform~Transform=} opt_transform Transform. * @protected @@ -132,7 +132,7 @@ CanvasLayerRenderer.prototype.postCompose = function(context, frameState, layerS /** * @param {CanvasRenderingContext2D} context Context. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/transform~Transform=} opt_transform Transform. * @protected */ @@ -143,7 +143,7 @@ CanvasLayerRenderer.prototype.preCompose = function(context, frameState, opt_tra /** * @param {CanvasRenderingContext2D} context Context. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/transform~Transform=} opt_transform Transform. * @protected */ @@ -153,7 +153,7 @@ CanvasLayerRenderer.prototype.dispatchRenderEvent = function(context, frameState /** - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {number} offsetX Offset on the x-axis in view coordinates. * @protected * @return {!module:ol/transform~Transform} Transform. @@ -174,7 +174,7 @@ CanvasLayerRenderer.prototype.getTransform = function(frameState, offsetX) { /** * @abstract - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @param {CanvasRenderingContext2D} context Context. */ @@ -182,7 +182,7 @@ CanvasLayerRenderer.prototype.composeFrame = function(frameState, layerState, co /** * @abstract - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @return {boolean} whether composeFrame should be called. */ diff --git a/src/ol/renderer/canvas/Map.js b/src/ol/renderer/canvas/Map.js index 3ac6a63544..9682475e17 100644 --- a/src/ol/renderer/canvas/Map.js +++ b/src/ol/renderer/canvas/Map.js @@ -86,7 +86,7 @@ CanvasMapRenderer['create'] = function(container, map) { /** * @param {ol.render.EventType} type Event type. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ CanvasMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) { @@ -110,7 +110,7 @@ CanvasMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) { /** - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @protected * @return {!module:ol/transform~Transform} Transform. */ diff --git a/src/ol/renderer/canvas/TileLayer.js b/src/ol/renderer/canvas/TileLayer.js index e84856ef0b..f0ecb44b33 100644 --- a/src/ol/renderer/canvas/TileLayer.js +++ b/src/ol/renderer/canvas/TileLayer.js @@ -299,7 +299,7 @@ CanvasTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState /** * @param {ol.Tile} tile Tile. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @param {number} x Left of the tile. * @param {number} y Top of the tile. diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 437aca99a1..a09e5626f4 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -151,7 +151,7 @@ CanvasVectorTileLayerRenderer.prototype.prepareFrame = function(frameState, laye /** * @param {ol.VectorImageTile} tile Tile. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, frameState) { @@ -310,7 +310,7 @@ CanvasVectorTileLayerRenderer.prototype.forEachFeatureAtCoordinate = function(co /** * @param {ol.VectorTile} tile Tile. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @return {module:ol/transform~Transform} transform Transform. * @private */ @@ -475,7 +475,7 @@ CanvasVectorTileLayerRenderer.prototype.renderFeature = function(feature, square /** * @param {ol.VectorImageTile} tile Tile. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @private */ diff --git a/src/ol/renderer/webgl/Layer.js b/src/ol/renderer/webgl/Layer.js index 6a98f45513..3515b56041 100644 --- a/src/ol/renderer/webgl/Layer.js +++ b/src/ol/renderer/webgl/Layer.js @@ -91,7 +91,7 @@ inherits(WebGLLayerRenderer, LayerRenderer); /** - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {number} framebufferDimension Framebuffer dimension. * @protected */ @@ -137,7 +137,7 @@ WebGLLayerRenderer.prototype.bindFramebuffer = function(frameState, framebufferD /** - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @param {ol.webgl.Context} context Context. */ @@ -184,7 +184,7 @@ WebGLLayerRenderer.prototype.composeFrame = function(frameState, layerState, con /** * @param {ol.render.EventType} type Event type. * @param {ol.webgl.Context} context WebGL context. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ WebGLLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, frameState) { @@ -243,7 +243,7 @@ WebGLLayerRenderer.prototype.handleWebGLContextLost = function() { /** * @abstract - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/layer/Layer~State} layerState Layer state. * @param {ol.webgl.Context} context Context. * @return {boolean} whether composeFrame should be called. @@ -254,7 +254,7 @@ WebGLLayerRenderer.prototype.prepareFrame = function(frameState, layerState, con /** * @abstract * @param {module:ol~Pixel} pixel Pixel. - * @param {olx.FrameState} frameState FrameState. + * @param {module:ol/PluggableMap~FrameState} frameState FrameState. * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer * callback. * @param {S} thisArg Value to use as `this` when executing `callback`. diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index a580492374..1768e40e47 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -142,7 +142,7 @@ const WebGLMapRenderer = function(container, map) { /** * @param {ol.PluggableMap} map Map. - * @param {?olx.FrameState} frameState Frame state. + * @param {?module:ol/PluggableMap~FrameState} frameState Frame state. * @return {boolean} false. * @this {ol.renderer.webgl.Map} */ @@ -261,7 +261,7 @@ WebGLMapRenderer.prototype.bindTileTexture = function(tile, tileSize, tileGutter /** * @param {ol.render.EventType} type Event type. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ WebGLMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) { @@ -311,7 +311,7 @@ WebGLMapRenderer.prototype.disposeInternal = function() { /** * @param {ol.PluggableMap} map Map. - * @param {olx.FrameState} frameState Frame state. + * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ WebGLMapRenderer.prototype.expireCache_ = function(map, frameState) { diff --git a/src/ol/source/Raster.js b/src/ol/source/Raster.js index 4b61584cb2..9dd41200f1 100644 --- a/src/ol/source/Raster.js +++ b/src/ol/source/Raster.js @@ -51,7 +51,7 @@ const RasterEventType = { * @extends {ol.events.Event} * @implements {oli.source.RasterEvent} * @param {string} type Type. - * @param {olx.FrameState} frameState The frame state. + * @param {module:ol/PluggableMap~FrameState} frameState The frame state. * @param {Object} data An object made available to operations. */ const RasterSourceEvent = function(type, frameState, data) { @@ -145,7 +145,7 @@ const RasterSource = function(options) { /** * The most recently requested frame state. - * @type {olx.FrameState} + * @type {module:ol/PluggableMap~FrameState} * @private */ this.requestedFrameState_; @@ -165,7 +165,7 @@ const RasterSource = function(options) { /** * @private - * @type {olx.FrameState} + * @type {module:ol/PluggableMap~FrameState} */ this.frameState_ = { animate: false, @@ -225,12 +225,12 @@ RasterSource.prototype.setOperation = function(operation, opt_lib) { * @param {module:ol/extent~Extent} extent The view extent (in map units). * @param {number} resolution The view resolution. * @param {module:ol/proj/Projection~Projection} projection The view projection. - * @return {olx.FrameState} The updated frame state. + * @return {module:ol/PluggableMap~FrameState} The updated frame state. * @private */ RasterSource.prototype.updateFrameState_ = function(extent, resolution, projection) { - const frameState = /** @type {olx.FrameState} */ (assign({}, this.frameState_)); + const frameState = /** @type {module:ol/PluggableMap~FrameState} */ (assign({}, this.frameState_)); frameState.viewState = /** @type {olx.ViewState} */ (assign({}, frameState.viewState)); @@ -330,7 +330,7 @@ RasterSource.prototype.processSources_ = function() { /** * Called when pixel processing is complete. - * @param {olx.FrameState} frameState The frame state. + * @param {module:ol/PluggableMap~FrameState} frameState The frame state. * @param {Error} err Any error during processing. * @param {ImageData} output The output image data. * @param {Object} data The user data. @@ -378,7 +378,7 @@ let sharedContext = null; /** * Get image data from a renderer. * @param {ol.renderer.canvas.Layer} renderer Layer renderer. - * @param {olx.FrameState} frameState The frame state. + * @param {module:ol/PluggableMap~FrameState} frameState The frame state. * @param {module:ol/layer/Layer~State} layerState The layer state. * @return {ImageData} The image data. */ From 13da5ef01d385e634d6ca3be711d83beafb3a314 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Tue, 13 Mar 2018 16:11:56 +0100 Subject: [PATCH 2/6] Use 'module:ol/Overlay~OverlayOptions' instead of 'olx.OverlayOptions' --- src/ol/Overlay.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/ol/Overlay.js b/src/ol/Overlay.js index 3a3e7f3ccf..75bc65044b 100644 --- a/src/ol/Overlay.js +++ b/src/ol/Overlay.js @@ -95,7 +95,7 @@ const Property = { * * @constructor * @extends {module:ol/Object~Object} - * @param {olx.OverlayOptions} options Overlay options. + * @param {module:ol/Overlay~OverlayOptions} options Overlay options. * @api */ const Overlay = function(options) { @@ -104,7 +104,7 @@ const Overlay = function(options) { /** * @protected - * @type {olx.OverlayOptions} + * @type {module:ol/Overlay~OverlayOptions} */ this.options = options; @@ -594,7 +594,7 @@ Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) { /** * returns the options this Overlay has been created with * @public - * @return {olx.OverlayOptions} overlay options + * @return {module:ol/Overlay~OverlayOptions} overlay options */ Overlay.prototype.getOptions = function() { return this.options; From 87f09b34d3deb327c010d33bc2f779584588606d Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Tue, 13 Mar 2018 16:13:43 +0100 Subject: [PATCH 3/6] Use 'module:ol/Overlay~OverlayPanOptions' instead of 'olx.OverlayPanOptions' --- src/ol/Overlay.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/ol/Overlay.js b/src/ol/Overlay.js index 75bc65044b..54e6692937 100644 --- a/src/ol/Overlay.js +++ b/src/ol/Overlay.js @@ -144,10 +144,10 @@ const Overlay = function(options) { /** * @protected - * @type {olx.OverlayPanOptions} + * @type {module:ol/Overlay~OverlayPanOptions} */ this.autoPanAnimation = options.autoPanAnimation || - /** @type {olx.OverlayPanOptions} */ ({}); + /** @type {module:ol/Overlay~OverlayPanOptions} */ ({}); /** * @protected From bde23826e2e9d991dcf01ac302ec49c2dab737b6 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Tue, 13 Mar 2018 16:24:43 +0100 Subject: [PATCH 4/6] Use 'module:ol/View~FitOptions' instead of 'olx.view.FitOptions' --- src/ol/View.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ol/View.js b/src/ol/View.js index d470b80c5d..8e3bbb9e8d 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -997,7 +997,7 @@ View.prototype.getResolutionForZoom = function(zoom) { * Takes care of the map angle. * @param {module:ol/geom/SimpleGeometry~SimpleGeometry|module:ol/extent~Extent} geometryOrExtent The geometry or * extent to fit the view to. - * @param {olx.view.FitOptions=} opt_options Options. + * @param {module:ol/View~FitOptions=} opt_options Options. * @api */ View.prototype.fit = function(geometryOrExtent, opt_options) { From a02dfb640f014289ed1b9d965a36a5da57a2f479 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Tue, 13 Mar 2018 16:31:11 +0100 Subject: [PATCH 5/6] Remove unused ol.PreRenderFunction typedef --- src/ol/typedefs.js | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/src/ol/typedefs.js b/src/ol/typedefs.js index 3dbc42bc29..d23d00afcf 100644 --- a/src/ol/typedefs.js +++ b/src/ol/typedefs.js @@ -241,16 +241,6 @@ ol.LRUCacheEntry; ol.ModifySegmentDataType; -/** - * Function to perform manipulations before rendering. This function is called - * with the {@link ol.Map} as first and an optional {@link olx.FrameState} as - * second argument. Return `true` to keep this function for the next frame, - * `false` to remove it. - * @typedef {function(ol.PluggableMap, ?olx.FrameState): boolean} - */ -ol.PreRenderFunction; - - /** * A function that takes an array of input data, performs some operation, and * returns an array of output data. From 671af4dd412a299003da175e5d81711ce4aa18a5 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Tue, 13 Mar 2018 16:37:21 +0100 Subject: [PATCH 6/6] Use 'module:ol/plugins~MapRendererPlugin' instead of 'olx.MapRendererPlugin' --- src/ol/PluggableMap.js | 4 ++-- src/ol/plugins.js | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 883183f38b..36f4387984 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -80,7 +80,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js * @property {module:ol/Collection~Collection.} [interactions] * @property {Element|Document} keyboardEventTarget * @property {module:ol/Collection~Collection.} overlays - * @property {olx.MapRendererPlugin} mapRendererPlugin + * @property {module:ol/plugins~MapRendererPlugin} mapRendererPlugin * @property {Object.} values */ @@ -1461,7 +1461,7 @@ function createOptionsInternal(options) { } /** - * @type {olx.MapRendererPlugin} + * @type {module:ol/plugins~MapRendererPlugin} */ let mapRendererPlugin; diff --git a/src/ol/plugins.js b/src/ol/plugins.js index a26fcfe7f0..66a4b0a377 100644 --- a/src/ol/plugins.js +++ b/src/ol/plugins.js @@ -32,7 +32,7 @@ const mapRendererPlugins = []; /** * Get all registered map renderer plugins. - * @return {Array} The registered map renderer plugins. + * @return {Array} The registered map renderer plugins. */ export function getMapRendererPlugins() { return mapRendererPlugins; @@ -66,7 +66,7 @@ export function register(type, plugin) { switch (type) { case PluginType.MAP_RENDERER: { plugins = mapRendererPlugins; - plugins.push(/** @type {olx.MapRendererPlugin} */ (plugin)); + plugins.push(/** @type {module:ol/plugins~MapRendererPlugin} */ (plugin)); break; } case PluginType.LAYER_RENDERER: {