From 2d9014ce11864e661d0535e47b215a9c992f0a71 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Mon, 19 Mar 2018 08:49:56 +0100 Subject: [PATCH] Module type for ol.PluggableMap --- src/ol/control/Control.js | 6 +++--- src/ol/control/OverviewMap.js | 4 ++-- src/ol/layer/Layer.js | 2 +- src/ol/render/Box.js | 4 ++-- src/ol/renderer/Layer.js | 2 +- src/ol/renderer/Map.js | 10 +++++----- src/ol/renderer/canvas/Map.js | 4 ++-- src/ol/renderer/webgl/Map.js | 8 ++++---- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index 9690ddcdb7..5509ae7e74 100644 --- a/src/ol/control/Control.js +++ b/src/ol/control/Control.js @@ -68,7 +68,7 @@ const Control = function(options) { /** * @private - * @type {ol.PluggableMap} + * @type {module:ol/PluggableMap~PluggableMap} */ this.map_ = null; @@ -103,7 +103,7 @@ Control.prototype.disposeInternal = function() { /** * Get the map associated with this control. - * @return {ol.PluggableMap} Map. + * @return {module:ol/PluggableMap~PluggableMap} Map. * @api */ Control.prototype.getMap = function() { @@ -115,7 +115,7 @@ Control.prototype.getMap = function() { * Remove the control from its current map and attach it to the new map. * Subclasses may set up event handlers to get notified about changes to * the map here. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @override * @api */ diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index 9f99531d00..9e79f01dd9 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -136,7 +136,7 @@ const OverviewMap = function(opt_options) { this.ovmapDiv_.className = 'ol-overviewmap-map'; /** - * @type {ol.PluggableMap} + * @type {module:ol/PluggableMap~PluggableMap} * @private */ this.ovmap_ = new PluggableMap({ @@ -588,7 +588,7 @@ OverviewMap.prototype.getCollapsed = function() { /** * Return the overview map. - * @return {ol.PluggableMap} Overview map. + * @return {module:ol/PluggableMap~PluggableMap} Overview map. * @api */ OverviewMap.prototype.getOverviewMap = function() { diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js index 5ff9445865..1d1b1d6d18 100644 --- a/src/ol/layer/Layer.js +++ b/src/ol/layer/Layer.js @@ -177,7 +177,7 @@ Layer.prototype.handleSourcePropertyChange_ = function() { * * To add the layer to a map and have it managed by the map, use * {@link ol.Map#addLayer} instead. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @api */ Layer.prototype.setMap = function(map) { diff --git a/src/ol/render/Box.js b/src/ol/render/Box.js index b7957717dd..b24bb5684d 100644 --- a/src/ol/render/Box.js +++ b/src/ol/render/Box.js @@ -30,7 +30,7 @@ const RenderBox = function(className) { /** * @private - * @type {ol.PluggableMap} + * @type {module:ol/PluggableMap~PluggableMap} */ this.map_ = null; @@ -75,7 +75,7 @@ RenderBox.prototype.render_ = function() { /** - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. */ RenderBox.prototype.setMap = function(map) { if (this.map_) { diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js index 185a3ad9fb..298bfde04d 100644 --- a/src/ol/renderer/Layer.js +++ b/src/ol/renderer/Layer.js @@ -145,7 +145,7 @@ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) { if (tileSource.canExpireCache()) { /** * @param {ol.source.Tile} tileSource Tile source. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. */ const postRenderFunction = function(tileSource, map, frameState) { diff --git a/src/ol/renderer/Map.js b/src/ol/renderer/Map.js index 205252da17..ec1b3d2f45 100644 --- a/src/ol/renderer/Map.js +++ b/src/ol/renderer/Map.js @@ -17,7 +17,7 @@ import {compose as composeTransform, invert as invertTransform, setFromArray as * @abstract * @extends {module:ol/Disposable~Disposabl} * @param {Element} container Container. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @struct */ const MapRenderer = function(container, map) { @@ -26,7 +26,7 @@ const MapRenderer = function(container, map) { /** * @private - * @type {ol.PluggableMap} + * @type {module:ol/PluggableMap~PluggableMap} */ this.map_ = map; @@ -78,7 +78,7 @@ MapRenderer.prototype.removeLayerRenderers = function() { /** - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. */ function expireIconCache(map, frameState) { @@ -246,7 +246,7 @@ MapRenderer.prototype.getLayerRenderers = function() { /** - * @return {ol.PluggableMap} Map. + * @return {module:ol/PluggableMap~PluggableMap} Map. */ MapRenderer.prototype.getMap = function() { return this.map_; @@ -293,7 +293,7 @@ MapRenderer.prototype.renderFrame = UNDEFINED; /** - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ diff --git a/src/ol/renderer/canvas/Map.js b/src/ol/renderer/canvas/Map.js index 9682475e17..51de18ecab 100644 --- a/src/ol/renderer/canvas/Map.js +++ b/src/ol/renderer/canvas/Map.js @@ -21,7 +21,7 @@ import SourceState from '../../source/State.js'; * @constructor * @extends {ol.renderer.Map} * @param {Element} container Container. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @api */ const CanvasMapRenderer = function(container, map) { @@ -76,7 +76,7 @@ CanvasMapRenderer['handles'] = function(type) { /** * Create the map renderer. * @param {Element} container Container. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @return {ol.renderer.canvas.Map} The map renderer. */ CanvasMapRenderer['create'] = function(container, map) { diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index 1768e40e47..e235de993a 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -36,7 +36,7 @@ const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024; * @constructor * @extends {ol.renderer.Map} * @param {Element} container Container. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @api */ const WebGLMapRenderer = function(container, map) { @@ -141,7 +141,7 @@ const WebGLMapRenderer = function(container, map) { /** - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {?module:ol/PluggableMap~FrameState} frameState Frame state. * @return {boolean} false. * @this {ol.renderer.webgl.Map} @@ -186,7 +186,7 @@ WebGLMapRenderer['handles'] = function(type) { /** * Create the map renderer. * @param {Element} container Container. - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @return {ol.renderer.webgl.Map} The map renderer. */ WebGLMapRenderer['create'] = function(container, map) { @@ -310,7 +310,7 @@ WebGLMapRenderer.prototype.disposeInternal = function() { /** - * @param {ol.PluggableMap} map Map. + * @param {module:ol/PluggableMap~PluggableMap} map Map. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */