Remove @extends and @constructor annotations

This commit is contained in:
Tim Schaub
2018-07-18 00:36:29 -06:00
parent b7b15eb7f0
commit 9ce36da349
87 changed files with 110 additions and 282 deletions

View File

@@ -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 {

View File

@@ -5,7 +5,6 @@ import {UNDEFINED} from './functions.js';
/**
* Objects that need to clean up after themselves.
* @constructor
*/
class Disposable {
/**

View File

@@ -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) {
/**

View File

@@ -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() {

View File

@@ -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;

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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) {

View File

@@ -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.

View File

@@ -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.<number>} flatCoordinates Flat coordinates. These always need
* to be right-handed for polygons.

View File

@@ -3,8 +3,6 @@
*/
/**
* Base class for replay groups.
* @constructor
* @abstract
*/
class ReplayGroup {
/**

View File

@@ -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
*/

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.
*
*/
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
*/
class Triangulation {
constructor(sourceProj, targetProj, targetExtent, maxSourceExtent, errorThreshold) {
/**

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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) {

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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.
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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) {

View File

@@ -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

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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
*/

View File

@@ -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

View File

@@ -11,16 +11,14 @@
*/
/**
class LinkedList {
/**
* 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 {
constructor(opt_circular) {
/**

View File

@@ -11,7 +11,8 @@ import {clear} from '../obj.js';
export const DROP = Infinity;
/**
class PriorityQueue {
/**
* Priority queue.
*
* The implementation is inspired from the Closure Library's Heap class and
@@ -20,14 +21,11 @@ export const DROP = Infinity;
* @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 {
constructor(priorityFunction, keyFunction) {
/**

View File

@@ -15,17 +15,16 @@ import {isEmpty} from '../obj.js';
* @property {Object} [value]
*/
/**
class RBush {
/**
* 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 {
constructor(opt_maxEntries) {
/**

View File

@@ -21,7 +21,9 @@ import {createCanvasContext2D} from '../dom.js';
* @property {HTMLCanvasElement} image
*/
/**
class Atlas {
/**
* This class facilitates the creation of image atlases.
*
* Images added to an atlas will be rendered onto a single
@@ -29,7 +31,6 @@ import {createCanvasContext2D} from '../dom.js';
* 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.
@@ -38,7 +39,6 @@ import {createCanvasContext2D} from '../dom.js';
* edges overlap when being rendered). To avoid this we add a
* padding around each image.
*/
class Atlas {
constructor(size, space) {
/**

View File

@@ -41,7 +41,8 @@ const INITIAL_ATLAS_SIZE = 256;
const MAX_ATLAS_SIZE = -1;
/**
class AtlasManager {
/**
* Manages the creation of image atlases.
*
* Images added to this manager will be inserted into an atlas, which
@@ -53,12 +54,10 @@ const MAX_ATLAS_SIZE = -1;
* 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 {
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -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) {

View File

@@ -16,12 +16,12 @@ import {asString} from '../color.js';
/**
* @classdesc
* Set fill style for vector features.
*
* @constructor
*/
class Fill {
/**
* @param {module:ol/style/Fill~Options=} opt_options Options.
* @api
*/
class Fill {
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -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) {

View File

@@ -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) {

View File

@@ -5,7 +5,6 @@ import {asString} from '../color.js';
/**
* Singleton class. Available through {@link module:ol/style/IconImageCache~shared}.
* @constructor
*/
class IconImageCache {
constructor() {

View File

@@ -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
*/
class ImageStyle {
/**
* @param {module:ol/style/Image~Options} options Options.
* @api
*/
class ImageStyle {
constructor(options) {
/**

View File

@@ -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) {

View File

@@ -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
*/
class Stroke {
/**
* @param {module:ol/style/Stroke~Options=} opt_options Options.
* @api
*/
class Stroke {
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -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
*/
class Style {
/**
* @param {module:ol/style/Style~Options=} opt_options Style options.
* @api
*/
class Style {
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -48,12 +48,13 @@ const DEFAULT_FILL_COLOR = '#333';
/**
* @classdesc
* Set text style for vector features.
*
* @constructor
*/
class Text {
/**
* @param {module:ol/style/Text~Options=} opt_options Options.
* @api
*/
class Text {
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -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) {
/**

View File

@@ -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

View File

@@ -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 {

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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.<string, ol.TileState>} tileStates Lookup of tile key to
* tile state.
*/