From af1f6836af0d0d0043b98cae7b5136e662d8bbe1 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Wed, 9 May 2018 10:45:35 +0200 Subject: [PATCH] Shorter module paths for default exports --- examples/geolocation-orientation.js | 3 +-- src/ol/Image.js | 2 +- src/ol/PluggableMap.js | 7 +++---- src/ol/View.js | 2 +- src/ol/extent.js | 4 ++-- src/ol/format/EsriJSON.js | 4 ++-- src/ol/format/GPX.js | 2 +- src/ol/format/Polyline.js | 4 ++-- src/ol/format/WKT.js | 6 +++--- src/ol/geom/Circle.js | 6 +++--- src/ol/geom/LineString.js | 6 +++--- src/ol/geom/LinearRing.js | 6 +++--- src/ol/geom/MultiLineString.js | 6 +++--- src/ol/geom/MultiPoint.js | 6 +++--- src/ol/geom/MultiPolygon.js | 6 +++--- src/ol/geom/Point.js | 4 ++-- src/ol/geom/Polygon.js | 6 +++--- src/ol/geom/SimpleGeometry.js | 16 ++++++++-------- src/ol/interaction/DragBox.js | 2 +- src/ol/interaction/Draw.js | 2 +- src/ol/interaction/Extent.js | 4 ++-- src/ol/interaction/Modify.js | 2 +- src/ol/interaction/Select.js | 6 +++--- src/ol/layer/Base.js | 2 +- src/ol/layer/Vector.js | 2 +- src/ol/render.js | 2 +- src/ol/render/Event.js | 2 +- src/ol/render/ReplayGroup.js | 2 +- src/ol/render/canvas/ReplayGroup.js | 10 +++++----- src/ol/render/replay.js | 2 +- src/ol/render/webgl/ReplayGroup.js | 4 ++-- src/ol/renderer/Layer.js | 2 +- src/ol/renderer/canvas/Layer.js | 2 +- src/ol/renderer/canvas/Map.js | 2 +- src/ol/renderer/canvas/TileLayer.js | 4 ++-- src/ol/renderer/canvas/VectorTileLayer.js | 8 ++++---- src/ol/renderer/webgl/Layer.js | 2 +- src/ol/renderer/webgl/Map.js | 2 +- src/ol/source/Image.js | 10 +++++----- src/ol/source/ImageArcGISRest.js | 2 +- src/ol/source/ImageCanvas.js | 2 +- src/ol/source/ImageMapGuide.js | 2 +- src/ol/source/ImageStatic.js | 2 +- src/ol/source/ImageWMS.js | 2 +- src/ol/source/Source.js | 8 ++++---- src/ol/source/Tile.js | 2 +- src/ol/source/TileImage.js | 2 +- src/ol/source/UrlTile.js | 2 +- src/ol/source/VectorTile.js | 2 +- src/ol/tilegrid.js | 4 ++-- 50 files changed, 99 insertions(+), 101 deletions(-) diff --git a/examples/geolocation-orientation.js b/examples/geolocation-orientation.js index c3f7ee3b50..dbe3ccfac4 100644 --- a/examples/geolocation-orientation.js +++ b/examples/geolocation-orientation.js @@ -42,8 +42,7 @@ map.addOverlay(marker); // LineString to store the different geolocation positions. This LineString // is time aware. // The Z dimension is actually used to store the rotation (heading). -const positions = new LineString([], - /** @type {module:ol/geom/GeometryLayout~GeometryLayout} */ ('XYZM')); +const positions = new LineString([], /** @type {module:ol/geom/GeometryLayout} */ ('XYZM')); // Geolocation Control const geolocation = new Geolocation({ diff --git a/src/ol/Image.js b/src/ol/Image.js index 0254e3ad30..4fd1911146 100644 --- a/src/ol/Image.js +++ b/src/ol/Image.js @@ -23,7 +23,7 @@ import {getHeight} from './extent.js'; * post requests or - in general - through XHR requests, where the src of the * image element would be set to a data URI when the content is loaded. * - * @typedef {function(module:ol/Image~Image, string)} LoadFunction + * @typedef {function(module:ol/Image, string)} LoadFunction * @api */ diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 7ad4d8e36d..a510c66f1d 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -790,13 +790,13 @@ PluggableMap.prototype.getInteractions = function() { /** * Get the layergroup associated with this map. - * @return {module:ol/layer/Group~Group} A layer group containing the layers in this map. + * @return {module:ol/layer/Group} A layer group containing the layers in this map. * @observable * @api */ PluggableMap.prototype.getLayerGroup = function() { return ( - /** @type {module:ol/layer/Group~Group} */ (this.get(MapProperty.LAYERGROUP)) + /** @type {module:ol/layer/Group} */ (this.get(MapProperty.LAYERGROUP)) ); }; @@ -1310,8 +1310,7 @@ PluggableMap.prototype.renderFrame_ = function(time) { /** * Sets the layergroup of this map. - * @param {module:ol/layer/Group~Group} layerGroup A layer group containing the layers in - * this map. + * @param {module:ol/layer/Group} layerGroup A layer group containing the layers in this map. * @observable * @api */ diff --git a/src/ol/View.js b/src/ol/View.js index 8ae88fbd55..5d3e73e98e 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -1175,7 +1175,7 @@ View.prototype.setCenter = function(center) { /** - * @param {module:ol/ViewHint~ViewHint} hint Hint. + * @param {module:ol/ViewHint} hint Hint. * @param {number} delta Delta. * @return {number} New value. */ diff --git a/src/ol/extent.js b/src/ol/extent.js index 77b8305869..6cf4d667da 100644 --- a/src/ol/extent.js +++ b/src/ol/extent.js @@ -165,7 +165,7 @@ export function containsXY(extent, x, y) { * Get the relationship between a coordinate and extent. * @param {module:ol/extent~Extent} extent The extent. * @param {module:ol/coordinate~Coordinate} coordinate The coordinate. - * @return {module:ol/extent/Relationship~Relationship} The relationship (bitwise compare with + * @return {module:ol/extent/Relationship} The relationship (bitwise compare with * module:ol/extent/Relationship~Relationship). */ export function coordinateRelationship(extent, coordinate) { @@ -478,7 +478,7 @@ export function getCenter(extent) { /** * Get a corner coordinate of an extent. * @param {module:ol/extent~Extent} extent Extent. - * @param {module:ol/extent/Corner~Corner} corner Corner. + * @param {module:ol/extent/Corner} corner Corner. * @return {module:ol/coordinate~Coordinate} Corner coordinate. */ export function getCorner(extent, corner) { diff --git a/src/ol/format/EsriJSON.js b/src/ol/format/EsriJSON.js index a9be164419..0f29a0919e 100644 --- a/src/ol/format/EsriJSON.js +++ b/src/ol/format/EsriJSON.js @@ -127,7 +127,7 @@ function readGeometry(object, opt_options) { * array. It is used for checking for holes. * Logic inspired by: https://github.com/Esri/terraformer-arcgis-parser * @param {Array.>>} rings Rings. - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Geometry layout. + * @param {module:ol/geom/GeometryLayout} layout Geometry layout. * @return {Array.>>} Transformed rings. */ function convertRings(rings, layout) { @@ -218,7 +218,7 @@ function readMultiLineStringGeometry(object) { /** * @param {EsriJSONGeometry} object Object. - * @return {module:ol/geom/GeometryLayout~GeometryLayout} The geometry layout to use. + * @return {module:ol/geom/GeometryLayout} The geometry layout to use. */ function getGeometryLayout(object) { let layout = GeometryLayout.XY; diff --git a/src/ol/format/GPX.js b/src/ol/format/GPX.js index bdc1badddd..b4b0bbfa91 100644 --- a/src/ol/format/GPX.js +++ b/src/ol/format/GPX.js @@ -428,7 +428,7 @@ function appendCoordinate(flatCoordinates, layoutOptions, node, values) { * @param {module:ol/format/GPX~LayoutOptions} layoutOptions Layout options. * @param {Array.} flatCoordinates Flat coordinates. * @param {Array.=} ends Ends. - * @return {module:ol/geom/GeometryLayout~GeometryLayout} Layout. + * @return {module:ol/geom/GeometryLayout} Layout. */ function applyLayoutOptions(layoutOptions, flatCoordinates, ends) { let layout = GeometryLayout.XY; diff --git a/src/ol/format/Polyline.js b/src/ol/format/Polyline.js index 30396fc430..d45b46cd11 100644 --- a/src/ol/format/Polyline.js +++ b/src/ol/format/Polyline.js @@ -17,7 +17,7 @@ import {get as getProjection} from '../proj.js'; /** * @typedef {Object} Options * @property {number} [factor=1e5] The factor by which the coordinates values will be scaled. - * @property {module:ol/geom/GeometryLayout~GeometryLayout} [geometryLayout='XY'] Layout of the + * @property {module:ol/geom/GeometryLayout} [geometryLayout='XY'] Layout of the * feature geometries created by the format reader. */ @@ -51,7 +51,7 @@ const Polyline = function(opt_options) { /** * @private - * @type {module:ol/geom/GeometryLayout~GeometryLayout} + * @type {module:ol/geom/GeometryLayout} */ this.geometryLayout_ = options.geometryLayout ? options.geometryLayout : GeometryLayout.XY; diff --git a/src/ol/format/WKT.js b/src/ol/format/WKT.js index 1a4c771555..9b3af1e951 100644 --- a/src/ol/format/WKT.js +++ b/src/ol/format/WKT.js @@ -229,7 +229,7 @@ const Parser = function(lexer) { this.token_; /** - * @type {module:ol/geom/GeometryLayout~GeometryLayout} + * @type {module:ol/geom/GeometryLayout} * @private */ this.layout_ = GeometryLayout.XY; @@ -282,7 +282,7 @@ Parser.prototype.parse = function() { /** * Try to parse the dimensional info. - * @return {module:ol/geom/GeometryLayout~GeometryLayout} The layout. + * @return {module:ol/geom/GeometryLayout} The layout. * @private */ Parser.prototype.parseGeometryLayout_ = function() { @@ -815,7 +815,7 @@ WKT.prototype.readGeometryFromText = function(text, opt_options) { /** - * @enum {function (new:module:ol/geom/Geometry, Array, module:ol/geom/GeometryLayout~GeometryLayout)} + * @enum {function (new:module:ol/geom/Geometry, Array, module:ol/geom/GeometryLayout)} */ const GeometryConstructor = { 'POINT': Point, diff --git a/src/ol/geom/Circle.js b/src/ol/geom/Circle.js index fc861fc0f8..e861d72ca5 100644 --- a/src/ol/geom/Circle.js +++ b/src/ol/geom/Circle.js @@ -16,7 +16,7 @@ import {deflateCoordinate} from '../geom/flat/deflate.js'; * @extends {module:ol/geom/SimpleGeometry} * @param {module:ol/coordinate~Coordinate} center Center. * @param {number=} opt_radius Radius. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const Circle = function(center, opt_radius, opt_layout) { @@ -179,7 +179,7 @@ Circle.prototype.setCenter = function(center) { * number) of the circle. * @param {module:ol/coordinate~Coordinate} center Center. * @param {number} radius Radius. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ Circle.prototype.setCenterAndRadius = function(center, radius, opt_layout) { @@ -217,7 +217,7 @@ Circle.prototype.setCoordinates = function(coordinates, opt_layout) {}; /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. */ Circle.prototype.setFlatCoordinates = function(layout, flatCoordinates) { diff --git a/src/ol/geom/LineString.js b/src/ol/geom/LineString.js index 5be36b6070..acdbe8efec 100644 --- a/src/ol/geom/LineString.js +++ b/src/ol/geom/LineString.js @@ -23,7 +23,7 @@ import {douglasPeucker} from '../geom/flat/simplify.js'; * @constructor * @extends {module:ol/geom/SimpleGeometry} * @param {Array.} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const LineString = function(coordinates, opt_layout) { @@ -238,7 +238,7 @@ LineString.prototype.intersectsExtent = function(extent) { /** * Set the coordinates of the linestring. * @param {Array.} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @override * @api */ @@ -258,7 +258,7 @@ LineString.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. */ LineString.prototype.setFlatCoordinates = function(layout, flatCoordinates) { diff --git a/src/ol/geom/LinearRing.js b/src/ol/geom/LinearRing.js index 99a83771f0..6c93fb662c 100644 --- a/src/ol/geom/LinearRing.js +++ b/src/ol/geom/LinearRing.js @@ -20,7 +20,7 @@ import {douglasPeucker} from '../geom/flat/simplify.js'; * @constructor * @extends {module:ol/geom/SimpleGeometry} * @param {Array.} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const LinearRing = function(coordinates, opt_layout) { @@ -132,7 +132,7 @@ LinearRing.prototype.intersectsExtent = function(extent) {}; /** * Set the coordinates of the linear ring. * @param {Array.} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @override * @api */ @@ -152,7 +152,7 @@ LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. */ LinearRing.prototype.setFlatCoordinates = function(layout, flatCoordinates) { diff --git a/src/ol/geom/MultiLineString.js b/src/ol/geom/MultiLineString.js index b3e0ec2ba6..4f7d0e256e 100644 --- a/src/ol/geom/MultiLineString.js +++ b/src/ol/geom/MultiLineString.js @@ -22,7 +22,7 @@ import {douglasPeuckerArray} from '../geom/flat/simplify.js'; * @constructor * @extends {module:ol/geom/SimpleGeometry} * @param {Array.>} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const MultiLineString = function(coordinates, opt_layout) { @@ -255,7 +255,7 @@ MultiLineString.prototype.intersectsExtent = function(extent) { /** * Set the coordinates of the multilinestring. * @param {Array.>} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @override * @api */ @@ -276,7 +276,7 @@ MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. * @param {Array.} ends Ends. */ diff --git a/src/ol/geom/MultiPoint.js b/src/ol/geom/MultiPoint.js index 528146a86e..62a778710f 100644 --- a/src/ol/geom/MultiPoint.js +++ b/src/ol/geom/MultiPoint.js @@ -19,7 +19,7 @@ import {squaredDistance as squaredDx} from '../math.js'; * @constructor * @extends {module:ol/geom/SimpleGeometry} * @param {Array.} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const MultiPoint = function(coordinates, opt_layout) { @@ -162,7 +162,7 @@ MultiPoint.prototype.intersectsExtent = function(extent) { /** * Set the coordinates of the multipoint. * @param {Array.} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @override * @api */ @@ -182,7 +182,7 @@ MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. */ MultiPoint.prototype.setFlatCoordinates = function(layout, flatCoordinates) { diff --git a/src/ol/geom/MultiPolygon.js b/src/ol/geom/MultiPolygon.js index f35a8d3a5e..aded289870 100644 --- a/src/ol/geom/MultiPolygon.js +++ b/src/ol/geom/MultiPolygon.js @@ -27,7 +27,7 @@ import {quantizeMultiArray} from '../geom/flat/simplify.js'; * @constructor * @extends {module:ol/geom/SimpleGeometry} * @param {Array.>>} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const MultiPolygon = function(coordinates, opt_layout) { @@ -352,7 +352,7 @@ MultiPolygon.prototype.intersectsExtent = function(extent) { /** * Set the coordinates of the multipolygon. * @param {Array.>>} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @override * @api */ @@ -379,7 +379,7 @@ MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. * @param {Array.>} endss Endss. */ diff --git a/src/ol/geom/Point.js b/src/ol/geom/Point.js index 42409f4f94..234be7dd01 100644 --- a/src/ol/geom/Point.js +++ b/src/ol/geom/Point.js @@ -16,7 +16,7 @@ import {squaredDistance as squaredDx} from '../math.js'; * @constructor * @extends {module:ol/geom/SimpleGeometry} * @param {module:ol/coordinate~Coordinate} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const Point = function(coordinates, opt_layout) { @@ -116,7 +116,7 @@ Point.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. */ Point.prototype.setFlatCoordinates = function(layout, flatCoordinates) { diff --git a/src/ol/geom/Polygon.js b/src/ol/geom/Polygon.js index cb71760afe..e8b6387d16 100644 --- a/src/ol/geom/Polygon.js +++ b/src/ol/geom/Polygon.js @@ -33,7 +33,7 @@ import {modulo} from '../math.js'; * linear ring defines a hole in the surface of the polygon. A linear ring * is an array of vertices' coordinates where the first coordinate and the * last are equivalent. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @api */ const Polygon = function(coordinates, opt_layout) { @@ -333,7 +333,7 @@ Polygon.prototype.intersectsExtent = function(extent) { /** * Set the coordinates of the polygon. * @param {Array.>} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. * @override * @api */ @@ -354,7 +354,7 @@ Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. * @param {Array.} ends Ends. */ diff --git a/src/ol/geom/SimpleGeometry.js b/src/ol/geom/SimpleGeometry.js index f526139c5c..a998239ca8 100644 --- a/src/ol/geom/SimpleGeometry.js +++ b/src/ol/geom/SimpleGeometry.js @@ -25,7 +25,7 @@ const SimpleGeometry = function() { /** * @protected - * @type {module:ol/geom/GeometryLayout~GeometryLayout} + * @type {module:ol/geom/GeometryLayout} */ this.layout = GeometryLayout.XY; @@ -48,7 +48,7 @@ inherits(SimpleGeometry, Geometry); /** * @param {number} stride Stride. - * @return {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @return {module:ol/geom/GeometryLayout} layout Layout. */ function getLayoutForStride(stride) { let layout; @@ -60,13 +60,13 @@ function getLayoutForStride(stride) { layout = GeometryLayout.XYZM; } return ( - /** @type {module:ol/geom/GeometryLayout~GeometryLayout} */ (layout) + /** @type {module:ol/geom/GeometryLayout} */ (layout) ); } /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @return {number} Stride. */ export function getStrideForLayout(layout) { @@ -134,7 +134,7 @@ SimpleGeometry.prototype.getLastCoordinate = function() { /** * Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry. - * @return {module:ol/geom/GeometryLayout~GeometryLayout} Layout. + * @return {module:ol/geom/GeometryLayout} Layout. * @api */ SimpleGeometry.prototype.getLayout = function() { @@ -201,7 +201,7 @@ SimpleGeometry.prototype.getStride = function() { /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout. + * @param {module:ol/geom/GeometryLayout} layout Layout. * @param {Array.} flatCoordinates Flat coordinates. * @protected */ @@ -215,13 +215,13 @@ SimpleGeometry.prototype.setFlatCoordinatesInternal = function(layout, flatCoord /** * @abstract * @param {Array} coordinates Coordinates. - * @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout. + * @param {module:ol/geom/GeometryLayout=} opt_layout Layout. */ SimpleGeometry.prototype.setCoordinates = function(coordinates, opt_layout) {}; /** - * @param {module:ol/geom/GeometryLayout~GeometryLayout|undefined} layout Layout. + * @param {module:ol/geom/GeometryLayout|undefined} layout Layout. * @param {Array} coordinates Coordinates. * @param {number} nesting Nesting. * @protected diff --git a/src/ol/interaction/DragBox.js b/src/ol/interaction/DragBox.js index b99939024c..341f9b364e 100644 --- a/src/ol/interaction/DragBox.js +++ b/src/ol/interaction/DragBox.js @@ -121,7 +121,7 @@ const DragBox = function(opt_options) { const options = opt_options ? opt_options : {}; /** - * @type {module:ol/render/Box~Box} + * @type {module:ol/render/Box} * @private */ this.box_ = new RenderBox(options.className || 'ol-dragbox'); diff --git a/src/ol/interaction/Draw.js b/src/ol/interaction/Draw.js index 01a1c4ade9..37f702373f 100644 --- a/src/ol/interaction/Draw.js +++ b/src/ol/interaction/Draw.js @@ -388,7 +388,7 @@ const Draw = function(options) { /** * Draw overlay where our sketch features are drawn. - * @type {module:ol/layer/Vector~Vector} + * @type {module:ol/layer/Vector} * @private */ this.overlay_ = new VectorLayer({ diff --git a/src/ol/interaction/Extent.js b/src/ol/interaction/Extent.js index 9abb63b1b5..febef3dc8f 100644 --- a/src/ol/interaction/Extent.js +++ b/src/ol/interaction/Extent.js @@ -142,7 +142,7 @@ const ExtentInteraction = function(opt_options) { /** * Layer for the extentFeature - * @type {module:ol/layer/Vector~Vector} + * @type {module:ol/layer/Vector} * @private */ this.extentOverlay_ = new VectorLayer({ @@ -157,7 +157,7 @@ const ExtentInteraction = function(opt_options) { /** * Layer for the vertexFeature - * @type {module:ol/layer/Vector~Vector} + * @type {module:ol/layer/Vector} * @private */ this.vertexOverlay_ = new VectorLayer({ diff --git a/src/ol/interaction/Modify.js b/src/ol/interaction/Modify.js index 642fdf7423..ee8fb21f03 100644 --- a/src/ol/interaction/Modify.js +++ b/src/ol/interaction/Modify.js @@ -249,7 +249,7 @@ const Modify = function(options) { /** * Draw overlay where sketch features are drawn. - * @type {module:ol/layer/Vector~Vector} + * @type {module:ol/layer/Vector} * @private */ this.overlay_ = new VectorLayer({ diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index 1c02c7e25b..5e46ec5f8a 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -220,7 +220,7 @@ const Select = function(opt_options) { /** * @private - * @type {module:ol/layer/Vector~Vector} + * @type {module:ol/layer/Vector} */ this.featureOverlay_ = featureOverlay; @@ -301,13 +301,13 @@ Select.prototype.getHitTolerance = function() { * programmatic method like pushing features to * {@link module:ol/interaction/Select~Select#getFeatures collection}. * @param {module:ol/Feature|module:ol/render/Feature} feature Feature - * @return {module:ol/layer/Vector~Vector} Layer. + * @return {module:ol/layer/Vector} Layer. * @api */ Select.prototype.getLayer = function(feature) { const key = getUid(feature); return ( - /** @type {module:ol/layer/Vector~Vector} */ (this.featureLayerAssociation_[key]) + /** @type {module:ol/layer/Vector} */ (this.featureLayerAssociation_[key]) ); }; diff --git a/src/ol/layer/Base.js b/src/ol/layer/Base.js index 4982b31a4f..79a43eb1df 100644 --- a/src/ol/layer/Base.js +++ b/src/ol/layer/Base.js @@ -171,7 +171,7 @@ BaseLayer.prototype.getOpacity = function() { /** * @abstract - * @return {module:ol/source/State~State} Source state. + * @return {module:ol/source/State} Source state. */ BaseLayer.prototype.getSourceState = function() {}; diff --git a/src/ol/layer/Vector.js b/src/ol/layer/Vector.js index db89459871..57993b80f1 100644 --- a/src/ol/layer/Vector.js +++ b/src/ol/layer/Vector.js @@ -147,7 +147,7 @@ const VectorLayer = function(opt_options) { /** * @private - * @type {module:ol/layer/VectorTileRenderType~VectorTileRenderType|string} + * @type {module:ol/layer/VectorTileRenderType|string} */ this.renderMode_ = options.renderMode || VectorRenderType.VECTOR; diff --git a/src/ol/render.js b/src/ol/render.js index 89dc8e5b47..bfe4ee281b 100644 --- a/src/ol/render.js +++ b/src/ol/render.js @@ -60,7 +60,7 @@ import CanvasImmediateRenderer from './render/canvas/Immediate.js'; * * @param {CanvasRenderingContext2D} context Canvas context. * @param {module:ol/render~ToContextOptions=} opt_options Options. - * @return {module:ol/render/canvas/Immediate~Immediate} Canvas Immediate. + * @return {module:ol/render/canvas/Immediate} Canvas Immediate. * @api */ export function toContext(context, opt_options) { diff --git a/src/ol/render/Event.js b/src/ol/render/Event.js index 429f0a1f4d..77c3b81342 100644 --- a/src/ol/render/Event.js +++ b/src/ol/render/Event.js @@ -7,7 +7,7 @@ import Event from '../events/Event.js'; /** * @constructor * @extends {module:ol/events/Event} - * @param {module:ol/render/EventType~EventType} type Type. + * @param {module:ol/render/EventType} type Type. * @param {module:ol/render/VectorContext=} opt_vectorContext Vector context. * @param {module:ol/PluggableMap~FrameState=} opt_frameState Frame state. * @param {?CanvasRenderingContext2D=} opt_context Context. diff --git a/src/ol/render/ReplayGroup.js b/src/ol/render/ReplayGroup.js index 5460e38128..264179e08e 100644 --- a/src/ol/render/ReplayGroup.js +++ b/src/ol/render/ReplayGroup.js @@ -12,7 +12,7 @@ const ReplayGroup = function() {}; /** * @abstract * @param {number|undefined} zIndex Z index. - * @param {module:ol/render/ReplayType~ReplayType} replayType Replay type. + * @param {module:ol/render/ReplayType} replayType Replay type. * @return {module:ol/render/VectorContext} Replay. */ ReplayGroup.prototype.getReplay = function(zIndex, replayType) {}; diff --git a/src/ol/render/canvas/ReplayGroup.js b/src/ol/render/canvas/ReplayGroup.js index f7421bd616..a06e341582 100644 --- a/src/ol/render/canvas/ReplayGroup.js +++ b/src/ol/render/canvas/ReplayGroup.js @@ -19,7 +19,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran /** - * @type {Object.)>} */ @@ -100,7 +100,7 @@ const CanvasReplayGroup = function( /** * @private - * @type {!Object.>} + * @type {!Object.>} */ this.replaysByZIndex_ = {}; @@ -252,7 +252,7 @@ CanvasReplayGroup.prototype.clip = function(context, transform) { /** - * @param {Array.} replays Replays. + * @param {Array.} replays Replays. * @return {boolean} Has replays of the provided types. */ CanvasReplayGroup.prototype.hasReplays = function(replays) { @@ -431,7 +431,7 @@ CanvasReplayGroup.prototype.getReplay = function(zIndex, replayType) { /** - * @return {Object.>} Replays. + * @return {Object.>} Replays. */ CanvasReplayGroup.prototype.getReplays = function() { return this.replaysByZIndex_; @@ -451,7 +451,7 @@ CanvasReplayGroup.prototype.isEmpty = function() { * @param {module:ol/transform~Transform} transform Transform. * @param {number} viewRotation View rotation. * @param {Object.} skippedFeaturesHash Ids of features to skip. - * @param {Array.=} opt_replayTypes Ordered replay types to replay. + * @param {Array.=} opt_replayTypes Ordered replay types to replay. * Default is {@link module:ol/render/replay~ORDER} * @param {Object.=} opt_declutterReplays Declutter replays. */ diff --git a/src/ol/render/replay.js b/src/ol/render/replay.js index 29c2c00439..b624f84dc0 100644 --- a/src/ol/render/replay.js +++ b/src/ol/render/replay.js @@ -6,7 +6,7 @@ import ReplayType from '../render/ReplayType.js'; /** * @const - * @type {Array.} + * @type {Array.} */ export const ORDER = [ ReplayType.POLYGON, diff --git a/src/ol/render/webgl/ReplayGroup.js b/src/ol/render/webgl/ReplayGroup.js index be511cd108..7a162080fa 100644 --- a/src/ol/render/webgl/ReplayGroup.js +++ b/src/ol/render/webgl/ReplayGroup.js @@ -19,7 +19,7 @@ import WebGLTextReplay from '../webgl/TextReplay.js'; const HIT_DETECTION_SIZE = [1, 1]; /** - * @type {Object.} */ @@ -64,7 +64,7 @@ const WebGLReplayGroup = function(tolerance, maxExtent, opt_renderBuffer) { /** * @private * @type {!Object.>} + * Object.>} */ this.replaysByZIndex_ = {}; diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js index b8959aa87b..cb21971f2d 100644 --- a/src/ol/renderer/Layer.js +++ b/src/ol/renderer/Layer.js @@ -96,7 +96,7 @@ LayerRenderer.prototype.getLayer = function() { * @private */ LayerRenderer.prototype.handleImageChange_ = function(event) { - const image = /** @type {module:ol/Image~Image} */ (event.target); + const image = /** @type {module:ol/Image} */ (event.target); if (image.getState() === ImageState.LOADED) { this.renderIfReadyAndVisible(); } diff --git a/src/ol/renderer/canvas/Layer.js b/src/ol/renderer/canvas/Layer.js index 415fbb06cd..84be6decd2 100644 --- a/src/ol/renderer/canvas/Layer.js +++ b/src/ol/renderer/canvas/Layer.js @@ -72,7 +72,7 @@ CanvasLayerRenderer.prototype.clip = function(context, frameState, extent) { /** - * @param {module:ol/render/EventType~EventType} type Event type. + * @param {module:ol/render/EventType} type Event type. * @param {CanvasRenderingContext2D} context Context. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/transform~Transform=} opt_transform Transform. diff --git a/src/ol/renderer/canvas/Map.js b/src/ol/renderer/canvas/Map.js index 6e3f02202c..1097376053 100644 --- a/src/ol/renderer/canvas/Map.js +++ b/src/ol/renderer/canvas/Map.js @@ -61,7 +61,7 @@ inherits(CanvasMapRenderer, MapRenderer); /** - * @param {module:ol/render/EventType~EventType} type Event type. + * @param {module:ol/render/EventType} type Event type. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ diff --git a/src/ol/renderer/canvas/TileLayer.js b/src/ol/renderer/canvas/TileLayer.js index 0186df60fa..6ff2ce5d39 100644 --- a/src/ol/renderer/canvas/TileLayer.js +++ b/src/ol/renderer/canvas/TileLayer.js @@ -14,7 +14,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran /** * @constructor * @extends {module:ol/renderer/canvas/IntermediateCanvas} - * @param {module:ol/layer/Tile|module:ol/layer/VectorTile~VectorTile} tileLayer Tile layer. + * @param {module:ol/layer/Tile|module:ol/layer/VectorTile} tileLayer Tile layer. * @api */ const CanvasTileLayerRenderer = function(tileLayer) { @@ -346,7 +346,7 @@ CanvasTileLayerRenderer.prototype.getImage = function() { /** * @function - * @return {module:ol/layer/Tile|module:ol/layer/VectorTile~VectorTile} + * @return {module:ol/layer/Tile|module:ol/layer/VectorTile} */ CanvasTileLayerRenderer.prototype.getLayer; diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 969f70c0ca..9d903f45b7 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -28,7 +28,7 @@ import { /** - * @type {!Object.>} + * @type {!Object.>} */ const IMAGE_REPLAYS = { 'image': [ReplayType.POLYGON, ReplayType.CIRCLE, @@ -38,7 +38,7 @@ const IMAGE_REPLAYS = { /** - * @type {!Object.>} + * @type {!Object.>} */ const VECTOR_REPLAYS = { 'image': [ReplayType.DEFAULT], @@ -50,7 +50,7 @@ const VECTOR_REPLAYS = { /** * @constructor * @extends {module:ol/renderer/canvas/TileLayer} - * @param {module:ol/layer/VectorTile~VectorTile} layer VectorTile layer. + * @param {module:ol/layer/VectorTile} layer VectorTile layer. * @api */ const CanvasVectorTileLayerRenderer = function(layer) { @@ -113,7 +113,7 @@ CanvasVectorTileLayerRenderer['handles'] = function(layer) { * @return {module:ol/renderer/canvas/VectorTileLayer} The layer renderer. */ CanvasVectorTileLayerRenderer['create'] = function(mapRenderer, layer) { - return new CanvasVectorTileLayerRenderer(/** @type {module:ol/layer/VectorTile~VectorTile} */ (layer)); + return new CanvasVectorTileLayerRenderer(/** @type {module:ol/layer/VectorTile} */ (layer)); }; diff --git a/src/ol/renderer/webgl/Layer.js b/src/ol/renderer/webgl/Layer.js index 9575e19eaf..8a822879c0 100644 --- a/src/ol/renderer/webgl/Layer.js +++ b/src/ol/renderer/webgl/Layer.js @@ -182,7 +182,7 @@ WebGLLayerRenderer.prototype.composeFrame = function(frameState, layerState, con /** - * @param {module:ol/render/EventType~EventType} type Event type. + * @param {module:ol/render/EventType} type Event type. * @param {module:ol/webgl/Context} context WebGL context. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index f6abd1fc17..a44058fd9b 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -248,7 +248,7 @@ WebGLMapRenderer.prototype.bindTileTexture = function(tile, tileSize, tileGutter /** - * @param {module:ol/render/EventType~EventType} type Event type. + * @param {module:ol/render/EventType} type Event type. * @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @private */ diff --git a/src/ol/source/Image.js b/src/ol/source/Image.js index 71cca78ddb..eb37e0af8d 100644 --- a/src/ol/source/Image.js +++ b/src/ol/source/Image.js @@ -49,7 +49,7 @@ const ImageSourceEventType = { * @constructor * @extends {module:ol/events/Event} * @param {string} type Type. - * @param {module:ol/Image~Image} image The image. + * @param {module:ol/Image} image The image. */ const ImageSourceEvent = function(type, image) { @@ -57,7 +57,7 @@ const ImageSourceEvent = function(type, image) { /** * The image related to the event. - * @type {module:ol/Image~Image} + * @type {module:ol/Image} * @api */ this.image = image; @@ -72,7 +72,7 @@ inherits(ImageSourceEvent, Event); * @property {module:ol/extent~Extent} [extent] * @property {module:ol/proj~ProjectionLike} projection * @property {Array.} [resolutions] - * @property {module:ol/source/State~State} [state] + * @property {module:ol/source/State} [state] */ @@ -205,7 +205,7 @@ ImageSource.prototype.getImageInternal = function(extent, resolution, pixelRatio * @protected */ ImageSource.prototype.handleImageChange = function(event) { - const image = /** @type {module:ol/Image~Image} */ (event.target); + const image = /** @type {module:ol/Image} */ (event.target); switch (image.getState()) { case ImageState.LOADING: this.dispatchEvent( @@ -231,7 +231,7 @@ ImageSource.prototype.handleImageChange = function(event) { /** * Default image load function for image sources that use module:ol/Image~Image image * instances. - * @param {module:ol/Image~Image} image Image. + * @param {module:ol/Image} image Image. * @param {string} src Source. */ export function defaultImageLoadFunction(image, src) { diff --git a/src/ol/source/ImageArcGISRest.js b/src/ol/source/ImageArcGISRest.js index 20f52f46ea..462ef4671f 100644 --- a/src/ol/source/ImageArcGISRest.js +++ b/src/ol/source/ImageArcGISRest.js @@ -99,7 +99,7 @@ const ImageArcGISRest = function(opt_options) { /** * @private - * @type {module:ol/Image~Image} + * @type {module:ol/Image} */ this.image_ = null; diff --git a/src/ol/source/ImageCanvas.js b/src/ol/source/ImageCanvas.js index 075248a095..b1782e1e13 100644 --- a/src/ol/source/ImageCanvas.js +++ b/src/ol/source/ImageCanvas.js @@ -38,7 +38,7 @@ import ImageSource from '../source/Image.js'; * width and height of the map viewport, and so on. Must be `1` or higher. * @property {Array.} [resolutions] Resolutions. * If specified, new canvases will be created for these resolutions - * @property {module:ol/source/State~State} [state] Source state. + * @property {module:ol/source/State} [state] Source state. */ diff --git a/src/ol/source/ImageMapGuide.js b/src/ol/source/ImageMapGuide.js index 15dc931200..7762990b69 100644 --- a/src/ol/source/ImageMapGuide.js +++ b/src/ol/source/ImageMapGuide.js @@ -106,7 +106,7 @@ const ImageMapGuide = function(options) { /** * @private - * @type {module:ol/Image~Image} + * @type {module:ol/Image} */ this.image_ = null; diff --git a/src/ol/source/ImageStatic.js b/src/ol/source/ImageStatic.js index 9286efef26..73d1d39f49 100644 --- a/src/ol/source/ImageStatic.js +++ b/src/ol/source/ImageStatic.js @@ -54,7 +54,7 @@ const Static = function(options) { /** * @private - * @type {module:ol/Image~Image} + * @type {module:ol/Image} */ this.image_ = new ImageWrapper(imageExtent, undefined, 1, options.url, crossOrigin, imageLoadFunction); diff --git a/src/ol/source/ImageWMS.js b/src/ol/source/ImageWMS.js index 05bda634a7..e4c42f5bcb 100644 --- a/src/ol/source/ImageWMS.js +++ b/src/ol/source/ImageWMS.js @@ -110,7 +110,7 @@ const ImageWMS = function(opt_options) { /** * @private - * @type {module:ol/Image~Image} + * @type {module:ol/Image} */ this.image_ = null; diff --git a/src/ol/source/Source.js b/src/ol/source/Source.js index 25807d8e52..b647bd773f 100644 --- a/src/ol/source/Source.js +++ b/src/ol/source/Source.js @@ -32,7 +32,7 @@ import SourceState from '../source/State.js'; * @typedef {Object} Options * @property {module:ol/source/Source~AttributionLike} [attributions] * @property {module:ol/proj~ProjectionLike} projection - * @property {module:ol/source/State~State} [state] + * @property {module:ol/source/State} [state] * @property {boolean} [wrapX] */ @@ -69,7 +69,7 @@ const Source = function(options) { /** * @private - * @type {module:ol/source/State~State} + * @type {module:ol/source/State} */ this.state_ = options.state !== undefined ? options.state : SourceState.READY; @@ -149,7 +149,7 @@ Source.prototype.getResolutions = function() {}; /** * Get the state of the source, see {@link module:ol/source/State~State} for possible states. - * @return {module:ol/source/State~State} State. + * @return {module:ol/source/State} State. * @api */ Source.prototype.getState = function() { @@ -189,7 +189,7 @@ Source.prototype.setAttributions = function(attributions) { /** * Set the state of the source. - * @param {module:ol/source/State~State} state State. + * @param {module:ol/source/State} state State. * @protected */ Source.prototype.setState = function(state) { diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js index f82f5ff5fe..79c3e598f7 100644 --- a/src/ol/source/Tile.js +++ b/src/ol/source/Tile.js @@ -20,7 +20,7 @@ import {wrapX, getForProjection as getTileGridForProjection} from '../tilegrid.j * @property {boolean} [opaque] * @property {number} [tilePixelRatio] * @property {module:ol/proj~ProjectionLike} [projection] - * @property {module:ol/source/State~State} [state] + * @property {module:ol/source/State} [state] * @property {module:ol/tilegrid/TileGrid} [tileGrid] * @property {boolean} [wrapX=true] * @property {number} [transition] diff --git a/src/ol/source/TileImage.js b/src/ol/source/TileImage.js index fe817ab87d..06365db552 100644 --- a/src/ol/source/TileImage.js +++ b/src/ol/source/TileImage.js @@ -26,7 +26,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.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 {module:ol/source/State~State} [state] Source state. + * @property {module:ol/source/State} [state] Source state. * @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. * Default is {@link module:ol/ImageTile~ImageTile}. * @property {module:ol/tilegrid/TileGrid} [tileGrid] Tile grid. diff --git a/src/ol/source/UrlTile.js b/src/ol/source/UrlTile.js index 0ec461a7ba..8c5fbb4614 100644 --- a/src/ol/source/UrlTile.js +++ b/src/ol/source/UrlTile.js @@ -15,7 +15,7 @@ import {getKeyZXY} from '../tilecoord.js'; * @property {module:ol/extent~Extent} [extent] * @property {boolean} [opaque] * @property {module:ol/proj~ProjectionLike} [projection] - * @property {module:ol/source/State~State} [state] + * @property {module:ol/source/State} [state] * @property {module:ol/tilegrid/TileGrid} [tileGrid] * @property {module:ol/Tile~LoadFunction} tileLoadFunction * @property {number} [tilePixelRatio] diff --git a/src/ol/source/VectorTile.js b/src/ol/source/VectorTile.js index b6fd6e6b23..0b4e66d8a0 100644 --- a/src/ol/source/VectorTile.js +++ b/src/ol/source/VectorTile.js @@ -20,7 +20,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid. * boundaries or TopoJSON sources) allows the renderer to optimise fill and * stroke operations. * @property {module:ol/proj~ProjectionLike} projection Projection. - * @property {module:ol/source/State~State} [state] Source state. + * @property {module:ol/source/State} [state] Source state. * @property {module:ol/VectorTile~TileClass} [tileClass] Class used to instantiate image tiles. * Default is {@link module:ol/VectorTile}. * @property {module:ol/tilegrid/TileGrid} [tileGrid] Tile grid. diff --git a/src/ol/tilegrid.js b/src/ol/tilegrid.js index 4e68d586e1..42af3a6f47 100644 --- a/src/ol/tilegrid.js +++ b/src/ol/tilegrid.js @@ -53,7 +53,7 @@ export function wrapX(tileGrid, tileCoord, projection) { * DEFAULT_MAX_ZOOM). * @param {number|module:ol/size~Size=} opt_tileSize Tile size (default uses * DEFAULT_TILE_SIZE). - * @param {module:ol/extent/Corner~Corner=} opt_corner Extent corner (default is `'top-left'`). + * @param {module:ol/extent/Corner=} opt_corner Extent corner (default is `'top-left'`). * @return {!module:ol/tilegrid/TileGrid} TileGrid instance. */ export function createForExtent(extent, opt_maxZoom, opt_tileSize, opt_corner) { @@ -139,7 +139,7 @@ function resolutionsFromExtent(extent, opt_maxZoom, opt_tileSize) { * DEFAULT_MAX_ZOOM). * @param {number|module:ol/size~Size=} opt_tileSize Tile size (default uses * DEFAULT_TILE_SIZE). - * @param {module:ol/extent/Corner~Corner=} opt_corner Extent corner (default is `'top-left'`). + * @param {module:ol/extent/Corner=} opt_corner Extent corner (default is `'top-left'`). * @return {!module:ol/tilegrid/TileGrid} TileGrid instance. */ export function createForProjection(projection, opt_maxZoom, opt_tileSize, opt_corner) {