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

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