From 9ce36da34946c07d6c203aaa60b11f5d5f0fd712 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Wed, 18 Jul 2018 00:36:29 -0600 Subject: [PATCH] Remove @extends and @constructor annotations --- src/ol/AssertionError.js | 1 - src/ol/Disposable.js | 1 - src/ol/events/Event.js | 6 ++-- src/ol/events/EventTarget.js | 2 -- src/ol/format/GML.js | 2 -- src/ol/layer/Base.js | 3 -- src/ol/layer/Group.js | 2 -- src/ol/layer/Heatmap.js | 2 -- src/ol/layer/Image.js | 2 -- src/ol/layer/Layer.js | 3 -- src/ol/layer/Tile.js | 3 -- src/ol/layer/Vector.js | 3 -- src/ol/layer/VectorTile.js | 2 -- src/ol/render/Box.js | 2 -- src/ol/render/Event.js | 2 -- src/ol/render/Feature.js | 1 - src/ol/render/ReplayGroup.js | 18 ++++++------ src/ol/render/VectorContext.js | 3 +- src/ol/render/canvas/ImageReplay.js | 2 -- src/ol/render/canvas/Immediate.js | 2 -- src/ol/render/canvas/LineStringReplay.js | 2 -- src/ol/render/canvas/PolygonReplay.js | 2 -- src/ol/render/canvas/Replay.js | 2 -- src/ol/render/canvas/ReplayGroup.js | 2 -- src/ol/render/canvas/TextReplay.js | 2 -- src/ol/render/webgl/CircleReplay.js | 2 -- src/ol/render/webgl/ImageReplay.js | 2 -- src/ol/render/webgl/Immediate.js | 2 -- src/ol/render/webgl/LineStringReplay.js | 2 -- src/ol/render/webgl/PolygonReplay.js | 2 -- src/ol/render/webgl/Replay.js | 3 -- src/ol/render/webgl/ReplayGroup.js | 2 -- src/ol/render/webgl/TextReplay.js | 2 -- src/ol/render/webgl/TextureReplay.js | 3 -- src/ol/renderer/canvas/ImageLayer.js | 2 -- src/ol/renderer/canvas/VectorTileLayer.js | 2 -- src/ol/reproj/Image.js | 2 -- src/ol/reproj/Tile.js | 2 -- src/ol/reproj/Triangulation.js | 15 +++++----- src/ol/source/BingMaps.js | 2 -- src/ol/source/CartoDB.js | 2 -- src/ol/source/Cluster.js | 2 -- src/ol/source/Image.js | 5 ---- 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/OSM.js | 2 -- src/ol/source/Raster.js | 4 --- src/ol/source/Source.js | 3 -- src/ol/source/Stamen.js | 2 -- src/ol/source/Tile.js | 5 ---- src/ol/source/TileArcGISRest.js | 2 -- src/ol/source/TileDebug.js | 4 --- src/ol/source/TileImage.js | 2 -- src/ol/source/TileJSON.js | 2 -- src/ol/source/TileWMS.js | 2 -- src/ol/source/UTFGrid.js | 4 --- src/ol/source/UrlTile.js | 3 -- src/ol/source/Vector.js | 4 --- src/ol/source/VectorTile.js | 2 -- src/ol/source/WMTS.js | 2 -- src/ol/source/XYZ.js | 2 -- src/ol/source/Zoomify.js | 4 --- src/ol/structs/LRUCache.js | 3 +- src/ol/structs/LinkedList.js | 14 ++++------ src/ol/structs/PriorityQueue.js | 30 ++++++++++---------- src/ol/structs/RBush.js | 17 ++++++------ src/ol/style/Atlas.js | 34 +++++++++++------------ src/ol/style/AtlasManager.js | 33 +++++++++++----------- src/ol/style/Circle.js | 2 -- src/ol/style/Fill.js | 8 +++--- src/ol/style/Icon.js | 2 -- src/ol/style/IconImage.js | 2 -- src/ol/style/IconImageCache.js | 1 - src/ol/style/Image.js | 9 +++--- src/ol/style/RegularShape.js | 2 -- src/ol/style/Stroke.js | 9 +++--- src/ol/style/Style.js | 10 +++---- src/ol/style/Text.js | 9 +++--- src/ol/tilegrid/TileGrid.js | 10 +++---- src/ol/tilegrid/WMTS.js | 2 -- src/ol/webgl/Context.js | 2 -- src/ol/webgl/Fragment.js | 3 -- src/ol/webgl/Vertex.js | 3 -- test/spec/ol/source/tile.test.js | 2 -- 87 files changed, 110 insertions(+), 282 deletions(-) diff --git a/src/ol/AssertionError.js b/src/ol/AssertionError.js index 293c6996ae..e39cc915a6 100644 --- a/src/ol/AssertionError.js +++ b/src/ol/AssertionError.js @@ -7,7 +7,6 @@ import {VERSION} from './util.js'; * Error object thrown when an assertion failed. This is an ECMA-262 Error, * extended with a `code` property. * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} - * @extends {Error} */ class AssertionError extends Error { diff --git a/src/ol/Disposable.js b/src/ol/Disposable.js index a7091d8e8f..3cdf80c89c 100644 --- a/src/ol/Disposable.js +++ b/src/ol/Disposable.js @@ -5,7 +5,6 @@ import {UNDEFINED} from './functions.js'; /** * Objects that need to clean up after themselves. - * @constructor */ class Disposable { /** diff --git a/src/ol/events/Event.js b/src/ol/events/Event.js index 3916a987b6..e4b9e49cc3 100644 --- a/src/ol/events/Event.js +++ b/src/ol/events/Event.js @@ -11,12 +11,12 @@ * `stopPropagation` and `preventDefault` methods. It is meant as base class * for higher level events defined in the library, and works with * {@link module:ol/events/EventTarget~EventTarget}. - * - * @constructor - * @param {string} type Type. */ class Event { + /** + * @param {string} type Type. + */ constructor(type) { /** diff --git a/src/ol/events/EventTarget.js b/src/ol/events/EventTarget.js index 71e5d3e42b..f319b05fc9 100644 --- a/src/ol/events/EventTarget.js +++ b/src/ol/events/EventTarget.js @@ -26,8 +26,6 @@ import Event from '../events/Event.js'; * `stopPropagation` or `preventDefault` on an event object, it means that no * more listeners after this one will be called. Same as when the listener * returns false. - * - * @constructor */ class EventTarget extends Disposable { constructor() { diff --git a/src/ol/format/GML.js b/src/ol/format/GML.js index eeb59fd36c..f7ef19052b 100644 --- a/src/ol/format/GML.js +++ b/src/ol/format/GML.js @@ -9,10 +9,8 @@ import GML3 from '../format/GML3.js'; * version 3.1.1. * Currently only supports GML 3.1.1 Simple Features profile. * - * @constructor * @param {module:ol/format/GMLBase~Options=} opt_options * Optional configuration object. - * @extends {module:ol/format/GMLBase} * @api */ const GML = GML3; diff --git a/src/ol/layer/Base.js b/src/ol/layer/Base.js index 8fd2740bad..e75b3eec1a 100644 --- a/src/ol/layer/Base.js +++ b/src/ol/layer/Base.js @@ -31,9 +31,6 @@ class BaseLayer extends BaseObject { * the options is set as a {@link module:ol/Object} property on the layer object, so * is observable, and has get/set accessors. * - * @constructor - * @abstract - * @extends {module:ol/Object} * @param {module:ol/layer/Base~Options} options Layer options. * @api */ diff --git a/src/ol/layer/Group.js b/src/ol/layer/Group.js index 8c6ce1fae3..4d6332a5d0 100644 --- a/src/ol/layer/Group.js +++ b/src/ol/layer/Group.js @@ -47,8 +47,6 @@ class LayerGroup extends BaseLayer { * * A generic `change` event is triggered when the group/Collection changes. * - * @constructor - * @extends {module:ol/layer/Base} * @param {module:ol/layer/Group~Options=} opt_options Layer options. * @api */ diff --git a/src/ol/layer/Heatmap.js b/src/ol/layer/Heatmap.js index 17ee8a1914..d7c28495a1 100644 --- a/src/ol/layer/Heatmap.js +++ b/src/ol/layer/Heatmap.js @@ -67,8 +67,6 @@ class Heatmap extends VectorLayer { * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * - * @constructor - * @extends {module:ol/layer/Vector} * @fires module:ol/render/Event~RenderEvent * @param {module:ol/layer/Heatmap~Options=} opt_options Options. * @api diff --git a/src/ol/layer/Image.js b/src/ol/layer/Image.js index e3aac7a201..417864db8e 100644 --- a/src/ol/layer/Image.js +++ b/src/ol/layer/Image.js @@ -35,8 +35,6 @@ class ImageLayer extends Layer { * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * - * @constructor - * @extends {module:ol/layer/Layer} * @fires module:ol/render/Event~RenderEvent * @param {module:ol/layer/Image~Options=} opt_options Layer options. * @api diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js index f93399eacc..0711d28b6f 100644 --- a/src/ol/layer/Layer.js +++ b/src/ol/layer/Layer.js @@ -60,9 +60,6 @@ class Layer extends BaseLayer { * * A generic `change` event is fired when the state of the source changes. * - * @constructor - * @abstract - * @extends {module:ol/layer/Base} * @fires module:ol/render/Event~RenderEvent * @param {module:ol/layer/Layer~Options} options Layer options. * @api diff --git a/src/ol/layer/Tile.js b/src/ol/layer/Tile.js index ee5b078275..ca1cef189e 100644 --- a/src/ol/layer/Tile.js +++ b/src/ol/layer/Tile.js @@ -39,9 +39,6 @@ class TileLayer extends Layer { * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * - * @constructor - * @extends {module:ol/layer/Layer} - * @fires module:ol/render/Event~RenderEvent * @param {module:ol/layer/Tile~Options=} opt_options Tile layer options. * @api */ diff --git a/src/ol/layer/Vector.js b/src/ol/layer/Vector.js index e1ebfcc451..55933e088f 100644 --- a/src/ol/layer/Vector.js +++ b/src/ol/layer/Vector.js @@ -85,9 +85,6 @@ class VectorLayer extends Layer { * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * - * @constructor - * @extends {module:ol/layer/Layer} - * @fires module:ol/render/Event~RenderEvent * @param {module:ol/layer/Vector~Options=} opt_options Options. * @api */ diff --git a/src/ol/layer/VectorTile.js b/src/ol/layer/VectorTile.js index 33b29d5f2b..a9f5c7d199 100644 --- a/src/ol/layer/VectorTile.js +++ b/src/ol/layer/VectorTile.js @@ -94,8 +94,6 @@ class VectorTileLayer extends VectorLayer { * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * - * @constructor - * @extends {module:ol/layer/Vector} * @param {module:ol/layer/VectorTile~Options=} opt_options Options. * @api */ diff --git a/src/ol/render/Box.js b/src/ol/render/Box.js index 2831998822..15b84bb6cc 100644 --- a/src/ol/render/Box.js +++ b/src/ol/render/Box.js @@ -7,8 +7,6 @@ import Polygon from '../geom/Polygon.js'; class RenderBox extends Disposable { /** - * @constructor - * @extends {module:ol/Disposable} * @param {string} className CSS class name. */ constructor(className) { diff --git a/src/ol/render/Event.js b/src/ol/render/Event.js index 565e1c10e7..e4c677355b 100644 --- a/src/ol/render/Event.js +++ b/src/ol/render/Event.js @@ -7,8 +7,6 @@ import Event from '../events/Event.js'; class RenderEvent extends Event { /** - * @constructor - * @extends {module:ol/events/Event} * @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. diff --git a/src/ol/render/Feature.js b/src/ol/render/Feature.js index 5c3ccf2f03..447d684658 100644 --- a/src/ol/render/Feature.js +++ b/src/ol/render/Feature.js @@ -24,7 +24,6 @@ const tmpTransform = createTransform(); * structure, optimized for vector tile rendering and styling. Geometry access * through the API is limited to getting the type and extent of the geometry. * - * @constructor * @param {module:ol/geom/GeometryType} type Geometry type. * @param {Array.} flatCoordinates Flat coordinates. These always need * to be right-handed for polygons. diff --git a/src/ol/render/ReplayGroup.js b/src/ol/render/ReplayGroup.js index 3457654326..f28edc9b86 100644 --- a/src/ol/render/ReplayGroup.js +++ b/src/ol/render/ReplayGroup.js @@ -3,22 +3,20 @@ */ /** * Base class for replay groups. - * @constructor - * @abstract */ class ReplayGroup { /** - * @abstract - * @param {number|undefined} zIndex Z index. - * @param {module:ol/render/ReplayType} replayType Replay type. - * @return {module:ol/render/VectorContext} Replay. - */ + * @abstract + * @param {number|undefined} zIndex Z index. + * @param {module:ol/render/ReplayType} replayType Replay type. + * @return {module:ol/render/VectorContext} Replay. + */ getReplay(zIndex, replayType) {} /** - * @abstract - * @return {boolean} Is empty. - */ + * @abstract + * @return {boolean} Is empty. + */ isEmpty() {} } diff --git a/src/ol/render/VectorContext.js b/src/ol/render/VectorContext.js index 1d376d3a12..1ed6f81497 100644 --- a/src/ol/render/VectorContext.js +++ b/src/ol/render/VectorContext.js @@ -1,11 +1,10 @@ /** * @module ol/render/VectorContext */ + /** * Context for drawing geometries. A vector context is available on render * events and does not need to be constructed directly. - * @constructor - * @abstract * @struct * @api */ diff --git a/src/ol/render/canvas/ImageReplay.js b/src/ol/render/canvas/ImageReplay.js index 9d48125380..7b6a704423 100644 --- a/src/ol/render/canvas/ImageReplay.js +++ b/src/ol/render/canvas/ImageReplay.js @@ -6,8 +6,6 @@ import CanvasReplay from '../canvas/Replay.js'; class CanvasImageReplay extends CanvasReplay { /** - * @constructor - * @extends {module:ol/render/canvas/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Maximum extent. * @param {number} resolution Resolution. diff --git a/src/ol/render/canvas/Immediate.js b/src/ol/render/canvas/Immediate.js index 4fc556293f..4d63df1bb3 100644 --- a/src/ol/render/canvas/Immediate.js +++ b/src/ol/render/canvas/Immediate.js @@ -26,8 +26,6 @@ class CanvasImmediateRenderer extends VectorContext { * {@link module:ol/render/Event~RenderEvent} object associated with postcompose, precompose and * render events emitted by layers and maps. * - * @constructor - * @extends {module:ol/render/VectorContext} * @param {CanvasRenderingContext2D} context Context. * @param {number} pixelRatio Pixel ratio. * @param {module:ol/extent~Extent} extent Extent. diff --git a/src/ol/render/canvas/LineStringReplay.js b/src/ol/render/canvas/LineStringReplay.js index d63b2ea101..9f0e970ad8 100644 --- a/src/ol/render/canvas/LineStringReplay.js +++ b/src/ol/render/canvas/LineStringReplay.js @@ -6,8 +6,6 @@ import CanvasReplay from '../canvas/Replay.js'; class CanvasLineStringReplay extends CanvasReplay { /** - * @constructor - * @extends {module:ol/render/canvas/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Maximum extent. * @param {number} resolution Resolution. diff --git a/src/ol/render/canvas/PolygonReplay.js b/src/ol/render/canvas/PolygonReplay.js index 1b7f99d470..64144c9519 100644 --- a/src/ol/render/canvas/PolygonReplay.js +++ b/src/ol/render/canvas/PolygonReplay.js @@ -12,8 +12,6 @@ import CanvasReplay from '../canvas/Replay.js'; class CanvasPolygonReplay extends CanvasReplay { /** - * @constructor - * @extends {module:ol/render/canvas/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Maximum extent. * @param {number} resolution Resolution. diff --git a/src/ol/render/canvas/Replay.js b/src/ol/render/canvas/Replay.js index f3c3a1d6d4..20a2ec2971 100644 --- a/src/ol/render/canvas/Replay.js +++ b/src/ol/render/canvas/Replay.js @@ -43,8 +43,6 @@ const tmpTransform = createTransform(); class CanvasReplay extends VectorContext { /** - * @constructor - * @extends {module:ol/render/VectorContext} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Maximum extent. * @param {number} resolution Resolution. diff --git a/src/ol/render/canvas/ReplayGroup.js b/src/ol/render/canvas/ReplayGroup.js index 8c6523ece2..3ebaaffa9f 100644 --- a/src/ol/render/canvas/ReplayGroup.js +++ b/src/ol/render/canvas/ReplayGroup.js @@ -35,8 +35,6 @@ const BATCH_CONSTRUCTORS = { class CanvasReplayGroup extends ReplayGroup { /** - * @constructor - * @extends {module:ol/render/ReplayGroup} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @param {number} resolution Resolution. diff --git a/src/ol/render/canvas/TextReplay.js b/src/ol/render/canvas/TextReplay.js index f6f81b6740..87cbaf8922 100644 --- a/src/ol/render/canvas/TextReplay.js +++ b/src/ol/render/canvas/TextReplay.js @@ -16,8 +16,6 @@ import TextPlacement from '../../style/TextPlacement.js'; class CanvasTextReplay extends CanvasReplay { /** - * @constructor - * @extends {module:ol/render/canvas/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Maximum extent. * @param {number} resolution Resolution. diff --git a/src/ol/render/webgl/CircleReplay.js b/src/ol/render/webgl/CircleReplay.js index f358f3e112..352af6b2c6 100644 --- a/src/ol/render/webgl/CircleReplay.js +++ b/src/ol/render/webgl/CircleReplay.js @@ -17,8 +17,6 @@ import WebGLBuffer from '../../webgl/Buffer.js'; class WebGLCircleReplay extends WebGLReplay { /** - * @constructor - * @extends {module:ol/render/webgl/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/render/webgl/ImageReplay.js b/src/ol/render/webgl/ImageReplay.js index 092448f319..9ce185dcbe 100644 --- a/src/ol/render/webgl/ImageReplay.js +++ b/src/ol/render/webgl/ImageReplay.js @@ -7,8 +7,6 @@ import WebGLBuffer from '../../webgl/Buffer.js'; class WebGLImageReplay extends WebGLTextureReplay { /** - * @constructor - * @extends {module:ol/render/webgl/TextureReplay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/render/webgl/Immediate.js b/src/ol/render/webgl/Immediate.js index adb49bbbb3..6e5c258b4f 100644 --- a/src/ol/render/webgl/Immediate.js +++ b/src/ol/render/webgl/Immediate.js @@ -10,8 +10,6 @@ import WebGLReplayGroup from '../webgl/ReplayGroup.js'; class WebGLImmediateRenderer extends VectorContext { /** - * @constructor - * @extends {module:ol/render/VectorContext} * @param {module:ol/webgl/Context} context Context. * @param {module:ol/coordinate~Coordinate} center Center. * @param {number} resolution Resolution. diff --git a/src/ol/render/webgl/LineStringReplay.js b/src/ol/render/webgl/LineStringReplay.js index 678a2ae79e..adce9c1c20 100644 --- a/src/ol/render/webgl/LineStringReplay.js +++ b/src/ol/render/webgl/LineStringReplay.js @@ -37,8 +37,6 @@ const Instruction = { class WebGLLineStringReplay extends WebGLReplay { /** - * @constructor - * @extends {module:ol/render/webgl/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/render/webgl/PolygonReplay.js b/src/ol/render/webgl/PolygonReplay.js index 8d02dd5af0..6de0fc4dfd 100644 --- a/src/ol/render/webgl/PolygonReplay.js +++ b/src/ol/render/webgl/PolygonReplay.js @@ -38,8 +38,6 @@ import WebGLBuffer from '../../webgl/Buffer.js'; class WebGLPolygonReplay extends WebGLReplay { /** - * @constructor - * @extends {module:ol/render/webgl/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/render/webgl/Replay.js b/src/ol/render/webgl/Replay.js index 6697a968dc..3bd4af2ba6 100644 --- a/src/ol/render/webgl/Replay.js +++ b/src/ol/render/webgl/Replay.js @@ -17,9 +17,6 @@ import {ARRAY_BUFFER, ELEMENT_ARRAY_BUFFER, TRIANGLES, class WebGLReplay extends VectorContext { /** - * @constructor - * @abstract - * @extends {module:ol/render/VectorContext} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/render/webgl/ReplayGroup.js b/src/ol/render/webgl/ReplayGroup.js index 660fa2975c..62b15c5932 100644 --- a/src/ol/render/webgl/ReplayGroup.js +++ b/src/ol/render/webgl/ReplayGroup.js @@ -34,8 +34,6 @@ const BATCH_CONSTRUCTORS = { class WebGLReplayGroup extends ReplayGroup { /** - * @constructor - * @extends {module:ol/render/ReplayGroup} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @param {number=} opt_renderBuffer Render buffer. diff --git a/src/ol/render/webgl/TextReplay.js b/src/ol/render/webgl/TextReplay.js index b36a276ef4..7ecc5c2357 100644 --- a/src/ol/render/webgl/TextReplay.js +++ b/src/ol/render/webgl/TextReplay.js @@ -24,8 +24,6 @@ import WebGLBuffer from '../../webgl/Buffer.js'; class WebGLTextReplay extends WebGLTextureReplay { /** - * @constructor - * @extends {module:ol/render/webgl/TextureReplay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/render/webgl/TextureReplay.js b/src/ol/render/webgl/TextureReplay.js index b7c58753a7..ab1b3c22b8 100644 --- a/src/ol/render/webgl/TextureReplay.js +++ b/src/ol/render/webgl/TextureReplay.js @@ -12,9 +12,6 @@ import {createTexture} from '../../webgl/Context.js'; class WebGLTextureReplay extends WebGLReplay { /** - * @constructor - * @abstract - * @extends {module:ol/render/webgl/Replay} * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @struct diff --git a/src/ol/renderer/canvas/ImageLayer.js b/src/ol/renderer/canvas/ImageLayer.js index ea726ba167..5a240bb580 100644 --- a/src/ol/renderer/canvas/ImageLayer.js +++ b/src/ol/renderer/canvas/ImageLayer.js @@ -16,8 +16,6 @@ import {create as createTransform, compose as composeTransform} from '../../tran class CanvasImageLayerRenderer extends IntermediateCanvasRenderer { /** - * @constructor - * @extends {module:ol/renderer/canvas/IntermediateCanvas} * @param {module:ol/layer/Image|module:ol/layer/Vector} imageLayer Image or vector layer. * @api */ diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 49256a4fca..03267f69fc 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -50,8 +50,6 @@ const VECTOR_REPLAYS = { class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer { /** - * @constructor - * @extends {module:ol/renderer/canvas/TileLayer} * @param {module:ol/layer/VectorTile} layer VectorTile layer. * @api */ diff --git a/src/ol/reproj/Image.js b/src/ol/reproj/Image.js index 7c68e098dd..4c75e87565 100644 --- a/src/ol/reproj/Image.js +++ b/src/ol/reproj/Image.js @@ -23,8 +23,6 @@ class ReprojImage extends ImageBase { * Class encapsulating single reprojected image. * See {@link module:ol/source/Image~ImageSource}. * - * @constructor - * @extends {module:ol/ImageBase} * @param {module:ol/proj/Projection} sourceProj Source projection (of the data). * @param {module:ol/proj/Projection} targetProj Target projection. * @param {module:ol/extent~Extent} targetExtent Target extent. diff --git a/src/ol/reproj/Tile.js b/src/ol/reproj/Tile.js index a02d4b7606..2ef188b86e 100644 --- a/src/ol/reproj/Tile.js +++ b/src/ol/reproj/Tile.js @@ -24,8 +24,6 @@ class ReprojTile extends Tile { * Class encapsulating single reprojected tile. * See {@link module:ol/source/TileImage~TileImage}. * - * @constructor - * @extends {module:ol/Tile} * @param {module:ol/proj/Projection} sourceProj Source projection. * @param {module:ol/tilegrid/TileGrid} sourceTileGrid Source tile grid. * @param {module:ol/proj/Projection} targetProj Target projection. diff --git a/src/ol/reproj/Triangulation.js b/src/ol/reproj/Triangulation.js index 838c653ca7..4a480524c3 100644 --- a/src/ol/reproj/Triangulation.js +++ b/src/ol/reproj/Triangulation.js @@ -40,15 +40,16 @@ const MAX_TRIANGLE_WIDTH = 0.25; * @classdesc * Class containing triangulation of the given target extent. * Used for determining source data and the reprojection itself. - * - * @param {module:ol/proj/Projection} sourceProj Source projection. - * @param {module:ol/proj/Projection} targetProj Target projection. - * @param {module:ol/extent~Extent} targetExtent Target extent to triangulate. - * @param {module:ol/extent~Extent} maxSourceExtent Maximal source extent that can be used. - * @param {number} errorThreshold Acceptable error (in source units). - * @constructor */ class Triangulation { + + /** + * @param {module:ol/proj/Projection} sourceProj Source projection. + * @param {module:ol/proj/Projection} targetProj Target projection. + * @param {module:ol/extent~Extent} targetExtent Target extent to triangulate. + * @param {module:ol/extent~Extent} maxSourceExtent Maximal source extent that can be used. + * @param {number} errorThreshold Acceptable error (in source units). + */ constructor(sourceProj, targetProj, targetExtent, maxSourceExtent, errorThreshold) { /** diff --git a/src/ol/source/BingMaps.js b/src/ol/source/BingMaps.js index d8813f815c..c92d5926a1 100644 --- a/src/ol/source/BingMaps.js +++ b/src/ol/source/BingMaps.js @@ -49,8 +49,6 @@ class BingMaps extends TileImage { * @classdesc * Layer source for Bing Maps tile data. * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/BingMaps~Options=} options Bing Maps options. * @api */ diff --git a/src/ol/source/CartoDB.js b/src/ol/source/CartoDB.js index 301c21d339..cea2152946 100644 --- a/src/ol/source/CartoDB.js +++ b/src/ol/source/CartoDB.js @@ -36,8 +36,6 @@ class CartoDB extends XYZ { * @classdesc * Layer source for the CartoDB Maps API. * - * @constructor - * @extends {module:ol/source/XYZ} * @param {module:ol/source/CartoDB~Options=} options CartoDB options. * @api */ diff --git a/src/ol/source/Cluster.js b/src/ol/source/Cluster.js index 48eaaf5a9d..4e10689c68 100644 --- a/src/ol/source/Cluster.js +++ b/src/ol/source/Cluster.js @@ -43,9 +43,7 @@ class Cluster extends VectorSource { * geometries. For other geometry types, or if not all geometries should be * considered for clustering, a custom `geometryFunction` can be defined. * - * @constructor * @param {module:ol/source/Cluster~Options=} options Cluster options. - * @extends {module:ol/source/Vector} * @api */ constructor(options) { diff --git a/src/ol/source/Image.js b/src/ol/source/Image.js index 1a0a27172f..9c5a34b499 100644 --- a/src/ol/source/Image.js +++ b/src/ol/source/Image.js @@ -48,8 +48,6 @@ class ImageSourceEvent extends Event { * Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this * type. * - * @constructor - * @extends {module:ol/events/Event} * @param {string} type Type. * @param {module:ol/Image} image The image. */ @@ -86,9 +84,6 @@ class ImageSource extends Source { * instantiated in apps. * Base class for sources providing a single image. * - * @constructor - * @abstract - * @extends {module:ol/source/Source} * @param {module:ol/source/Image~Options} options Single image source options. * @api */ diff --git a/src/ol/source/ImageArcGISRest.js b/src/ol/source/ImageArcGISRest.js index 9bd9b4a011..1141f5c3a0 100644 --- a/src/ol/source/ImageArcGISRest.js +++ b/src/ol/source/ImageArcGISRest.js @@ -49,9 +49,7 @@ class ImageArcGISRest extends ImageSource { * take advantage of ol image caching and use * {@link module:ol/source/TileArcGISRest} data source. * - * @constructor * @fires ol/source/Image~ImageSourceEvent - * @extends {module:ol/source/Image} * @param {module:ol/source/ImageArcGISRest~Options=} opt_options Image ArcGIS Rest Options. * @api */ diff --git a/src/ol/source/ImageCanvas.js b/src/ol/source/ImageCanvas.js index eee6f6a6dd..81838533a1 100644 --- a/src/ol/source/ImageCanvas.js +++ b/src/ol/source/ImageCanvas.js @@ -47,8 +47,6 @@ class ImageCanvasSource extends ImageSource { * @classdesc * Base class for image sources where a canvas element is the image. * - * @constructor - * @extends {module:ol/source/Image} * @param {module:ol/source/ImageCanvas~Options=} options ImageCanvas options. * @api */ diff --git a/src/ol/source/ImageMapGuide.js b/src/ol/source/ImageMapGuide.js index 115e764576..d65be4ce7b 100644 --- a/src/ol/source/ImageMapGuide.js +++ b/src/ol/source/ImageMapGuide.js @@ -37,9 +37,7 @@ class ImageMapGuide extends ImageSource { * @classdesc * Source for images from Mapguide servers * - * @constructor * @fires ol/source/Image~ImageSourceEvent - * @extends {module:ol/source/Image} * @param {module:ol/source/ImageMapGuide~Options=} options ImageMapGuide options. * @api */ diff --git a/src/ol/source/ImageStatic.js b/src/ol/source/ImageStatic.js index 11ea42ea44..c278854785 100644 --- a/src/ol/source/ImageStatic.js +++ b/src/ol/source/ImageStatic.js @@ -33,8 +33,6 @@ class Static extends ImageSource { * @classdesc * A layer source for displaying a single, static image. * - * @constructor - * @extends {module:ol/source/Image} * @param {module:ol/source/ImageStatic~Options=} options ImageStatic options. * @api */ diff --git a/src/ol/source/ImageWMS.js b/src/ol/source/ImageWMS.js index fd8f80cc5e..a02e8b346c 100644 --- a/src/ol/source/ImageWMS.js +++ b/src/ol/source/ImageWMS.js @@ -56,9 +56,7 @@ class ImageWMS extends ImageSource { * @classdesc * Source for WMS servers providing single, untiled images. * - * @constructor * @fires ol/source/Image~ImageSourceEvent - * @extends {module:ol/source/Image} * @param {module:ol/source/ImageWMS~Options=} [opt_options] ImageWMS options. * @api */ diff --git a/src/ol/source/OSM.js b/src/ol/source/OSM.js index d551190299..c5192e8911 100644 --- a/src/ol/source/OSM.js +++ b/src/ol/source/OSM.js @@ -47,8 +47,6 @@ class OSM extends XYZ { * @classdesc * Layer source for the OpenStreetMap tile server. * - * @constructor - * @extends {module:ol/source/XYZ} * @param {module:ol/source/OSM~Options=} [opt_options] Open Street Map options. * @api */ diff --git a/src/ol/source/Raster.js b/src/ol/source/Raster.js index 9526dd7d61..b48e1ee9bf 100644 --- a/src/ol/source/Raster.js +++ b/src/ol/source/Raster.js @@ -79,8 +79,6 @@ class RasterSourceEvent extends Event { * Events emitted by {@link module:ol/source/Raster} instances are instances of this * type. * - * @constructor - * @extends {module:ol/events/Event} * @param {string} type Type. * @param {module:ol/PluggableMap~FrameState} frameState The frame state. * @param {Object} data An object made available to operations. @@ -142,8 +140,6 @@ class RasterSource extends ImageSource { * {@link module:ol/source/Raster~Operation} function to transform input pixel values into * output pixel values. * - * @constructor - * @extends {module:ol/source/Image} * @fires ol/source/Raster~RasterSourceEvent * @param {module:ol/source/Raster~Options=} options Options. * @api diff --git a/src/ol/source/Source.js b/src/ol/source/Source.js index 468d7c71b8..6310d7587a 100644 --- a/src/ol/source/Source.js +++ b/src/ol/source/Source.js @@ -46,9 +46,6 @@ class Source extends BaseObject { * * A generic `change` event is triggered when the state of the source changes. * - * @constructor - * @abstract - * @extends {module:ol/Object} * @param {module:ol/source/Source~Options} options Source options. * @api */ diff --git a/src/ol/source/Stamen.js b/src/ol/source/Stamen.js index 6a23d12c27..20447bffda 100644 --- a/src/ol/source/Stamen.js +++ b/src/ol/source/Stamen.js @@ -115,8 +115,6 @@ class Stamen extends XYZ { * @classdesc * Layer source for the Stamen tile server. * - * @constructor - * @extends {module:ol/source/XYZ} * @param {module:ol/source/Stamen~Options=} options Stamen options. * @api */ diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js index 427f3e547b..8bbea4407f 100644 --- a/src/ol/source/Tile.js +++ b/src/ol/source/Tile.js @@ -34,9 +34,6 @@ class TileSource extends Source { * instantiated in apps. * Base class for sources providing images divided into a tile grid. * - * @constructor - * @abstract - * @extends {module:ol/source/Source} * @param {module:ol/source/Tile~Options=} options SourceTile source options. * @api */ @@ -311,8 +308,6 @@ TileSource.prototype.useTile = UNDEFINED; * Events emitted by {@link module:ol/source/Tile~TileSource} instances are instances of this * type. * - * @constructor - * @extends {module:ol/events/Event} * @param {string} type Type. * @param {module:ol/Tile} tile The tile. */ diff --git a/src/ol/source/TileArcGISRest.js b/src/ol/source/TileArcGISRest.js index d4e83a4a64..c93e2b7f78 100644 --- a/src/ol/source/TileArcGISRest.js +++ b/src/ol/source/TileArcGISRest.js @@ -60,8 +60,6 @@ class TileArcGISRest extends TileImage { * For cached ArcGIS services, better performance is available using the * {@link module:ol/source/XYZ~XYZ} data source. * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/TileArcGISRest~Options=} opt_options Tile ArcGIS Rest options. * @api */ diff --git a/src/ol/source/TileDebug.js b/src/ol/source/TileDebug.js index 44033c6c69..e0286cb9d2 100644 --- a/src/ol/source/TileDebug.js +++ b/src/ol/source/TileDebug.js @@ -12,8 +12,6 @@ import {getKeyZXY} from '../tilecoord.js'; class LabeledTile extends Tile { /** - * @constructor - * @extends {module:ol/Tile} * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate. * @param {module:ol/size~Size} tileSize Tile size. * @param {string} text Text. @@ -91,8 +89,6 @@ class TileDebug extends TileSource { * * Uses Canvas context2d, so requires Canvas support. * - * @constructor - * @extends {module:ol/source/Tile} * @param {module:ol/source/TileDebug~Options=} options Debug tile options. * @api */ diff --git a/src/ol/source/TileImage.js b/src/ol/source/TileImage.js index d822e37fe6..8ac058026a 100644 --- a/src/ol/source/TileImage.js +++ b/src/ol/source/TileImage.js @@ -59,9 +59,7 @@ class TileImage extends UrlTile { * @classdesc * Base class for sources providing images divided into a tile grid. * - * @constructor * @fires module:ol/source/Tile~TileSourceEvent - * @extends {module:ol/source/UrlTile} * @param {module:ol/source/TileImage~Options=} options Image tile options. * @api */ diff --git a/src/ol/source/TileJSON.js b/src/ol/source/TileJSON.js index 5bb800fbd9..69b01151b0 100644 --- a/src/ol/source/TileJSON.js +++ b/src/ol/source/TileJSON.js @@ -49,8 +49,6 @@ class TileJSON extends TileImage { * @classdesc * Layer source for tile data in TileJSON format. * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/TileJSON~Options=} options TileJSON options. * @api */ diff --git a/src/ol/source/TileWMS.js b/src/ol/source/TileWMS.js index 890b1a157b..13add52b03 100644 --- a/src/ol/source/TileWMS.js +++ b/src/ol/source/TileWMS.js @@ -76,8 +76,6 @@ class TileWMS extends TileImage { * @classdesc * Layer source for tile data from WMS servers. * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/TileWMS~Options=} [opt_options] Tile WMS options. * @api */ diff --git a/src/ol/source/UTFGrid.js b/src/ol/source/UTFGrid.js index 37619a55b8..c867101eb2 100644 --- a/src/ol/source/UTFGrid.js +++ b/src/ol/source/UTFGrid.js @@ -18,8 +18,6 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js'; /** - * @constructor - * @extends {module:ol/Tile} * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate. * @param {module:ol/TileState} state State. * @param {string} src Image source URI. @@ -275,8 +273,6 @@ class UTFGrid extends TileSource { * @classdesc * Layer source for UTFGrid interaction data loaded from TileJSON format. * - * @constructor - * @extends {module:ol/source/Tile} * @param {module:ol/source/UTFGrid~Options=} options Source options. * @api */ diff --git a/src/ol/source/UrlTile.js b/src/ol/source/UrlTile.js index 073698bbd4..39f07412aa 100644 --- a/src/ol/source/UrlTile.js +++ b/src/ol/source/UrlTile.js @@ -32,10 +32,7 @@ class UrlTile extends TileSource { * @classdesc * Base class for sources providing tiles divided into a tile grid over http. * - * @constructor - * @abstract * @fires module:ol/source/TileEvent - * @extends {module:ol/source/Tile} * @param {module:ol/source/UrlTile~Options=} options Image tile options. */ constructor(options) { diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 90bf0fdd1d..1c9c4f00e5 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -36,8 +36,6 @@ import RBush from '../structs/RBush.js'; * Events emitted by {@link module:ol/source/Vector} instances are instances of this * type. * - * @constructor - * @extends {module:ol/events/Event} * @param {string} type Type. * @param {module:ol/Feature=} opt_feature Feature. */ @@ -157,8 +155,6 @@ class VectorSource extends Source { * by this source are suitable for editing. See {@link module:ol/source/VectorTile~VectorTile} for * vector data that is optimized for rendering. * - * @constructor - * @extends {module:ol/source/Source} * @fires ol/source/Vector~VectorSourceEvent * @param {module:ol/source/Vector~Options=} opt_options Vector source options. * @api diff --git a/src/ol/source/VectorTile.js b/src/ol/source/VectorTile.js index 31b4ef8a1b..a128617354 100644 --- a/src/ol/source/VectorTile.js +++ b/src/ol/source/VectorTile.js @@ -70,9 +70,7 @@ class VectorTile extends UrlTile { * {@link module:ol/source/Vector} for vector sources that are suitable for feature * editing. * - * @constructor * @fires module:ol/source/Tile~TileSourceEvent - * @extends {module:ol/source/UrlTile} * @param {module:ol/source/VectorTile~Options=} options Vector tile options. * @api */ diff --git a/src/ol/source/WMTS.js b/src/ol/source/WMTS.js index d418f96386..fe48d62a22 100644 --- a/src/ol/source/WMTS.js +++ b/src/ol/source/WMTS.js @@ -62,8 +62,6 @@ class WMTS extends TileImage { * @classdesc * Layer source for tile data from WMTS servers. * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/WMTS~Options=} options WMTS options. * @api */ diff --git a/src/ol/source/XYZ.js b/src/ol/source/XYZ.js index fbc9cc756d..ddabfaf5cf 100644 --- a/src/ol/source/XYZ.js +++ b/src/ol/source/XYZ.js @@ -63,8 +63,6 @@ class XYZ extends TileImage { * } * * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/XYZ~Options=} opt_options XYZ options. * @api */ diff --git a/src/ol/source/Zoomify.js b/src/ol/source/Zoomify.js index f1e7ed9878..b6f58be100 100644 --- a/src/ol/source/Zoomify.js +++ b/src/ol/source/Zoomify.js @@ -24,8 +24,6 @@ const TierSizeCalculation = { /** - * @constructor - * @extends {module:ol/ImageTile} * @param {module:ol/tilegrid/TileGrid} tileGrid TileGrid that the tile belongs to. * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate. * @param {module:ol/TileState} state State. @@ -124,8 +122,6 @@ class Zoomify extends TileImage { * Layer source for tile data in Zoomify format (both Zoomify and Internet * Imaging Protocol are supported). * - * @constructor - * @extends {module:ol/source/TileImage} * @param {module:ol/source/Zoomify~Options=} opt_options Options. * @api */ diff --git a/src/ol/structs/LRUCache.js b/src/ol/structs/LRUCache.js index 2c4dff5798..ee431d8253 100644 --- a/src/ol/structs/LRUCache.js +++ b/src/ol/structs/LRUCache.js @@ -22,8 +22,7 @@ class LRUCache extends EventTarget { * Implements a Least-Recently-Used cache where the keys do not conflict with * Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring * items from the cache is the responsibility of the user. - * @constructor - * @extends {module:ol/events/EventTarget} + * * @fires module:ol/events/Event~Event * @struct * @template T diff --git a/src/ol/structs/LinkedList.js b/src/ol/structs/LinkedList.js index 933d9c42c4..bbaf16afb4 100644 --- a/src/ol/structs/LinkedList.js +++ b/src/ol/structs/LinkedList.js @@ -11,16 +11,14 @@ */ -/** - * Creates an empty linked list structure. - * - * @constructor - * @struct - * @param {boolean=} opt_circular The last item is connected to the first one, - * and the first item to the last one. Default is true. - */ class LinkedList { + /** + * Creates an empty linked list structure. + * + * @param {boolean=} opt_circular The last item is connected to the first one, + * and the first item to the last one. Default is true. + */ constructor(opt_circular) { /** diff --git a/src/ol/structs/PriorityQueue.js b/src/ol/structs/PriorityQueue.js index d8b75a9a17..2bbd260cdc 100644 --- a/src/ol/structs/PriorityQueue.js +++ b/src/ol/structs/PriorityQueue.js @@ -11,23 +11,21 @@ import {clear} from '../obj.js'; export const DROP = Infinity; -/** - * Priority queue. - * - * The implementation is inspired from the Closure Library's Heap class and - * Python's heapq module. - * - * @see http://closure-library.googlecode.com/svn/docs/closure_goog_structs_heap.js.source.html - * @see http://hg.python.org/cpython/file/2.7/Lib/heapq.py - * - * @constructor - * @param {function(T): number} priorityFunction Priority function. - * @param {function(T): string} keyFunction Key function. - * @struct - * @template T - */ class PriorityQueue { - + /** + * Priority queue. + * + * The implementation is inspired from the Closure Library's Heap class and + * Python's heapq module. + * + * @see http://closure-library.googlecode.com/svn/docs/closure_goog_structs_heap.js.source.html + * @see http://hg.python.org/cpython/file/2.7/Lib/heapq.py + * + * @param {function(T): number} priorityFunction Priority function. + * @param {function(T): string} keyFunction Key function. + * @struct + * @template T + */ constructor(priorityFunction, keyFunction) { /** diff --git a/src/ol/structs/RBush.js b/src/ol/structs/RBush.js index 025d81aee6..9cf1350187 100644 --- a/src/ol/structs/RBush.js +++ b/src/ol/structs/RBush.js @@ -15,17 +15,16 @@ import {isEmpty} from '../obj.js'; * @property {Object} [value] */ -/** - * Wrapper around the RBush by Vladimir Agafonkin. - * - * @constructor - * @param {number=} opt_maxEntries Max entries. - * @see https://github.com/mourner/rbush - * @struct - * @template T - */ class RBush { + /** + * Wrapper around the RBush by Vladimir Agafonkin. + * + * @param {number=} opt_maxEntries Max entries. + * @see https://github.com/mourner/rbush + * @struct + * @template T + */ constructor(opt_maxEntries) { /** diff --git a/src/ol/style/Atlas.js b/src/ol/style/Atlas.js index 27dba344e4..d60ab4f387 100644 --- a/src/ol/style/Atlas.js +++ b/src/ol/style/Atlas.js @@ -21,24 +21,24 @@ import {createCanvasContext2D} from '../dom.js'; * @property {HTMLCanvasElement} image */ -/** - * This class facilitates the creation of image atlases. - * - * Images added to an atlas will be rendered onto a single - * atlas canvas. The distribution of images on the canvas is - * managed with the bin packing algorithm described in: - * http://www.blackpawn.com/texts/lightmaps/ - * - * @constructor - * @struct - * @param {number} size The size in pixels of the sprite image. - * @param {number} space The space in pixels between images. - * Because texture coordinates are float values, the edges of - * images might not be completely correct (in a way that the - * edges overlap when being rendered). To avoid this we add a - * padding around each image. - */ class Atlas { + + /** + * This class facilitates the creation of image atlases. + * + * Images added to an atlas will be rendered onto a single + * atlas canvas. The distribution of images on the canvas is + * managed with the bin packing algorithm described in: + * http://www.blackpawn.com/texts/lightmaps/ + * + * @struct + * @param {number} size The size in pixels of the sprite image. + * @param {number} space The space in pixels between images. + * Because texture coordinates are float values, the edges of + * images might not be completely correct (in a way that the + * edges overlap when being rendered). To avoid this we add a + * padding around each image. + */ constructor(size, space) { /** diff --git a/src/ol/style/AtlasManager.js b/src/ol/style/AtlasManager.js index bcfb7e2592..d2883ff301 100644 --- a/src/ol/style/AtlasManager.js +++ b/src/ol/style/AtlasManager.js @@ -41,24 +41,23 @@ const INITIAL_ATLAS_SIZE = 256; const MAX_ATLAS_SIZE = -1; -/** - * Manages the creation of image atlases. - * - * Images added to this manager will be inserted into an atlas, which - * will be used for rendering. - * The `size` given in the constructor is the size for the first - * atlas. After that, when new atlases are created, they will have - * twice the size as the latest atlas (until `maxSize` is reached). - * - * If an application uses many images or very large images, it is recommended - * to set a higher `size` value to avoid the creation of too many atlases. - * - * @constructor - * @struct - * @api - * @param {module:ol/style/AtlasManager~Options=} opt_options Options. - */ class AtlasManager { + /** + * Manages the creation of image atlases. + * + * Images added to this manager will be inserted into an atlas, which + * will be used for rendering. + * The `size` given in the constructor is the size for the first + * atlas. After that, when new atlases are created, they will have + * twice the size as the latest atlas (until `maxSize` is reached). + * + * If an application uses many images or very large images, it is recommended + * to set a higher `size` value to avoid the creation of too many atlases. + * + * @struct + * @api + * @param {module:ol/style/AtlasManager~Options=} opt_options Options. + */ constructor(opt_options) { const options = opt_options || {}; diff --git a/src/ol/style/Circle.js b/src/ol/style/Circle.js index 9e6d91c9ef..a322e90907 100644 --- a/src/ol/style/Circle.js +++ b/src/ol/style/Circle.js @@ -25,9 +25,7 @@ class CircleStyle extends RegularShape { * @classdesc * Set circle style for vector features. * - * @constructor * @param {module:ol/style/Circle~Options=} opt_options Options. - * @extends {module:ol/style/RegularShape} * @api */ constructor(opt_options) { diff --git a/src/ol/style/Fill.js b/src/ol/style/Fill.js index 9a4ba82cee..595dec40c2 100644 --- a/src/ol/style/Fill.js +++ b/src/ol/style/Fill.js @@ -16,12 +16,12 @@ import {asString} from '../color.js'; /** * @classdesc * Set fill style for vector features. - * - * @constructor - * @param {module:ol/style/Fill~Options=} opt_options Options. - * @api */ class Fill { + /** + * @param {module:ol/style/Fill~Options=} opt_options Options. + * @api + */ constructor(opt_options) { const options = opt_options || {}; diff --git a/src/ol/style/Icon.js b/src/ol/style/Icon.js index 8eb05223d2..5972bfe5e9 100644 --- a/src/ol/style/Icon.js +++ b/src/ol/style/Icon.js @@ -57,9 +57,7 @@ class Icon extends ImageStyle { * @classdesc * Set icon style for vector features. * - * @constructor * @param {module:ol/style/Icon~Options=} opt_options Options. - * @extends {module:ol/style/Image} * @api */ constructor(opt_options) { diff --git a/src/ol/style/IconImage.js b/src/ol/style/IconImage.js index 34c148f199..3b01ee9a94 100644 --- a/src/ol/style/IconImage.js +++ b/src/ol/style/IconImage.js @@ -11,14 +11,12 @@ import {shared as iconImageCache} from '../style/IconImageCache.js'; class IconImage extends EventTarget { /** - * @constructor * @param {HTMLImageElement|HTMLCanvasElement} image Image. * @param {string|undefined} src Src. * @param {module:ol/size~Size} size Size. * @param {?string} crossOrigin Cross origin. * @param {module:ol/ImageState} imageState Image state. * @param {module:ol/color~Color} color Color. - * @extends {module:ol/events/EventTarget} */ constructor(image, src, size, crossOrigin, imageState, color) { diff --git a/src/ol/style/IconImageCache.js b/src/ol/style/IconImageCache.js index 311798d8d8..b89d55f2d1 100644 --- a/src/ol/style/IconImageCache.js +++ b/src/ol/style/IconImageCache.js @@ -5,7 +5,6 @@ import {asString} from '../color.js'; /** * Singleton class. Available through {@link module:ol/style/IconImageCache~shared}. - * @constructor */ class IconImageCache { constructor() { diff --git a/src/ol/style/Image.js b/src/ol/style/Image.js index 8b5d105366..5b659ff3de 100644 --- a/src/ol/style/Image.js +++ b/src/ol/style/Image.js @@ -18,13 +18,12 @@ * A base class used for creating subclasses and not instantiated in * apps. Base class for {@link module:ol/style/Icon~Icon}, {@link module:ol/style/Circle~CircleStyle} and * {@link module:ol/style/RegularShape~RegularShape}. - * - * @constructor - * @abstract - * @param {module:ol/style/Image~Options} options Options. - * @api */ class ImageStyle { + /** + * @param {module:ol/style/Image~Options} options Options. + * @api + */ constructor(options) { /** diff --git a/src/ol/style/RegularShape.js b/src/ol/style/RegularShape.js index ca70d7508b..b8c00b3c20 100644 --- a/src/ol/style/RegularShape.js +++ b/src/ol/style/RegularShape.js @@ -53,9 +53,7 @@ class RegularShape extends ImageStyle { * a regular polygon when `radius` is provided, or a star when `radius1` and * `radius2` are provided. * - * @constructor * @param {module:ol/style/RegularShape~Options} options Options. - * @extends {module:ol/style/Image} * @api */ constructor(options) { diff --git a/src/ol/style/Stroke.js b/src/ol/style/Stroke.js index d5e6571197..4e42ae23a8 100644 --- a/src/ol/style/Stroke.js +++ b/src/ol/style/Stroke.js @@ -26,12 +26,13 @@ import {getUid} from '../util.js'; * Note that the defaults given are the Canvas defaults, which will be used if * option is not defined. The `get` functions return whatever was entered in * the options; they will not return the default. - * - * @constructor - * @param {module:ol/style/Stroke~Options=} opt_options Options. - * @api */ class Stroke { + + /** + * @param {module:ol/style/Stroke~Options=} opt_options Options. + * @api + */ constructor(opt_options) { const options = opt_options || {}; diff --git a/src/ol/style/Style.js b/src/ol/style/Style.js index 69c8cadf3a..a1fa6d404d 100644 --- a/src/ol/style/Style.js +++ b/src/ol/style/Style.js @@ -143,13 +143,13 @@ import Stroke from '../style/Stroke.js'; * Container for vector feature rendering styles. Any changes made to the style * or its children through `set*()` methods will not take effect until the * feature or layer that uses the style is re-rendered. - * - * @constructor - * @struct - * @param {module:ol/style/Style~Options=} opt_options Style options. - * @api */ class Style { + + /** + * @param {module:ol/style/Style~Options=} opt_options Style options. + * @api + */ constructor(opt_options) { const options = opt_options || {}; diff --git a/src/ol/style/Text.js b/src/ol/style/Text.js index cd88073c82..c1eccc69fd 100644 --- a/src/ol/style/Text.js +++ b/src/ol/style/Text.js @@ -48,12 +48,13 @@ const DEFAULT_FILL_COLOR = '#333'; /** * @classdesc * Set text style for vector features. - * - * @constructor - * @param {module:ol/style/Text~Options=} opt_options Options. - * @api */ class Text { + + /** + * @param {module:ol/style/Text~Options=} opt_options Options. + * @api + */ constructor(opt_options) { const options = opt_options || {}; diff --git a/src/ol/tilegrid/TileGrid.js b/src/ol/tilegrid/TileGrid.js index b1c064c9b2..9d3d4bee6c 100644 --- a/src/ol/tilegrid/TileGrid.js +++ b/src/ol/tilegrid/TileGrid.js @@ -48,13 +48,13 @@ const tmpTileCoord = [0, 0, 0]; * @classdesc * Base class for setting the grid pattern for sources accessing tiled-image * servers. - * - * @constructor - * @param {module:ol/tilegrid/TileGrid~Options} options Tile grid options. - * @struct - * @api */ class TileGrid { + + /** + * @param {module:ol/tilegrid/TileGrid~Options} options Tile grid options. + * @api + */ constructor(options) { /** diff --git a/src/ol/tilegrid/WMTS.js b/src/ol/tilegrid/WMTS.js index f9245390db..7582fd7077 100644 --- a/src/ol/tilegrid/WMTS.js +++ b/src/ol/tilegrid/WMTS.js @@ -50,8 +50,6 @@ class WMTSTileGrid extends TileGrid { * @classdesc * Set the grid pattern for sources accessing WMTS tiled-image servers. * - * @constructor - * @extends {module:ol/tilegrid/TileGrid} * @param {module:ol/tilegrid/WMTS~Options} options WMTS options. * @struct * @api diff --git a/src/ol/webgl/Context.js b/src/ol/webgl/Context.js index 2c313263a3..d3cad9c99e 100644 --- a/src/ol/webgl/Context.js +++ b/src/ol/webgl/Context.js @@ -21,8 +21,6 @@ import ContextEventType from '../webgl/ContextEventType.js'; /** * @classdesc * A WebGL context for accessing low-level WebGL capabilities. - * - * @extends {module:ol/Disposable} */ class WebGLContext extends Disposable { diff --git a/src/ol/webgl/Fragment.js b/src/ol/webgl/Fragment.js index e96a853502..aeb90368f2 100644 --- a/src/ol/webgl/Fragment.js +++ b/src/ol/webgl/Fragment.js @@ -5,9 +5,6 @@ import {FRAGMENT_SHADER} from '../webgl.js'; import WebGLShader from '../webgl/Shader.js'; -/** - * @extends {module:ol/webgl/Shader} - */ class WebGLFragment extends WebGLShader { /** diff --git a/src/ol/webgl/Vertex.js b/src/ol/webgl/Vertex.js index 746d871319..579aaa2bae 100644 --- a/src/ol/webgl/Vertex.js +++ b/src/ol/webgl/Vertex.js @@ -5,9 +5,6 @@ import {VERTEX_SHADER} from '../webgl.js'; import WebGLShader from '../webgl/Shader.js'; -/** - * @extends {module:ol/webgl/Shader} - */ class WebGLVertex extends WebGLShader { /** diff --git a/test/spec/ol/source/tile.test.js b/test/spec/ol/source/tile.test.js index 4073321b81..0a46e6dc85 100644 --- a/test/spec/ol/source/tile.test.js +++ b/test/spec/ol/source/tile.test.js @@ -13,8 +13,6 @@ import TileGrid from '../../../../src/ol/tilegrid/TileGrid.js'; * Tile source for tests that uses a EPSG:4326 based grid with 4 resolutions and * 256x256 tiles. * - * @constructor - * @extends {ol.source.Tile} * @param {Object.} tileStates Lookup of tile key to * tile state. */