From b4588f7d471d569519fdc3eea58848c0b6151472 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Wed, 25 Apr 2018 13:41:08 +0200 Subject: [PATCH 1/5] Module type for ol.source.UrlTile --- src/ol/source/TileImage.js | 2 +- src/ol/source/VectorTile.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/ol/source/TileImage.js b/src/ol/source/TileImage.js index 63b4ddb053..7f86a95792 100644 --- a/src/ol/source/TileImage.js +++ b/src/ol/source/TileImage.js @@ -60,7 +60,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js'; * * @constructor * @fires module:ol/source/Tile~TileSourceEvent - * @extends {ol.source.UrlTile} + * @extends {module:ol/source/UrlTile} * @param {module:ol/source/TileImage~Options=} options Image tile options. * @api */ diff --git a/src/ol/source/VectorTile.js b/src/ol/source/VectorTile.js index a217d5633a..b1ec94a92c 100644 --- a/src/ol/source/VectorTile.js +++ b/src/ol/source/VectorTile.js @@ -64,7 +64,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid. * * @constructor * @fires module:ol/source/Tile~TileSourceEvent - * @extends {ol.source.UrlTile} + * @extends {module:ol/source/UrlTile} * @param {module:ol/source/VectorTile~Options=} options Vector tile options. * @api */ From 76769f990131135e4f8f2a77b1f0b64410f2f83f Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Wed, 25 Apr 2018 13:48:31 +0200 Subject: [PATCH 2/5] Module type for ol.struct.* --- src/ol/render/canvas.js | 2 +- src/ol/render/webgl/PolygonReplay.js | 50 ++++++++++++++-------------- src/ol/renderer/webgl/Map.js | 6 ++-- src/ol/source/Vector.js | 4 +-- src/ol/structs/LRUCache.js | 2 +- src/ol/structs/LinkedList.js | 2 +- src/ol/structs/RBush.js | 2 +- 7 files changed, 34 insertions(+), 34 deletions(-) diff --git a/src/ol/render/canvas.js b/src/ol/render/canvas.js index ef8c6a2983..ddfe1105b3 100644 --- a/src/ol/render/canvas.js +++ b/src/ol/render/canvas.js @@ -156,7 +156,7 @@ export const defaultLineWidth = 1; /** * The label cache for text rendering. To change the default cache size of 2048 * entries, use {@link ol.structs.LRUCache#setSize}. - * @type {ol.structs.LRUCache.} + * @type {module:ol/structs/LRUCache.} * @api */ export const labelCache = new LRUCache(); diff --git a/src/ol/render/webgl/PolygonReplay.js b/src/ol/render/webgl/PolygonReplay.js index f03e2673fa..e684c05fc5 100644 --- a/src/ol/render/webgl/PolygonReplay.js +++ b/src/ol/render/webgl/PolygonReplay.js @@ -150,8 +150,8 @@ WebGLPolygonReplay.prototype.drawCoordinates_ = function( * @private * @param {Array.} flatCoordinates Flat coordinates. * @param {number} stride Stride. - * @param {ol.structs.LinkedList} list Linked list. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @param {boolean} clockwise Coordinate order should be clockwise. */ WebGLPolygonReplay.prototype.processFlatCoordinates_ = function( @@ -203,7 +203,7 @@ WebGLPolygonReplay.prototype.processFlatCoordinates_ = function( /** * Returns the rightmost coordinates of a polygon on the X axis. * @private - * @param {ol.structs.LinkedList} list Polygons ring. + * @param {module:ol/structs/LinkedList} list Polygons ring. * @return {Array.} Max X coordinates. */ WebGLPolygonReplay.prototype.getMaxCoords_ = function(list) { @@ -225,8 +225,8 @@ WebGLPolygonReplay.prototype.getMaxCoords_ = function(list) { /** * Classifies the points of a polygon list as convex, reflex. Removes collinear vertices. * @private - * @param {ol.structs.LinkedList} list Polygon ring. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Polygon ring. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @param {boolean} ccw The orientation of the polygon is counter-clockwise. * @return {boolean} There were reclassified points. */ @@ -261,11 +261,11 @@ WebGLPolygonReplay.prototype.classifyPoints_ = function(list, rtree, ccw) { /** * @private - * @param {ol.structs.LinkedList} hole Linked list of the hole. + * @param {module:ol/structs/LinkedList} hole Linked list of the hole. * @param {number} holeMaxX Maximum X value of the hole. - * @param {ol.structs.LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. * @param {number} listMaxX Maximum X value of the polygon. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @return {boolean} Bridging was successful. */ WebGLPolygonReplay.prototype.bridgeHole_ = function(hole, holeMaxX, @@ -338,8 +338,8 @@ WebGLPolygonReplay.prototype.bridgeHole_ = function(hole, holeMaxX, /** * @private - * @param {ol.structs.LinkedList} list Linked list of the polygon. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. */ WebGLPolygonReplay.prototype.triangulate_ = function(list, rtree) { let ccw = false; @@ -388,8 +388,8 @@ WebGLPolygonReplay.prototype.triangulate_ = function(list, rtree) { /** * @private - * @param {ol.structs.LinkedList} list Linked list of the polygon. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @param {boolean} simple The polygon is simple. * @param {boolean} ccw Orientation of the polygon is counter-clockwise. * @return {boolean} There were processed ears. @@ -447,8 +447,8 @@ WebGLPolygonReplay.prototype.clipEars_ = function(list, rtree, simple, ccw) { /** * @private - * @param {ol.structs.LinkedList} list Linked list of the polygon. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @param {boolean=} opt_touch Resolve touching segments. * @return {boolean} There were resolved intersections. */ @@ -516,8 +516,8 @@ WebGLPolygonReplay.prototype.resolveSelfIntersections_ = function( /** * @private - * @param {ol.structs.LinkedList} list Linked list of the polygon. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @return {boolean} The polygon is simple. */ WebGLPolygonReplay.prototype.isSimple_ = function(list, rtree) { @@ -535,7 +535,7 @@ WebGLPolygonReplay.prototype.isSimple_ = function(list, rtree) { /** * @private - * @param {ol.structs.LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. * @return {boolean} Orientation is clockwise. */ WebGLPolygonReplay.prototype.isClockwise_ = function(list) { @@ -555,8 +555,8 @@ WebGLPolygonReplay.prototype.isClockwise_ = function(list) { /** * @private - * @param {ol.structs.LinkedList} list Linked list of the polygon. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Linked list of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. */ WebGLPolygonReplay.prototype.splitPolygon_ = function(list, rtree) { const start = list.firstItem(); @@ -623,8 +623,8 @@ WebGLPolygonReplay.prototype.createPoint_ = function(x, y, i) { * @private * @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p0 First point of segment. * @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p1 Second point of segment. - * @param {ol.structs.LinkedList} list Polygon ring. - * @param {ol.structs.RBush=} opt_rtree Insert the segment into the R-Tree. + * @param {module:ol/structs/LinkedList} list Polygon ring. + * @param {module:ol/structs/RBush=} opt_rtree Insert the segment into the R-Tree. * @return {module:ol/render/webgl/PolygonReplay~PolygonSegment} segment. */ WebGLPolygonReplay.prototype.insertItem_ = function(p0, p1, list, opt_rtree) { @@ -645,8 +645,8 @@ WebGLPolygonReplay.prototype.insertItem_ = function(p0, p1, list, opt_rtree) { * @private * @param {module:ol/render/webgl/PolygonReplay~PolygonSegment} s0 Segment before the remove candidate. * @param {module:ol/render/webgl/PolygonReplay~PolygonSegment} s1 Remove candidate segment. - * @param {ol.structs.LinkedList} list Polygon ring. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/LinkedList} list Polygon ring. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. */ WebGLPolygonReplay.prototype.removeItem_ = function(s0, s1, list, rtree) { if (list.getCurrItem() === s1) { @@ -664,7 +664,7 @@ WebGLPolygonReplay.prototype.removeItem_ = function(s0, s1, list, rtree) { * @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p0 First point. * @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p1 Second point. * @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p2 Third point. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @param {boolean=} opt_reflex Only include reflex points. * @return {Array.} Points in the triangle. */ @@ -692,7 +692,7 @@ WebGLPolygonReplay.prototype.getPointsInTriangle_ = function(p0, p1, p2, rtree, /** * @private * @param {module:ol/render/webgl/PolygonReplay~PolygonSegment} segment Segment. - * @param {ol.structs.RBush} rtree R-Tree of the polygon. + * @param {module:ol/structs/RBush} rtree R-Tree of the polygon. * @param {boolean=} opt_touch Touching segments should be considered an intersection. * @return {Array.} Intersecting segments. */ diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index 61c90a323b..c352e8aaa3 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -110,7 +110,7 @@ const WebGLMapRenderer = function(map) { /** * @private - * @type {ol.structs.LRUCache.} + * @type {module:ol/structs/LRUCache.} */ this.textureCache_ = new LRUCache(); @@ -122,7 +122,7 @@ const WebGLMapRenderer = function(map) { /** * @private - * @type {ol.structs.PriorityQueue.} + * @type {module:ol/structs/PriorityQueue.} */ this.tileTextureQueue_ = new PriorityQueue( /** @@ -339,7 +339,7 @@ WebGLMapRenderer.prototype.getGL = function() { /** - * @return {ol.structs.PriorityQueue.} Tile texture queue. + * @return {module:ol/structs/PriorityQueue.} Tile texture queue. */ WebGLMapRenderer.prototype.getTileTextureQueue = function() { return this.tileTextureQueue_; diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 6630d69832..0f93342361 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -209,13 +209,13 @@ const VectorSource = function(opt_options) { /** * @private - * @type {ol.structs.RBush.} + * @type {module:ol/structs/RBush.} */ this.featuresRtree_ = useSpatialIndex ? new RBush() : null; /** * @private - * @type {ol.structs.RBush.<{extent: module:ol/extent~Extent}>} + * @type {module:ol/structs/RBush.<{extent: module:ol/extent~Extent}>} */ this.loadedExtentsRtree_ = new RBush(); diff --git a/src/ol/structs/LRUCache.js b/src/ol/structs/LRUCache.js index 8ab9d71028..c242e1e775 100644 --- a/src/ol/structs/LRUCache.js +++ b/src/ol/structs/LRUCache.js @@ -95,7 +95,7 @@ LRUCache.prototype.containsKey = function(key) { /** - * @param {function(this: S, T, string, ol.structs.LRUCache): ?} f The function + * @param {function(this: S, T, string, module:ol/structs/LRUCache): ?} f The function * to call for every entry from the oldest to the newer. This function takes * 3 arguments (the entry value, the entry key and the LRUCache object). * The return value is ignored. diff --git a/src/ol/structs/LinkedList.js b/src/ol/structs/LinkedList.js index e67e2d9a1a..3dd630bbed 100644 --- a/src/ol/structs/LinkedList.js +++ b/src/ol/structs/LinkedList.js @@ -225,7 +225,7 @@ LinkedList.prototype.setFirstItem = function() { /** * Concatenates two lists. - * @param {ol.structs.LinkedList} list List to merge into the current list. + * @param {module:ol/structs/LinkedList} list List to merge into the current list. */ LinkedList.prototype.concat = function(list) { if (list.head_) { diff --git a/src/ol/structs/RBush.js b/src/ol/structs/RBush.js index 038435d4e4..ae57c7b486 100644 --- a/src/ol/structs/RBush.js +++ b/src/ol/structs/RBush.js @@ -227,7 +227,7 @@ RBush.prototype.getExtent = function(opt_extent) { /** - * @param {ol.structs.RBush} rbush R-Tree. + * @param {module:ol/structs/RBush} rbush R-Tree. */ RBush.prototype.concat = function(rbush) { this.rbush_.load(rbush.rbush_.all()); From d8e0212833f921196656b8189c538316440e3eed Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Wed, 25 Apr 2018 13:54:44 +0200 Subject: [PATCH 3/5] Module type for ol.source.* --- src/ol/source/ImageArcGISRest.js | 2 +- src/ol/source/ImageWMS.js | 6 +++--- src/ol/source/TileWMS.js | 6 +++--- src/ol/source/WMTS.js | 8 ++++---- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/ol/source/ImageArcGISRest.js b/src/ol/source/ImageArcGISRest.js index 95969a5949..c29b59a714 100644 --- a/src/ol/source/ImageArcGISRest.js +++ b/src/ol/source/ImageArcGISRest.js @@ -46,7 +46,7 @@ import {appendParams} from '../uri.js'; * * If underlying map service is not using labels, * take advantage of ol image caching and use - * {@link ol.source.TileArcGISRest} data source. + * {@link module:ol/source/TileArcGISRest} data source. * * @constructor * @fires ol.source.Image.Event diff --git a/src/ol/source/ImageWMS.js b/src/ol/source/ImageWMS.js index 17c5d42047..820a41e798 100644 --- a/src/ol/source/ImageWMS.js +++ b/src/ol/source/ImageWMS.js @@ -26,7 +26,7 @@ import {appendParams} from '../uri.js'; * {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail. * @property {boolean} [hidpi=true] Use the `ol.Map#pixelRatio` value when requesting * the image from the remote server. - * @property {ol.source.WMSServerType|string} [serverType] The type of + * @property {module:ol/source/WMSServerType|string} [serverType] The type of * the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only needed if `hidpi` is `true`. * @property {ol.ImageLoadFunctionType} [imageLoadFunction] Optional function to load an image given a URL. * @property {Object.} params WMS request parameters. @@ -98,9 +98,9 @@ const ImageWMS = function(opt_options) { /** * @private - * @type {ol.source.WMSServerType|undefined} + * @type {module:ol/source/WMSServerType|undefined} */ - this.serverType_ = /** @type {ol.source.WMSServerType|undefined} */ (options.serverType); + this.serverType_ = /** @type {module:ol/source/WMSServerType|undefined} */ (options.serverType); /** * @private diff --git a/src/ol/source/TileWMS.js b/src/ol/source/TileWMS.js index 5a92a0638b..b6f2495480 100644 --- a/src/ol/source/TileWMS.js +++ b/src/ol/source/TileWMS.js @@ -50,7 +50,7 @@ import {appendParams} from '../uri.js'; * If this is not defined, a default grid will be used: if there is a projection * extent, the grid will be based on that; if not, a grid based on a global * extent with origin at 0,0 will be used.. - * @property {ol.source.WMSServerType|string} [serverType] + * @property {module:ol/source/WMSServerType|string} [serverType] * The type of the remote WMS server. Currently only used when `hidpi` is * `true`. * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is @@ -124,9 +124,9 @@ const TileWMS = function(opt_options) { /** * @private - * @type {ol.source.WMSServerType|undefined} + * @type {module:ol/source/WMSServerType|undefined} */ - this.serverType_ = /** @type {ol.source.WMSServerType|undefined} */ (options.serverType); + this.serverType_ = /** @type {module:ol/source/WMSServerType|undefined} */ (options.serverType); /** * @private diff --git a/src/ol/source/WMTS.js b/src/ol/source/WMTS.js index f0b9e1c4df..acb0b9c2b8 100644 --- a/src/ol/source/WMTS.js +++ b/src/ol/source/WMTS.js @@ -24,7 +24,7 @@ import {appendParams} from '../uri.js'; * @property {module:ol/proj~ProjectionLike} projection Projection. * @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * Higher values can increase reprojection performance, but decrease precision. - * @property {ol.source.WMTSRequestEncoding|string} [requestEncoding='KVP'] Request encoding. + * @property {module:ol/source/WMTSRequestEncoding|string} [requestEncoding='KVP'] Request encoding. * @property {string} layer Layer name as advertised in the WMTS capabilities. * @property {string} style Style name as advertised in the WMTS capabilities. * @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. Default is {@link module:ol/ImageTile~ImageTile}. @@ -115,10 +115,10 @@ const WMTS = function(options) { /** * @private - * @type {ol.source.WMTSRequestEncoding} + * @type {module:ol/source/WMTSRequestEncoding} */ this.requestEncoding_ = options.requestEncoding !== undefined ? - /** @type {ol.source.WMTSRequestEncoding} */ (options.requestEncoding) : + /** @type {module:ol/source/WMTSRequestEncoding} */ (options.requestEncoding) : WMTSRequestEncoding.KVP; const requestEncoding = this.requestEncoding_; @@ -276,7 +276,7 @@ WMTS.prototype.getMatrixSet = function() { /** * Return the request encoding, either "KVP" or "REST". - * @return {ol.source.WMTSRequestEncoding} Request encoding. + * @return {module:ol/source/WMTSRequestEncoding} Request encoding. * @api */ WMTS.prototype.getRequestEncoding = function() { From 11d9f6de83232549edfc1a6dda719a71920fa5c4 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Wed, 25 Apr 2018 14:07:56 +0200 Subject: [PATCH 4/5] Module type for ol.renderer.* --- src/ol/PluggableMap.js | 4 ++-- src/ol/renderer/Map.js | 10 +++++----- src/ol/renderer/canvas/ImageLayer.js | 10 +++++----- src/ol/renderer/canvas/IntermediateCanvas.js | 2 +- src/ol/renderer/canvas/Layer.js | 2 +- src/ol/renderer/canvas/Map.js | 6 +++--- src/ol/renderer/canvas/TileLayer.js | 6 +++--- src/ol/renderer/canvas/VectorLayer.js | 8 ++++---- src/ol/renderer/canvas/VectorTileLayer.js | 10 +++++----- src/ol/renderer/webgl/ImageLayer.js | 10 +++++----- src/ol/renderer/webgl/Layer.js | 8 ++++---- src/ol/renderer/webgl/Map.js | 14 +++++++------- src/ol/renderer/webgl/TileLayer.js | 12 ++++++------ src/ol/renderer/webgl/VectorLayer.js | 12 ++++++------ src/ol/source/Raster.js | 14 +++++++------- 15 files changed, 64 insertions(+), 64 deletions(-) diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 426b6a9c3f..e164eb096a 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -336,7 +336,7 @@ const PluggableMap = function(options) { this.overlayIdIndex_ = {}; /** - * @type {module:ol/renderer/Map~Map} + * @type {module:ol/renderer/Map} * @private */ this.renderer_ = this.createRenderer(this.viewport_, this); @@ -831,7 +831,7 @@ PluggableMap.prototype.getPixelFromCoordinate = function(coordinate) { /** * Get the map renderer. - * @return {module:ol/renderer/Map~Map} Renderer + * @return {module:ol/renderer/Map} Renderer */ PluggableMap.prototype.getRenderer = function() { return this.renderer_; diff --git a/src/ol/renderer/Map.js b/src/ol/renderer/Map.js index fcd060d42e..5c8f99e405 100644 --- a/src/ol/renderer/Map.js +++ b/src/ol/renderer/Map.js @@ -30,7 +30,7 @@ const MapRenderer = function(map) { /** * @private - * @type {!Object.} + * @type {!Object.} */ this.layerRenderers_ = {}; @@ -219,7 +219,7 @@ MapRenderer.prototype.hasFeatureAtCoordinate = function(coordinate, frameState, /** * @param {module:ol/layer/Layer} layer Layer. * @protected - * @return {ol.renderer.Layer} Layer renderer. + * @return {module:ol/renderer/Layer} Layer renderer. */ MapRenderer.prototype.getLayerRenderer = function(layer) { const layerKey = getUid(layer).toString(); @@ -249,7 +249,7 @@ MapRenderer.prototype.getLayerRenderer = function(layer) { /** * @param {string} layerKey Layer key. * @protected - * @return {ol.renderer.Layer} Layer renderer. + * @return {module:ol/renderer/Layer} Layer renderer. */ MapRenderer.prototype.getLayerRendererByKey = function(layerKey) { return this.layerRenderers_[layerKey]; @@ -258,7 +258,7 @@ MapRenderer.prototype.getLayerRendererByKey = function(layerKey) { /** * @protected - * @return {Object.} Layer renderers. + * @return {Object.} Layer renderers. */ MapRenderer.prototype.getLayerRenderers = function() { return this.layerRenderers_; @@ -284,7 +284,7 @@ MapRenderer.prototype.handleLayerRendererChange_ = function() { /** * @param {string} layerKey Layer key. - * @return {ol.renderer.Layer} Layer renderer. + * @return {module:ol/renderer/Layer} Layer renderer. * @private */ MapRenderer.prototype.removeLayerRendererByKey_ = function(layerKey) { diff --git a/src/ol/renderer/canvas/ImageLayer.js b/src/ol/renderer/canvas/ImageLayer.js index 55d2e5cee0..f0d7ab9d0d 100644 --- a/src/ol/renderer/canvas/ImageLayer.js +++ b/src/ol/renderer/canvas/ImageLayer.js @@ -15,7 +15,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran /** * @constructor - * @extends {ol.renderer.canvas.IntermediateCanvas} + * @extends {module:ol/renderer/canvas/IntermediateCanvas} * @param {module:ol/layer/Image} imageLayer Single image layer. * @api */ @@ -42,7 +42,7 @@ const CanvasImageLayerRenderer = function(imageLayer) { /** * @private - * @type {ol.renderer.canvas.VectorLayer} + * @type {module:ol/renderer/canvas/VectorLayer} */ this.vectorRenderer_ = null; @@ -65,9 +65,9 @@ CanvasImageLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.canvas.ImageLayer} The layer renderer. + * @return {module:ol/renderer/canvas/ImageLayer} The layer renderer. */ CanvasImageLayerRenderer['create'] = function(mapRenderer, layer) { const renderer = new CanvasImageLayerRenderer(/** @type {module:ol/layer/Image} */ (layer)); @@ -216,7 +216,7 @@ CanvasImageLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordin /** - * @param {ol.renderer.canvas.VectorLayer} renderer Vector renderer. + * @param {module:ol/renderer/canvas/VectorLayer} renderer Vector renderer. */ CanvasImageLayerRenderer.prototype.setVectorRenderer = function(renderer) { if (this.vectorRenderer_) { diff --git a/src/ol/renderer/canvas/IntermediateCanvas.js b/src/ol/renderer/canvas/IntermediateCanvas.js index 50db20647b..42047c9e50 100644 --- a/src/ol/renderer/canvas/IntermediateCanvas.js +++ b/src/ol/renderer/canvas/IntermediateCanvas.js @@ -12,7 +12,7 @@ import {create as createTransform, apply as applyTransform} from '../../transfor /** * @constructor * @abstract - * @extends {ol.renderer.canvas.Layer} + * @extends {module:ol/renderer/canvas/Layer} * @param {module:ol/layer/Layer} layer Layer. */ const IntermediateCanvasRenderer = function(layer) { diff --git a/src/ol/renderer/canvas/Layer.js b/src/ol/renderer/canvas/Layer.js index aaa882b67c..415fbb06cd 100644 --- a/src/ol/renderer/canvas/Layer.js +++ b/src/ol/renderer/canvas/Layer.js @@ -14,7 +14,7 @@ import {create as createTransform, apply as applyTransform, compose as composeTr /** * @constructor * @abstract - * @extends {ol.renderer.Layer} + * @extends {module:ol/renderer/Layer} * @param {module:ol/layer/Layer} layer Layer. */ const CanvasLayerRenderer = function(layer) { diff --git a/src/ol/renderer/canvas/Map.js b/src/ol/renderer/canvas/Map.js index e0296d5a18..6e3f02202c 100644 --- a/src/ol/renderer/canvas/Map.js +++ b/src/ol/renderer/canvas/Map.js @@ -16,7 +16,7 @@ import SourceState from '../../source/State.js'; /** * @constructor - * @extends {ol.renderer.Map} + * @extends {module:ol/renderer/Map} * @param {module:ol/PluggableMap} map Map. * @api */ @@ -146,7 +146,7 @@ CanvasMapRenderer.prototype.renderFrame = function(frameState) { for (i = 0, ii = layerStatesArray.length; i < ii; ++i) { layerState = layerStatesArray[i]; layer = layerState.layer; - layerRenderer = /** @type {ol.renderer.canvas.Layer} */ (this.getLayerRenderer(layer)); + layerRenderer = /** @type {module:ol/renderer/canvas/Layer} */ (this.getLayerRenderer(layer)); if (!visibleAtResolution(layerState, viewResolution) || layerState.sourceState != SourceState.READY) { continue; @@ -192,7 +192,7 @@ CanvasMapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, ca const layerState = layerStates[i]; const layer = layerState.layer; if (visibleAtResolution(layerState, viewResolution) && layerFilter.call(thisArg2, layer)) { - const layerRenderer = /** @type {ol.renderer.canvas.Layer} */ (this.getLayerRenderer(layer)); + const layerRenderer = /** @type {module:ol/renderer/canvas/Layer} */ (this.getLayerRenderer(layer)); result = layerRenderer.forEachLayerAtCoordinate( coordinate, frameState, callback, thisArg); if (result) { diff --git a/src/ol/renderer/canvas/TileLayer.js b/src/ol/renderer/canvas/TileLayer.js index 92897c08d5..0186df60fa 100644 --- a/src/ol/renderer/canvas/TileLayer.js +++ b/src/ol/renderer/canvas/TileLayer.js @@ -13,7 +13,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran /** * @constructor - * @extends {ol.renderer.canvas.IntermediateCanvas} + * @extends {module:ol/renderer/canvas/IntermediateCanvas} * @param {module:ol/layer/Tile|module:ol/layer/VectorTile~VectorTile} tileLayer Tile layer. * @api */ @@ -92,9 +92,9 @@ CanvasTileLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.canvas.TileLayer} The layer renderer. + * @return {module:ol/renderer/canvas/TileLayer} The layer renderer. */ CanvasTileLayerRenderer['create'] = function(mapRenderer, layer) { return new CanvasTileLayerRenderer(/** @type {module:ol/layer/Tile} */ (layer)); diff --git a/src/ol/renderer/canvas/VectorLayer.js b/src/ol/renderer/canvas/VectorLayer.js index 6fee04b3c0..bd3af95e42 100644 --- a/src/ol/renderer/canvas/VectorLayer.js +++ b/src/ol/renderer/canvas/VectorLayer.js @@ -17,7 +17,7 @@ import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance, /** * @constructor - * @extends {ol.renderer.canvas.Layer} + * @extends {module:ol/renderer/canvas/Layer} * @param {module:ol/layer/Vector} vectorLayer Vector layer. * @api */ @@ -97,9 +97,9 @@ CanvasVectorLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.canvas.VectorLayer} The layer renderer. + * @return {module:ol/renderer/canvas/VectorLayer} The layer renderer. */ CanvasVectorLayerRenderer['create'] = function(mapRenderer, layer) { return new CanvasVectorLayerRenderer(/** @type {module:ol/layer/Vector} */ (layer)); @@ -357,7 +357,7 @@ CanvasVectorLayerRenderer.prototype.prepareFrame = function(frameState, layerSta vectorSource.loadFeatures(extent, resolution, projection); /** * @param {module:ol/Feature} feature Feature. - * @this {ol.renderer.canvas.VectorLayer} + * @this {module:ol/renderer/canvas/VectorLayer} */ const render = function(feature) { let styles; diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 768ccb5a65..3980de6252 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -49,7 +49,7 @@ const VECTOR_REPLAYS = { /** * @constructor - * @extends {ol.renderer.canvas.TileLayer} + * @extends {module:ol/renderer/canvas/TileLayer} * @param {module:ol/layer/VectorTile~VectorTile} layer VectorTile layer. * @api */ @@ -108,9 +108,9 @@ CanvasVectorTileLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.canvas.VectorTileLayer} The layer renderer. + * @return {module:ol/renderer/canvas/VectorTileLayer} The layer renderer. */ CanvasVectorTileLayerRenderer['create'] = function(mapRenderer, layer) { return new CanvasVectorTileLayerRenderer(/** @type {module:ol/layer/VectorTile~VectorTile} */ (layer)); @@ -195,8 +195,8 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram const squaredTolerance = getSquaredRenderTolerance(resolution, pixelRatio); /** - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - * @this {ol.renderer.canvas.VectorTileLayer} + * @param {module:ol/Feature|module:ol/render/Feature~RenderFeature} feature Feature. + * @this {module:ol/renderer/canvas/VectorTileLayer} */ const render = function(feature) { let styles; diff --git a/src/ol/renderer/webgl/ImageLayer.js b/src/ol/renderer/webgl/ImageLayer.js index 4e28e90d88..6616a3a349 100644 --- a/src/ol/renderer/webgl/ImageLayer.js +++ b/src/ol/renderer/webgl/ImageLayer.js @@ -24,8 +24,8 @@ import {createTexture} from '../../webgl/Context.js'; /** * @constructor - * @extends {ol.renderer.webgl.Layer} - * @param {ol.renderer.webgl.Map} mapRenderer Map renderer. + * @extends {module:ol/renderer/webgl/Layer} + * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/layer/Image} imageLayer Tile layer. * @api */ @@ -69,13 +69,13 @@ WebGLImageLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.webgl.ImageLayer} The layer renderer. + * @return {module:ol/renderer/webgl/ImageLayer} The layer renderer. */ WebGLImageLayerRenderer['create'] = function(mapRenderer, layer) { return new WebGLImageLayerRenderer( - /** @type {ol.renderer.webgl.Map} */ (mapRenderer), + /** @type {module:ol/renderer/webgl/Map} */ (mapRenderer), /** @type {module:ol/layer/Image} */ (layer) ); }; diff --git a/src/ol/renderer/webgl/Layer.js b/src/ol/renderer/webgl/Layer.js index 27afbfe694..9575e19eaf 100644 --- a/src/ol/renderer/webgl/Layer.js +++ b/src/ol/renderer/webgl/Layer.js @@ -18,8 +18,8 @@ import {createEmptyTexture} from '../../webgl/Context.js'; /** * @constructor * @abstract - * @extends {ol.renderer.Layer} - * @param {ol.renderer.webgl.Map} mapRenderer Map renderer. + * @extends {module:ol/renderer/Layer} + * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/layer/Layer} layer Layer. */ const WebGLLayerRenderer = function(mapRenderer, layer) { @@ -28,7 +28,7 @@ const WebGLLayerRenderer = function(mapRenderer, layer) { /** * @protected - * @type {ol.renderer.webgl.Map} + * @type {module:ol/renderer/webgl/Map} */ this.mapRenderer = mapRenderer; @@ -81,7 +81,7 @@ const WebGLLayerRenderer = function(mapRenderer, layer) { /** * @private - * @type {ol.renderer.webgl.defaultmapshader.Locations} + * @type {module:ol/renderer/webgl/defaultmapshader/Locations} */ this.defaultLocations_ = null; diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index c352e8aaa3..365b86294c 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -40,7 +40,7 @@ const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024; /** * @constructor - * @extends {ol.renderer.Map} + * @extends {module:ol/renderer/Map} * @param {module:ol/PluggableMap} map Map. * @api */ @@ -128,7 +128,7 @@ const WebGLMapRenderer = function(map) { /** * @param {Array.<*>} element Element. * @return {number} Priority. - * @this {ol.renderer.webgl.Map} + * @this {module:ol/renderer/webgl/Map} */ function(element) { const tileCenter = /** @type {module:ol/coordinate~Coordinate} */ (element[1]); @@ -153,7 +153,7 @@ const WebGLMapRenderer = function(map) { * @param {module:ol/PluggableMap} map Map. * @param {?module:ol/PluggableMap~FrameState} frameState Frame state. * @return {boolean} false. - * @this {ol.renderer.webgl.Map} + * @this {module:ol/renderer/webgl/Map} */ this.loadNextTileTexture_ = function(map, frameState) { @@ -357,7 +357,7 @@ WebGLMapRenderer.prototype.handleWebGLContextLost = function(event) { const renderers = this.getLayerRenderers(); for (const id in renderers) { - const renderer = /** @type {ol.renderer.webgl.Layer} */ (renderers[id]); + const renderer = /** @type {module:ol/renderer/webgl/Layer} */ (renderers[id]); renderer.handleWebGLContextLost(); } }; @@ -435,7 +435,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) { layerState = layerStatesArray[i]; if (visibleAtResolution(layerState, viewResolution) && layerState.sourceState == SourceState.READY) { - layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layerState.layer)); + layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layerState.layer)); if (layerRenderer.prepareFrame(frameState, layerState, context)) { layerStatesToDraw.push(layerState); } @@ -458,7 +458,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) { for (i = 0, ii = layerStatesToDraw.length; i < ii; ++i) { layerState = layerStatesToDraw[i]; - layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layerState.layer)); + layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layerState.layer)); layerRenderer.composeFrame(frameState, layerState, context); } @@ -574,7 +574,7 @@ WebGLMapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, cal const layer = layerState.layer; if (visibleAtResolution(layerState, viewState.resolution) && layerFilter.call(thisArg, layer)) { - const layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layer)); + const layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layer)); result = layerRenderer.forEachLayerAtPixel( pixel, frameState, callback, thisArg); if (result) { diff --git a/src/ol/renderer/webgl/TileLayer.js b/src/ol/renderer/webgl/TileLayer.js index 27d2e9ad0a..99abeed883 100644 --- a/src/ol/renderer/webgl/TileLayer.js +++ b/src/ol/renderer/webgl/TileLayer.js @@ -27,8 +27,8 @@ import WebGLBuffer from '../../webgl/Buffer.js'; /** * @constructor - * @extends {ol.renderer.webgl.Layer} - * @param {ol.renderer.webgl.Map} mapRenderer Map renderer. + * @extends {module:ol/renderer/webgl/Layer} + * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/layer/Tile} tileLayer Tile layer. * @api */ @@ -50,7 +50,7 @@ const WebGLTileLayerRenderer = function(mapRenderer, tileLayer) { /** * @private - * @type {ol.renderer.webgl.tilelayershader.Locations} + * @type {module:ol/renderer/webgl/tilelayershader/Locations} */ this.locations_ = null; @@ -106,13 +106,13 @@ WebGLTileLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.webgl.TileLayer} The layer renderer. + * @return {module:ol/renderer/webgl/TileLayer} The layer renderer. */ WebGLTileLayerRenderer['create'] = function(mapRenderer, layer) { return new WebGLTileLayerRenderer( - /** @type {ol.renderer.webgl.Map} */ (mapRenderer), + /** @type {module:ol/renderer/webgl/Map} */ (mapRenderer), /** @type {module:ol/layer/Tile} */ (layer) ); }; diff --git a/src/ol/renderer/webgl/VectorLayer.js b/src/ol/renderer/webgl/VectorLayer.js index 3466b685fe..0764e82f2d 100644 --- a/src/ol/renderer/webgl/VectorLayer.js +++ b/src/ol/renderer/webgl/VectorLayer.js @@ -12,8 +12,8 @@ import {apply as applyTransform} from '../../transform.js'; /** * @constructor - * @extends {ol.renderer.webgl.Layer} - * @param {ol.renderer.webgl.Map} mapRenderer Map renderer. + * @extends {module:ol/renderer/webgl/Layer} + * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/layer/Vector} vectorLayer Vector layer. * @api */ @@ -81,13 +81,13 @@ WebGLVectorLayerRenderer['handles'] = function(layer) { /** * Create a layer renderer. - * @param {ol.renderer.Map} mapRenderer The map renderer. + * @param {module:ol/renderer/Map} mapRenderer The map renderer. * @param {module:ol/layer/Layer} layer The layer to be rendererd. - * @return {ol.renderer.webgl.VectorLayer} The layer renderer. + * @return {module:ol/renderer/webgl/VectorLayer} The layer renderer. */ WebGLVectorLayerRenderer['create'] = function(mapRenderer, layer) { return new WebGLVectorLayerRenderer( - /** @type {ol.renderer.webgl.Map} */ (mapRenderer), + /** @type {module:ol/renderer/webgl/Map} */ (mapRenderer), /** @type {module:ol/layer/Vector} */ (layer) ); }; @@ -260,7 +260,7 @@ WebGLVectorLayerRenderer.prototype.prepareFrame = function(frameState, layerStat vectorSource.loadFeatures(extent, resolution, projection); /** * @param {module:ol/Feature} feature Feature. - * @this {ol.renderer.webgl.VectorLayer} + * @this {module:ol/renderer/webgl/VectorLayer} */ const render = function(feature) { let styles; diff --git a/src/ol/source/Raster.js b/src/ol/source/Raster.js index cd7050ef9d..73f804154e 100644 --- a/src/ol/source/Raster.js +++ b/src/ol/source/Raster.js @@ -156,7 +156,7 @@ const RasterSource = function(options) { /** * @private - * @type {Array.} + * @type {Array.} */ this.renderers_ = createRenderers(options.sources); @@ -415,7 +415,7 @@ let sharedContext = null; /** * Get image data from a renderer. - * @param {ol.renderer.canvas.Layer} renderer Layer renderer. + * @param {module:ol/renderer/canvas/Layer} renderer Layer renderer. * @param {module:ol/PluggableMap~FrameState} frameState The frame state. * @param {module:ol/layer/Layer~State} layerState The layer state. * @return {ImageData} The image data. @@ -443,7 +443,7 @@ function getImageData(renderer, frameState, layerState) { /** * Get a list of layer states from a list of renderers. - * @param {Array.} renderers Layer renderers. + * @param {Array.} renderers Layer renderers. * @return {Array.} The layer states. */ function getLayerStatesArray(renderers) { @@ -456,7 +456,7 @@ function getLayerStatesArray(renderers) { /** * Create renderers for all sources. * @param {Array.} sources The sources. - * @return {Array.} Array of layer renderers. + * @return {Array.} Array of layer renderers. */ function createRenderers(sources) { const len = sources.length; @@ -471,7 +471,7 @@ function createRenderers(sources) { /** * Create a renderer for the provided source. * @param {module:ol/source/Source} source The source. - * @return {ol.renderer.canvas.Layer} The renderer. + * @return {module:ol/renderer/canvas/Layer} The renderer. */ function createRenderer(source) { let renderer = null; @@ -487,7 +487,7 @@ function createRenderer(source) { /** * Create an image renderer for the provided source. * @param {module:ol/source/Image} source The source. - * @return {ol.renderer.canvas.Layer} The renderer. + * @return {module:ol/renderer/canvas/Layer} The renderer. */ function createImageRenderer(source) { const layer = new ImageLayer({source: source}); @@ -498,7 +498,7 @@ function createImageRenderer(source) { /** * Create a tile renderer for the provided source. * @param {module:ol/source/Tile} source The source. - * @return {ol.renderer.canvas.Layer} The renderer. + * @return {module:ol/renderer/canvas/Layer} The renderer. */ function createTileRenderer(source) { const layer = new TileLayer({source: source}); From 61067e6c2cd14cf4bd941267d6a9391618e06617 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Thu, 26 Apr 2018 15:26:15 +0200 Subject: [PATCH 5/5] Module type for ol.Feature and short notation for ol/render/Feature --- src/ol/PluggableMap.js | 4 ++-- src/ol/VectorTile.js | 2 +- src/ol/interaction/Select.js | 12 ++++++------ src/ol/render.js | 6 +++--- src/ol/renderer/canvas/VectorTileLayer.js | 2 +- src/ol/source/Vector.js | 2 +- src/ol/style.js | 2 +- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index e164eb096a..eba2e31907 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -555,7 +555,7 @@ PluggableMap.prototype.disposeInternal = function() { * callback with each intersecting feature. Layers included in the detection can * be configured through the `layerFilter` option in `opt_options`. * @param {module:ol~Pixel} pixel Pixel. - * @param {function(this: S, (module:ol/Feature|module:ol/render/Feature~Feature), + * @param {function(this: S, (module:ol/Feature|module:ol/render/Feature), * module:ol/layer/Layer): T} callback Feature callback. The callback will be * called with two arguments. The first argument is one * {@link module:ol/Feature feature} or @@ -589,7 +589,7 @@ PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_opt * Get all features that intersect a pixel on the viewport. * @param {module:ol~Pixel} pixel Pixel. * @param {module:ol/PluggableMap~AtPixelOptions=} opt_options Optional options. - * @return {Array.} The detected features or + * @return {Array.} The detected features or * `null` if none were found. * @api */ diff --git a/src/ol/VectorTile.js b/src/ol/VectorTile.js index 308d3ed9e6..119ddf49ac 100644 --- a/src/ol/VectorTile.js +++ b/src/ol/VectorTile.js @@ -125,7 +125,7 @@ VectorTile.prototype.getFormat = function() { /** * Get the features for this tile. Geometries will be in the projection returned * by {@link module:ol/VectorTile~VectorTile#getProjection}. - * @return {Array.} Features. + * @return {Array.} Features. * @api */ VectorTile.prototype.getFeatures = function() { diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index e9a463fb23..05e8114649 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -34,7 +34,7 @@ const SelectEventType = { * {@link module:ol/render/Feature~Feature} and an * {@link module:ol/layer/Layer} and returns `true` if the feature may be * selected or `false` otherwise. - * @typedef {function((module:ol/Feature|module:ol/render/Feature~Feature), module:ol/layer/Layer): + * @typedef {function((module:ol/Feature|module:ol/render/Feature), module:ol/layer/Layer): * boolean} FilterFunction */ @@ -266,7 +266,7 @@ inherits(Select, Interaction); /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @param {module:ol/layer/Layer} layer Layer. * @private */ @@ -301,7 +301,7 @@ Select.prototype.getHitTolerance = function() { * the (last) selected feature. Note that this will not work with any * programmatic method like pushing features to * {@link module:ol/interaction/Select~Select#getFeatures collection}. - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature * @return {module:ol/layer/Vector~Vector} Layer. * @api */ @@ -340,7 +340,7 @@ function handleEvent(mapBrowserEvent) { map.forEachFeatureAtPixel(mapBrowserEvent.pixel, ( /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @param {module:ol/layer/Layer} layer Layer. * @return {boolean|undefined} Continue to iterate over the features. */ @@ -373,7 +373,7 @@ function handleEvent(mapBrowserEvent) { map.forEachFeatureAtPixel(mapBrowserEvent.pixel, ( /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @param {module:ol/layer/Layer} layer Layer. * @return {boolean|undefined} Continue to iterate over the features. */ @@ -482,7 +482,7 @@ Select.prototype.removeFeature_ = function(evt) { /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @private */ Select.prototype.removeFeatureLayerAssociation_ = function(feature) { diff --git a/src/ol/render.js b/src/ol/render.js index 11f7e15e5d..89dc8e5b47 100644 --- a/src/ol/render.js +++ b/src/ol/render.js @@ -9,7 +9,7 @@ import CanvasImmediateRenderer from './render/canvas/Immediate.js'; /** * @typedef {Object} State * @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to. - * @property {module:ol/Feature|module:ol/render/Feature~Feature} feature + * @property {module:ol/Feature|module:ol/render/Feature} feature * @property {module:ol/geom/SimpleGeometry} geometry * @property {number} pixelRatio Pixel ratio used by the layer renderer. * @property {number} resolution Resolution that the render batch was created and optimized for. @@ -23,8 +23,8 @@ import CanvasImmediateRenderer from './render/canvas/Immediate.js'; * It takes two instances of {@link module:ol/Feature} or * {@link module:ol/render/Feature} and returns a `{number}`. * - * @typedef {function((module:ol/Feature|module:ol/render/Feature~Feature), - * (module:ol/Feature|module:ol/render/Feature~Feature)):number} OrderFunction + * @typedef {function((module:ol/Feature|module:ol/render/Feature), + * (module:ol/Feature|module:ol/render/Feature)):number} OrderFunction */ diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 3980de6252..969f70c0ca 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -195,7 +195,7 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram const squaredTolerance = getSquaredRenderTolerance(resolution, pixelRatio); /** - * @param {module:ol/Feature|module:ol/render/Feature~RenderFeature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @this {module:ol/renderer/canvas/VectorTileLayer} */ const render = function(feature) { diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 0f93342361..0618209e75 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -840,7 +840,7 @@ VectorSource.prototype.handleFeatureChange_ = function(event) { /** * Returns true if the feature is contained within the source. - * @param {ol.Feature} feature Feature. + * @param {module:ol/Feature} feature Feature. * @return {boolean} Has feature. * @api */ diff --git a/src/ol/style.js b/src/ol/style.js index 0817ab5323..1202946a81 100644 --- a/src/ol/style.js +++ b/src/ol/style.js @@ -9,7 +9,7 @@ * {@link module:ol/style/Style} or an array of them. This way e.g. a * vector layer can be styled. * - * @typedef {function((module:ol/Feature|module:ol/render/Feature~Feature), number): + * @typedef {function((module:ol/Feature|module:ol/render/Feature), number): * (module:ol/style/Style|Array.)} StyleFunction * @api */