From 05f92c03337a803843dd7a97394f3b0c40d35827 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Fri, 20 Apr 2018 14:37:46 +0200 Subject: [PATCH] Module type for ol.source.Tile --- src/ol/layer/Tile.js | 4 ++-- src/ol/renderer/Layer.js | 10 +++++----- src/ol/renderer/canvas/TileLayer.js | 2 +- src/ol/source/Raster.js | 2 +- src/ol/source/Tile.js | 2 +- src/ol/source/TileDebug.js | 2 +- src/ol/source/TileUTFGrid.js | 2 +- src/ol/source/UrlTile.js | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/ol/layer/Tile.js b/src/ol/layer/Tile.js index c20c8f8eba..6145fa7cce 100644 --- a/src/ol/layer/Tile.js +++ b/src/ol/layer/Tile.js @@ -22,7 +22,7 @@ import {assign} from '../obj.js'; * be visible. * @property {number} [preload=0] Preload. Load low-resolution tiles up to `preload` levels. `0` * means no preloading. - * @property {ol.source.Tile} [source] Source for this layer. + * @property {module:ol/source/Tile~TileSource} [source] Source for this layer. * @property {module:ol/PluggableMap~PluggableMap} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to @@ -84,7 +84,7 @@ TileLayer.prototype.getPreload = function() { /** * Return the associated {@link ol.source.Tile tilesource} of the layer. * @function - * @return {ol.source.Tile} Source. + * @return {module:ol/source/Tile~TileSource} Source. * @api */ TileLayer.prototype.getSource; diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js index 2a921ba3ae..a003dee694 100644 --- a/src/ol/renderer/Layer.js +++ b/src/ol/renderer/Layer.js @@ -55,7 +55,7 @@ LayerRenderer.prototype.hasFeatureAtCoordinate = FALSE; /** * Create a function that adds loaded tiles to the tile lookup. - * @param {ol.source.Tile} source Tile source. + * @param {module:ol/source/Tile~TileSource} source Tile source. * @param {module:ol/proj/Projection~Projection} projection Projection of the tiles. * @param {Object.>} tiles Lookup of loaded tiles by zoom level. * @return {function(number, module:ol/TileRange~TileRange):boolean} A function that can be @@ -135,13 +135,13 @@ LayerRenderer.prototype.renderIfReadyAndVisible = function() { /** * @param {module:ol/PluggableMap~FrameState} frameState Frame state. - * @param {ol.source.Tile} tileSource Tile source. + * @param {module:ol/source/Tile~TileSource} tileSource Tile source. * @protected */ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) { if (tileSource.canExpireCache()) { /** - * @param {ol.source.Tile} tileSource Tile source. + * @param {module:ol/source/Tile~TileSource} tileSource Tile source. * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. */ @@ -162,7 +162,7 @@ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) { /** * @param {!Object.>} usedTiles Used tiles. - * @param {ol.source.Tile} tileSource Tile source. + * @param {module:ol/source/Tile~TileSource} tileSource Tile source. * @param {number} z Z. * @param {module:ol/TileRange~TileRange} tileRange Tile range. * @protected @@ -192,7 +192,7 @@ LayerRenderer.prototype.updateUsedTiles = function(usedTiles, tileSource, z, til * discarded by the tile queue * - enqueues missing tiles * @param {module:ol/PluggableMap~FrameState} frameState Frame state. - * @param {ol.source.Tile} tileSource Tile source. + * @param {module:ol/source/Tile~TileSource} tileSource Tile source. * @param {module:ol/tilegrid/TileGrid~TileGrid} tileGrid Tile grid. * @param {number} pixelRatio Pixel ratio. * @param {module:ol/proj/Projection~Projection} projection Projection. diff --git a/src/ol/renderer/canvas/TileLayer.js b/src/ol/renderer/canvas/TileLayer.js index 040346c20a..665fe90b7a 100644 --- a/src/ol/renderer/canvas/TileLayer.js +++ b/src/ol/renderer/canvas/TileLayer.js @@ -127,7 +127,7 @@ CanvasTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState const viewCenter = viewState.center; const tileLayer = this.getLayer(); - const tileSource = /** @type {ol.source.Tile} */ (tileLayer.getSource()); + const tileSource = /** @type {module:ol/source/Tile~TileSource} */ (tileLayer.getSource()); const sourceRevision = tileSource.getRevision(); const tileGrid = tileSource.getTileGridForProjection(projection); const z = tileGrid.getZForResolution(viewResolution, this.zDirection); diff --git a/src/ol/source/Raster.js b/src/ol/source/Raster.js index 66e69c74a2..377262ebde 100644 --- a/src/ol/source/Raster.js +++ b/src/ol/source/Raster.js @@ -497,7 +497,7 @@ function createImageRenderer(source) { /** * Create a tile renderer for the provided source. - * @param {ol.source.Tile} source The source. + * @param {module:ol/source/Tile~TileSource} source The source. * @return {ol.renderer.canvas.Layer} The renderer. */ function createTileRenderer(source) { diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js index a876eb790f..643ff81108 100644 --- a/src/ol/source/Tile.js +++ b/src/ol/source/Tile.js @@ -324,7 +324,7 @@ TileSource.prototype.useTile = UNDEFINED; /** * @classdesc - * Events emitted by {@link ol.source.Tile} instances are instances of this + * Events emitted by {@link module:ol/source/Tile~TileSource} instances are instances of this * type. * * @constructor diff --git a/src/ol/source/TileDebug.js b/src/ol/source/TileDebug.js index 00de3bb4d2..eecd54bc82 100644 --- a/src/ol/source/TileDebug.js +++ b/src/ol/source/TileDebug.js @@ -92,7 +92,7 @@ LabeledTile.prototype.load = function() {}; * Uses Canvas context2d, so requires Canvas support. * * @constructor - * @extends {ol.source.Tile} + * @extends {module:ol/source/Tile~TileSource} * @param {module:ol/source/TileDebug~Options=} options Debug tile options. * @api */ diff --git a/src/ol/source/TileUTFGrid.js b/src/ol/source/TileUTFGrid.js index e0c07a17da..599c9915f5 100644 --- a/src/ol/source/TileUTFGrid.js +++ b/src/ol/source/TileUTFGrid.js @@ -271,7 +271,7 @@ CustomTile.prototype.load = function() { * Layer source for UTFGrid interaction data loaded from TileJSON format. * * @constructor - * @extends {ol.source.Tile} + * @extends {module:ol/source/Tile~TileSource} * @param {module:ol/source/TileUTFGrid~Options=} options Source options. * @api */ diff --git a/src/ol/source/UrlTile.js b/src/ol/source/UrlTile.js index d47cf1e576..216ed4e412 100644 --- a/src/ol/source/UrlTile.js +++ b/src/ol/source/UrlTile.js @@ -34,7 +34,7 @@ import {getKeyZXY} from '../tilecoord.js'; * @constructor * @abstract * @fires module:ol/source/Tile~TileSourceEvent - * @extends {ol.source.Tile} + * @extends {module:ol/source/Tile~TileSource} * @param {module:ol/source/UrlTile~Options=} options Image tile options. */ const UrlTile = function(options) {