Move jsdoc constructor comments

src/ol/AssertionError.js

@@ -7,12 +7,13 @@ import {VERSION, inherits} 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}
- * @constructor
  * @extends {Error}
- * @param {number} code Error code.
  */
 class AssertionError {
 
+  /**
+   * @param {number} code Error code.
+   */
   constructor(code) {
     const path = VERSION.split('-')[0];
 
@@ -32,6 +33,9 @@ class AssertionError {
      */
     this.code = code;
 
+    /**
+     * @type {string}
+     */
     this.name = 'AssertionError';
 
   }

src/ol/Collection.js

@@ -22,13 +22,14 @@ const Property = {
  * Events emitted by {@link module:ol/Collection~Collection} instances are instances of this
  * type.
  *
- * @constructor
  * @extends {module:ol/events/Event}
- * @param {module:ol/CollectionEventType} type Type.
- * @param {*=} opt_element Element.
  */
 export class CollectionEvent {
 
+  /**
+   * @param {module:ol/CollectionEventType} type Type.
+   * @param {*=} opt_element Element.
+   */
   constructor(type, opt_element) {
     Event.call(this, type);
 
@@ -60,15 +61,16 @@ inherits(CollectionEvent, Event);
  * Collection; they trigger events on the appropriate object, not on the
  * Collection as a whole.
  *
- * @constructor
  * @extends {module:ol/Object}
- * @fires module:ol/Collection~CollectionEvent
- * @param {Array.<T>=} opt_array Array.
- * @param {module:ol/Collection~Options=} opt_options Collection options.
- * @template T
  * @api
  */
 class Collection {
+
+  /**
+   * @param {Array.<T>=} opt_array Array.
+   * @param {module:ol/Collection~Options=} opt_options Collection options.
+   * @template T
+   */
   constructor(opt_array, opt_options) {
 
     BaseObject.call(this);

src/ol/Feature.js

@@ -51,15 +51,17 @@ import Style from './style/Style.js';
  * var point = feature.getGeometry();
  * ```
  *
- * @constructor
  * @extends {module:ol/Object}
- * @param {module:ol/geom/Geometry|Object.<string, *>=} opt_geometryOrProperties
- * You may pass a Geometry object directly, or an object literal containing
- * properties. If you pass an object literal, you may include a Geometry
- * associated with a `geometry` key.
  * @api
  */
 class Feature {
+
+  /**
+   * @param {module:ol/geom/Geometry|Object.<string, *>=} opt_geometryOrProperties
+   *     You may pass a Geometry object directly, or an object literal containing
+   *     properties. If you pass an object literal, you may include a Geometry
+   *     associated with a `geometry` key.
+   */
   constructor(opt_geometryOrProperties) {
 
     BaseObject.call(this);

src/ol/Geolocation.js

@@ -44,12 +44,14 @@ import {get as getProjection, getTransformFromProjections, identityTransform} fr
  *     });
  *
  * @fires error
- * @constructor
  * @extends {module:ol/Object}
- * @param {module:ol/Geolocation~Options=} opt_options Options.
  * @api
  */
 class Geolocation {
+
+  /**
+   * @param {module:ol/Geolocation~Options=} opt_options Options.
+   */
   constructor(opt_options) {
 
     BaseObject.call(this);

src/ol/Graticule.js

@@ -112,11 +112,13 @@ const INTERVALS = [
 
 /**
  * Render a grid for a coordinate system on a map.
- * @constructor
- * @param {module:ol/Graticule~Options=} opt_options Options.
  * @api
  */
 class Graticule {
+
+  /**
+   * @param {module:ol/Graticule~Options=} opt_options Options.
+   */
   constructor(opt_options) {
     const options = opt_options || {};
 

src/ol/Image.js

@@ -29,16 +29,18 @@ import {getHeight} from './extent.js';
 
 
 /**
- * @constructor
  * @extends {module:ol/ImageBase}
- * @param {module:ol/extent~Extent} extent Extent.
- * @param {number|undefined} resolution Resolution.
- * @param {number} pixelRatio Pixel ratio.
- * @param {string} src Image source URI.
- * @param {?string} crossOrigin Cross origin.
- * @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
  */
 class ImageWrapper {
+
+  /**
+   * @param {module:ol/extent~Extent} extent Extent.
+   * @param {number|undefined} resolution Resolution.
+   * @param {number} pixelRatio Pixel ratio.
+   * @param {string} src Image source URI.
+   * @param {?string} crossOrigin Cross origin.
+   * @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
+   */
   constructor(extent, resolution, pixelRatio, src, crossOrigin, imageLoadFunction) {
 
     ImageBase.call(this, extent, resolution, pixelRatio, ImageState.IDLE);
@@ -124,9 +126,9 @@ class ImageWrapper {
       this.changed();
       this.imageListenerKeys_ = [
         listenOnce(this.image_, EventType.ERROR,
-                   this.handleImageError_, this),
+          this.handleImageError_, this),
         listenOnce(this.image_, EventType.LOAD,
-                   this.handleImageLoad_, this)
+          this.handleImageLoad_, this)
       ];
       this.imageLoadFunction_(this, this.src_);
     }

src/ol/ImageBase.js

@@ -6,15 +6,17 @@ import EventTarget from './events/EventTarget.js';
 import EventType from './events/EventType.js';
 
 /**
- * @constructor
  * @abstract
  * @extends {module:ol/events/EventTarget}
- * @param {module:ol/extent~Extent} extent Extent.
- * @param {number|undefined} resolution Resolution.
- * @param {number} pixelRatio Pixel ratio.
- * @param {module:ol/ImageState} state State.
  */
 class ImageBase {
+
+  /**
+   * @param {module:ol/extent~Extent} extent Extent.
+   * @param {number|undefined} resolution Resolution.
+   * @param {number} pixelRatio Pixel ratio.
+   * @param {module:ol/ImageState} state State.
+   */
   constructor(extent, resolution, pixelRatio, state) {
 
     EventTarget.call(this);

src/ol/ImageCanvas.js

@@ -17,16 +17,18 @@ import ImageState from './ImageState.js';
 
 
 /**
- * @constructor
  * @extends {module:ol/ImageBase}
- * @param {module:ol/extent~Extent} extent Extent.
- * @param {number} resolution Resolution.
- * @param {number} pixelRatio Pixel ratio.
- * @param {HTMLCanvasElement} canvas Canvas.
- * @param {module:ol/ImageCanvas~Loader=} opt_loader Optional loader function to
- *     support asynchronous canvas drawing.
  */
 class ImageCanvas {
+
+  /**
+   * @param {module:ol/extent~Extent} extent Extent.
+   * @param {number} resolution Resolution.
+   * @param {number} pixelRatio Pixel ratio.
+   * @param {HTMLCanvasElement} canvas Canvas.
+   * @param {module:ol/ImageCanvas~Loader=} opt_loader Optional loader function to
+   *     support asynchronous canvas drawing.
+   */
   constructor(extent, resolution, pixelRatio, canvas, opt_loader) {
 
     /**

src/ol/ImageTile.js

@@ -15,16 +15,18 @@ import EventType from './events/EventType.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.
- * @param {?string} crossOrigin Cross origin.
- * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
- * @param {module:ol/Tile~Options=} opt_options Tile options.
  */
 class ImageTile {
+
+  /**
+   * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
+   * @param {module:ol/TileState} state State.
+   * @param {string} src Image source URI.
+   * @param {?string} crossOrigin Cross origin.
+   * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
+   * @param {module:ol/Tile~Options=} opt_options Tile options.
+   */
   constructor(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
 
     Tile.call(this, tileCoord, state, opt_options);

src/ol/Kinetic.js

@@ -6,15 +6,16 @@
  * @classdesc
  * Implementation of inertial deceleration for map movement.
  *
- * @constructor
- * @param {number} decay Rate of decay (must be negative).
- * @param {number} minVelocity Minimum velocity (pixels/millisecond).
- * @param {number} delay Delay to consider to calculate the kinetic
- *     initial values (milliseconds).
- * @struct
  * @api
  */
 class Kinetic {
+
+  /**
+   * @param {number} decay Rate of decay (must be negative).
+   * @param {number} minVelocity Minimum velocity (pixels/millisecond).
+   * @param {number} delay Delay to consider to calculate the kinetic
+   *     initial values (milliseconds).
+   */
   constructor(decay, minVelocity, delay) {
 
     /**

src/ol/Map.js

@@ -57,9 +57,7 @@ import CanvasVectorTileLayerRenderer from './renderer/canvas/VectorTileLayer.js'
  * options or added with `addLayer` can be groups, which can contain further
  * groups, and so on.
  *
- * @constructor
  * @extends {module:ol/PluggableMap}
- * @param {module:ol/PluggableMap~MapOptions} options Map options.
  * @fires module:ol/MapBrowserEvent~MapBrowserEvent
  * @fires module:ol/MapEvent~MapEvent
  * @fires module:ol/render/Event~RenderEvent#postcompose
@@ -67,6 +65,10 @@ import CanvasVectorTileLayerRenderer from './renderer/canvas/VectorTileLayer.js'
  * @api
  */
 class Map {
+
+  /**
+   * @param {module:ol/PluggableMap~MapOptions} options Map options.
+   */
   constructor(options) {
     options = assign({}, options);
     if (!options.controls) {

src/ol/MapBrowserEvent.js

@@ -9,15 +9,17 @@ import MapEvent from './MapEvent.js';
  * Events emitted as map browser events are instances of this type.
  * See {@link module:ol/Map~Map} for which events trigger a map browser event.
  *
- * @constructor
  * @extends {module:ol/MapEvent}
- * @param {string} type Event type.
- * @param {module:ol/PluggableMap} map Map.
- * @param {Event} browserEvent Browser event.
- * @param {boolean=} opt_dragging Is the map currently being dragged?
- * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
  */
 class MapBrowserEvent {
+
+  /**
+   * @param {string} type Event type.
+   * @param {module:ol/PluggableMap} map Map.
+   * @param {Event} browserEvent Browser event.
+   * @param {boolean=} opt_dragging Is the map currently being dragged?
+   * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
+   */
   constructor(type, map, browserEvent, opt_dragging, opt_frameState) {
 
     MapEvent.call(this, type, map, opt_frameState);

src/ol/MapBrowserEventHandler.js

@@ -11,14 +11,14 @@ import PointerEventType from './pointer/EventType.js';
 import PointerEventHandler from './pointer/PointerEventHandler.js';
 
 /**
- * @param {module:ol/PluggableMap} map The map with the viewport to
- * listen to events on.
- * @param {number=} moveTolerance The minimal distance the pointer must travel
- * to trigger a move.
- * @constructor
  * @extends {module:ol/events/EventTarget}
  */
 class MapBrowserEventHandler {
+
+  /**
+   * @param {module:ol/PluggableMap} map The map with the viewport to listen to events on.
+   * @param {number=} moveTolerance The minimal distance the pointer must travel to trigger a move.
+   */
   constructor(map, moveTolerance) {
 
     EventTarget.call(this);

src/ol/MapBrowserPointerEvent.js

@@ -5,17 +5,17 @@ import {inherits} from './util.js';
 import MapBrowserEvent from './MapBrowserEvent.js';
 
 /**
- * @constructor
  * @extends {module:ol/MapBrowserEvent}
- * @param {string} type Event type.
- * @param {module:ol/PluggableMap} map Map.
- * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
- * event.
- * @param {boolean=} opt_dragging Is the map currently being dragged?
- * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
  */
 class MapBrowserPointerEvent {
 
+  /**
+   * @param {string} type Event type.
+   * @param {module:ol/PluggableMap} map Map.
+   * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer event.
+   * @param {boolean=} opt_dragging Is the map currently being dragged?
+   * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
+   */
   constructor(type, map, pointerEvent, opt_dragging, opt_frameState) {
 
     MapBrowserEvent.call(this, type, map, pointerEvent.originalEvent, opt_dragging,

src/ol/MapEvent.js

@@ -9,14 +9,15 @@ import Event from './events/Event.js';
  * Events emitted as map events are instances of this type.
  * See {@link module:ol/Map~Map} for which events trigger a map event.
  *
- * @constructor
  * @extends {module:ol/events/Event}
- * @param {string} type Event type.
- * @param {module:ol/PluggableMap} map Map.
- * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
  */
 class MapEvent {
 
+  /**
+   * @param {string} type Event type.
+   * @param {module:ol/PluggableMap} map Map.
+   * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
+   */
   constructor(type, map, opt_frameState) {
 
     Event.call(this, type);

src/ol/Object.js

@@ -10,17 +10,16 @@ import {assign} from './obj.js';
 
 /**
  * @classdesc
- * Events emitted by {@link module:ol/Object~BaseObject} instances are instances of
+ * Events emitted by {@link module:ol/Object~BaseObject} instances are instances of this type.
- * this type.
- *
- * @param {string} type The event type.
- * @param {string} key The property name.
- * @param {*} oldValue The old value for `key`.
  * @extends {module:ol/events/Event}
- * @constructor
  */
 class ObjectEvent {
 
+  /**
+   * @param {string} type The event type.
+   * @param {string} key The property name.
+   * @param {*} oldValue The old value for `key`.
+   */
   constructor(type, key, oldValue) {
     Event.call(this, type);
 
@@ -86,13 +85,15 @@ inherits(ObjectEvent, Event);
  * Properties can be deleted by using the unset method. E.g.
  * object.unset('foo').
  *
- * @constructor
  * @extends {module:ol/Observable}
- * @param {Object.<string, *>=} opt_values An object with key-value pairs.
  * @fires module:ol/Object~ObjectEvent
  * @api
  */
 class BaseObject {
+
+  /**
+   * @param {Object.<string, *>=} opt_values An object with key-value pairs.
+   */
   constructor(opt_values) {
     Observable.call(this);
 

src/ol/Observable.js

@@ -14,10 +14,8 @@ import EventType from './events/EventType.js';
  * and unregistration. A generic `change` event is always available through
  * {@link module:ol/Observable~Observable#changed}.
  *
- * @constructor
  * @extends {module:ol/events/EventTarget}
  * @fires module:ol/events/Event~Event
- * @struct
  * @api
  */
 class Observable {

src/ol/Overlay.js

@@ -93,12 +93,14 @@ const Property = {
  *     popup.setPosition(coordinate);
  *     map.addOverlay(popup);
  *
- * @constructor
  * @extends {module:ol/Object}
- * @param {module:ol/Overlay~Options} options Overlay options.
  * @api
  */
 class Overlay {
+
+  /**
+   * @param {module:ol/Overlay~Options} options Overlay options.
+   */
   constructor(options) {
 
     BaseObject.call(this);

src/ol/PluggableMap.js

@@ -131,9 +131,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js
 
 
 /**
- * @constructor
  * @extends {module:ol/Object}
- * @param {module:ol/PluggableMap~MapOptions} options Map options.
  * @fires module:ol/MapBrowserEvent~MapBrowserEvent
  * @fires module:ol/MapEvent~MapEvent
  * @fires module:ol/render/Event~RenderEvent#postcompose
@@ -141,6 +139,10 @@ import {create as createTransform, apply as applyTransform} from './transform.js
  * @api
  */
 class PluggableMap {
+
+  /**
+   * @param {module:ol/PluggableMap~MapOptions} options Map options.
+   */
   constructor(options) {
 
     BaseObject.call(this);

src/ol/Tile.js

@@ -44,14 +44,16 @@ import EventType from './events/EventType.js';
  * @classdesc
  * Base class for tiles.
  *
- * @constructor
  * @abstract
  * @extends {module:ol/events/EventTarget}
- * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
- * @param {module:ol/TileState} state State.
- * @param {module:ol/Tile~Options=} opt_options Tile options.
  */
 class Tile {
+
+  /**
+   * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
+   * @param {module:ol/TileState} state State.
+   * @param {module:ol/Tile~Options=} opt_options Tile options.
+   */
   constructor(tileCoord, state, opt_options) {
     EventTarget.call(this);
 

src/ol/TileCache.js

@@ -6,12 +6,13 @@ import LRUCache from './structs/LRUCache.js';
 import {fromKey, getKey} from './tilecoord.js';
 
 /**
- * @constructor
  * @extends {module:ol/structs/LRUCache.<module:ol/Tile>}
- * @param {number=} opt_highWaterMark High water mark.
- * @struct
  */
 class TileCache {
+
+  /**
+   * @param {number=} opt_highWaterMark High water mark.
+   */
   constructor(opt_highWaterMark) {
 
     LRUCache.call(this, opt_highWaterMark);

src/ol/TileQueue.js

@@ -14,15 +14,14 @@ import PriorityQueue from './structs/PriorityQueue.js';
 
 
 /**
- * @constructor
  * @extends {module:ol/structs/PriorityQueue.<Array>}
- * @param {module:ol/TileQueue~PriorityFunction} tilePriorityFunction
- *     Tile priority function.
- * @param {function(): ?} tileChangeCallback
- *     Function called on each tile change event.
- * @struct
  */
 class TileQueue {
+
+  /**
+   * @param {module:ol/TileQueue~PriorityFunction} tilePriorityFunction Tile priority function.
+   * @param {function(): ?} tileChangeCallback Function called on each tile change event.
+   */
   constructor(tilePriorityFunction, tileChangeCallback) {
 
     PriorityQueue.call(

src/ol/TileRange.js

@@ -1,18 +1,19 @@
 /**
  * @module ol/TileRange
  */
+
 /**
  * A representation of a contiguous block of tiles.  A tile range is specified
  * by its min/max tile coordinates and is inclusive of coordinates.
- *
- * @constructor
- * @param {number} minX Minimum X.
- * @param {number} maxX Maximum X.
- * @param {number} minY Minimum Y.
- * @param {number} maxY Maximum Y.
- * @struct
  */
 class TileRange {
+
+  /**
+   * @param {number} minX Minimum X.
+   * @param {number} maxX Maximum X.
+   * @param {number} minY Minimum Y.
+   * @param {number} maxY Maximum Y.
+   */
   constructor(minX, maxX, minY, maxY) {
 
     /**

src/ol/VectorImageTile.js

@@ -22,28 +22,30 @@ import {UNDEFINED} from './functions.js';
 
 
 /**
- * @constructor
  * @extends {module:ol/Tile}
- * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
- * @param {module:ol/TileState} state State.
- * @param {number} sourceRevision Source revision.
- * @param {module:ol/format/Feature} format Feature format.
- * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
- * @param {module:ol/tilecoord~TileCoord} urlTileCoord Wrapped tile coordinate for source urls.
- * @param {module:ol/Tile~UrlFunction} tileUrlFunction Tile url function.
- * @param {module:ol/tilegrid/TileGrid} sourceTileGrid Tile grid of the source.
- * @param {module:ol/tilegrid/TileGrid} tileGrid Tile grid of the renderer.
- * @param {Object.<string, module:ol/VectorTile>} sourceTiles Source tiles.
- * @param {number} pixelRatio Pixel ratio.
- * @param {module:ol/proj/Projection} projection Projection.
- * @param {function(new: module:ol/VectorTile, module:ol/tilecoord~TileCoord, module:ol/TileState, string,
- *     module:ol/format/Feature, module:ol/Tile~LoadFunction)} tileClass Class to
- *     instantiate for source tiles.
- * @param {function(this: module:ol/source/VectorTile, module:ol/events/Event)} handleTileChange
- *     Function to call when a source tile's state changes.
- * @param {number} zoom Integer zoom to render the tile for.
  */
 class VectorImageTile {
+
+  /**
+   * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
+   * @param {module:ol/TileState} state State.
+   * @param {number} sourceRevision Source revision.
+   * @param {module:ol/format/Feature} format Feature format.
+   * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
+   * @param {module:ol/tilecoord~TileCoord} urlTileCoord Wrapped tile coordinate for source urls.
+   * @param {module:ol/Tile~UrlFunction} tileUrlFunction Tile url function.
+   * @param {module:ol/tilegrid/TileGrid} sourceTileGrid Tile grid of the source.
+   * @param {module:ol/tilegrid/TileGrid} tileGrid Tile grid of the renderer.
+   * @param {Object.<string, module:ol/VectorTile>} sourceTiles Source tiles.
+   * @param {number} pixelRatio Pixel ratio.
+   * @param {module:ol/proj/Projection} projection Projection.
+   * @param {function(new: module:ol/VectorTile, module:ol/tilecoord~TileCoord, module:ol/TileState, string,
+   *     module:ol/format/Feature, module:ol/Tile~LoadFunction)} tileClass Class to
+   *     instantiate for source tiles.
+   * @param {function(this: module:ol/source/VectorTile, module:ol/events/Event)} handleTileChange
+   *     Function to call when a source tile's state changes.
+   * @param {number} zoom Integer zoom to render the tile for.
+   */
   constructor(
     tileCoord,
     state,

src/ol/VectorTile.js

@@ -19,16 +19,18 @@ const DEFAULT_EXTENT = [0, 0, 4096, 4096];
  */
 
 /**
- * @constructor
  * @extends {module:ol/Tile}
- * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
- * @param {module:ol/TileState} state State.
- * @param {string} src Data source url.
- * @param {module:ol/format/Feature} format Feature format.
- * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
- * @param {module:ol/Tile~Options=} opt_options Tile options.
  */
 class VectorTile {
+
+  /**
+   * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
+   * @param {module:ol/TileState} state State.
+   * @param {string} src Data source url.
+   * @param {module:ol/format/Feature} format Feature format.
+   * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
+   * @param {module:ol/Tile~Options=} opt_options Tile options.
+   */
   constructor(tileCoord, state, src, format, tileLoadFunction, opt_options) {
 
     Tile.call(this, tileCoord, state, opt_options);

src/ol/View.js

@@ -224,12 +224,14 @@ const DEFAULT_MIN_ZOOM = 0;
  * The *center constraint* is determined by the `extent` option. By
  * default the center is not constrained at all.
  *
- * @constructor
  * @extends {module:ol/Object}
- * @param {module:ol/View~ViewOptions=} opt_options View options.
  * @api
  */
 class View {
+
+  /**
+   * @param {module:ol/View~ViewOptions=} opt_options View options.
+   */
   constructor(opt_options) {
     BaseObject.call(this);
 

src/ol/WebGLMap.js

@@ -57,9 +57,7 @@ import WebGLVectorLayerRenderer from './renderer/webgl/VectorLayer.js';
  * {@link module:ol/layer/Base}, so layers entered in the options or added
  * with `addLayer` can be groups, which can contain further groups, and so on.
  *
- * @constructor
  * @extends {module:ol/PluggableMap}
- * @param {module:ol/PluggableMap~MapOptions} options Map options.
  * @fires module:ol/MapBrowserEvent~MapBrowserEvent
  * @fires module:ol/MapEvent~MapEvent
  * @fires module:ol/render/Event~RenderEvent#postcompose
@@ -67,6 +65,10 @@ import WebGLVectorLayerRenderer from './renderer/webgl/VectorLayer.js';
  * @api
  */
 class WebGLMap {
+
+  /**
+   * @param {module:ol/PluggableMap~MapOptions} options Map options.
+   */
   constructor(options) {
     options = assign({}, options);
     if (!options.controls) {

src/ol/proj/Projection.js

@@ -49,222 +49,223 @@ import {METERS_PER_UNIT} from '../proj/Units.js';
  * be added using `proj4.defs()`. After all required projection definitions are
  * added, call the {@link module:ol/proj/proj4~register} function.
  *
- * @constructor
- * @param {module:ol/proj/Projection~Options} options Projection options.
- * @struct
  * @api
  */
 class Projection {
+
+  /**
+   * @param {module:ol/proj/Projection~Options} options Projection options.
+   */
   constructor(options) {
     /**
-    * @private
+     * @private
-    * @type {string}
+     * @type {string}
-    */
+     */
     this.code_ = options.code;
 
     /**
-    * Units of projected coordinates. When set to `TILE_PIXELS`, a
+     * Units of projected coordinates. When set to `TILE_PIXELS`, a
-    * `this.extent_` and `this.worldExtent_` must be configured properly for each
+     * `this.extent_` and `this.worldExtent_` must be configured properly for each
-    * tile.
+     * tile.
-    * @private
+     * @private
-    * @type {module:ol/proj/Units}
+     * @type {module:ol/proj/Units}
-    */
+     */
     this.units_ = /** @type {module:ol/proj/Units} */ (options.units);
 
     /**
-    * Validity extent of the projection in projected coordinates. For projections
+     * Validity extent of the projection in projected coordinates. For projections
-    * with `TILE_PIXELS` units, this is the extent of the tile in
+     * with `TILE_PIXELS` units, this is the extent of the tile in
-    * tile pixel space.
+     * tile pixel space.
-    * @private
+     * @private
-    * @type {module:ol/extent~Extent}
+     * @type {module:ol/extent~Extent}
-    */
+     */
     this.extent_ = options.extent !== undefined ? options.extent : null;
 
     /**
-    * Extent of the world in EPSG:4326. For projections with
+     * Extent of the world in EPSG:4326. For projections with
-    * `TILE_PIXELS` units, this is the extent of the tile in
+     * `TILE_PIXELS` units, this is the extent of the tile in
-    * projected coordinate space.
+     * projected coordinate space.
-    * @private
+     * @private
-    * @type {module:ol/extent~Extent}
+     * @type {module:ol/extent~Extent}
-    */
+     */
     this.worldExtent_ = options.worldExtent !== undefined ?
       options.worldExtent : null;
 
     /**
-    * @private
+     * @private
-    * @type {string}
+     * @type {string}
-    */
+     */
     this.axisOrientation_ = options.axisOrientation !== undefined ?
       options.axisOrientation : 'enu';
 
     /**
-    * @private
+     * @private
-    * @type {boolean}
+     * @type {boolean}
-    */
+     */
     this.global_ = options.global !== undefined ? options.global : false;
 
     /**
-    * @private
+     * @private
-    * @type {boolean}
+     * @type {boolean}
-    */
+     */
     this.canWrapX_ = !!(this.global_ && this.extent_);
 
     /**
-    * @private
+     * @private
-    * @type {function(number, module:ol/coordinate~Coordinate):number|undefined}
+     * @type {function(number, module:ol/coordinate~Coordinate):number|undefined}
-    */
+     */
     this.getPointResolutionFunc_ = options.getPointResolution;
 
     /**
-    * @private
+     * @private
-    * @type {module:ol/tilegrid/TileGrid}
+     * @type {module:ol/tilegrid/TileGrid}
-    */
+     */
     this.defaultTileGrid_ = null;
 
     /**
-    * @private
+     * @private
-    * @type {number|undefined}
+     * @type {number|undefined}
-    */
+     */
     this.metersPerUnit_ = options.metersPerUnit;
   }
 
   /**
-  * @return {boolean} The projection is suitable for wrapping the x-axis
+   * @return {boolean} The projection is suitable for wrapping the x-axis
-  */
+   */
   canWrapX() {
     return this.canWrapX_;
   }
 
   /**
-  * Get the code for this projection, e.g. 'EPSG:4326'.
+   * Get the code for this projection, e.g. 'EPSG:4326'.
-  * @return {string} Code.
+   * @return {string} Code.
-  * @api
+   * @api
-  */
+   */
   getCode() {
     return this.code_;
   }
 
   /**
-  * Get the validity extent for this projection.
+   * Get the validity extent for this projection.
-  * @return {module:ol/extent~Extent} Extent.
+   * @return {module:ol/extent~Extent} Extent.
-  * @api
+   * @api
-  */
+   */
   getExtent() {
     return this.extent_;
   }
 
   /**
-  * Get the units of this projection.
+   * Get the units of this projection.
-  * @return {module:ol/proj/Units} Units.
+   * @return {module:ol/proj/Units} Units.
-  * @api
+   * @api
-  */
+   */
   getUnits() {
     return this.units_;
   }
 
   /**
-  * Get the amount of meters per unit of this projection.  If the projection is
+   * Get the amount of meters per unit of this projection.  If the projection is
-  * not configured with `metersPerUnit` or a units identifier, the return is
+   * not configured with `metersPerUnit` or a units identifier, the return is
-  * `undefined`.
+   * `undefined`.
-  * @return {number|undefined} Meters.
+   * @return {number|undefined} Meters.
-  * @api
+   * @api
-  */
+   */
   getMetersPerUnit() {
     return this.metersPerUnit_ || METERS_PER_UNIT[this.units_];
   }
 
   /**
-  * Get the world extent for this projection.
+   * Get the world extent for this projection.
-  * @return {module:ol/extent~Extent} Extent.
+   * @return {module:ol/extent~Extent} Extent.
-  * @api
+   * @api
-  */
+   */
   getWorldExtent() {
     return this.worldExtent_;
   }
 
   /**
-  * Get the axis orientation of this projection.
+   * Get the axis orientation of this projection.
-  * Example values are:
+   * Example values are:
-  * enu - the default easting, northing, elevation.
+   * enu - the default easting, northing, elevation.
-  * neu - northing, easting, up - useful for "lat/long" geographic coordinates,
+   * neu - northing, easting, up - useful for "lat/long" geographic coordinates,
-  *     or south orientated transverse mercator.
+   *     or south orientated transverse mercator.
-  * wnu - westing, northing, up - some planetary coordinate systems have
+   * wnu - westing, northing, up - some planetary coordinate systems have
-  *     "west positive" coordinate systems
+   *     "west positive" coordinate systems
-  * @return {string} Axis orientation.
+   * @return {string} Axis orientation.
-  * @api
+   * @api
-  */
+   */
   getAxisOrientation() {
     return this.axisOrientation_;
   }
 
   /**
-  * Is this projection a global projection which spans the whole world?
+   * Is this projection a global projection which spans the whole world?
-  * @return {boolean} Whether the projection is global.
+   * @return {boolean} Whether the projection is global.
-  * @api
+   * @api
-  */
+   */
   isGlobal() {
     return this.global_;
   }
 
   /**
- * Set if the projection is a global projection which spans the whole world
+   * Set if the projection is a global projection which spans the whole world
- * @param {boolean} global Whether the projection is global.
+   * @param {boolean} global Whether the projection is global.
- * @api
+   * @api
- */
+   */
   setGlobal(global) {
     this.global_ = global;
     this.canWrapX_ = !!(global && this.extent_);
   }
 
   /**
-  * @return {module:ol/tilegrid/TileGrid} The default tile grid.
+   * @return {module:ol/tilegrid/TileGrid} The default tile grid.
-  */
+   */
   getDefaultTileGrid() {
     return this.defaultTileGrid_;
   }
 
   /**
-  * @param {module:ol/tilegrid/TileGrid} tileGrid The default tile grid.
+   * @param {module:ol/tilegrid/TileGrid} tileGrid The default tile grid.
-  */
+   */
   setDefaultTileGrid(tileGrid) {
     this.defaultTileGrid_ = tileGrid;
   }
 
   /**
-  * Set the validity extent for this projection.
+   * Set the validity extent for this projection.
-  * @param {module:ol/extent~Extent} extent Extent.
+   * @param {module:ol/extent~Extent} extent Extent.
-  * @api
+   * @api
-  */
+   */
   setExtent(extent) {
     this.extent_ = extent;
     this.canWrapX_ = !!(this.global_ && extent);
   }
 
   /**
-  * Set the world extent for this projection.
+   * Set the world extent for this projection.
-  * @param {module:ol/extent~Extent} worldExtent World extent
+   * @param {module:ol/extent~Extent} worldExtent World extent
-  *     [minlon, minlat, maxlon, maxlat].
+   *     [minlon, minlat, maxlon, maxlat].
-  * @api
+   * @api
-  */
+   */
   setWorldExtent(worldExtent) {
     this.worldExtent_ = worldExtent;
   }
 
   /**
-  * Set the getPointResolution function (see {@link module:ol/proj~getPointResolution}
+   * Set the getPointResolution function (see {@link module:ol/proj~getPointResolution}
-  * for this projection.
+   * for this projection.
-  * @param {function(number, module:ol/coordinate~Coordinate):number} func Function
+   * @param {function(number, module:ol/coordinate~Coordinate):number} func Function
-  * @api
+   * @api
-  */
+   */
   setGetPointResolution(func) {
     this.getPointResolutionFunc_ = func;
   }
 
   /**
-  * Get the custom point resolution function for this projection (if set).
+   * Get the custom point resolution function for this projection (if set).
-  * @return {function(number, module:ol/coordinate~Coordinate):number|undefined} The custom point
+   * @return {function(number, module:ol/coordinate~Coordinate):number|undefined} The custom point
-  * resolution function (if set).
+   * resolution function (if set).
-  */
+   */
   getPointResolutionFunc() {
     return this.getPointResolutionFunc_;
   }

src/ol/proj/epsg3857.js

@@ -44,12 +44,13 @@ export const WORLD_EXTENT = [-180, -85, 180, 85];
  * @classdesc
  * Projection object for web/spherical Mercator (EPSG:3857).
  *
- * @constructor
  * @extends {module:ol/proj/Projection}
- * @param {string} code Code.
  */
 class EPSG3857Projection {
 
+  /**
+   * @param {string} code Code.
+   */
   constructor(code) {
     Projection.call(this, {
       code: code,

src/ol/proj/epsg4326.js

@@ -41,11 +41,13 @@ export const METERS_PER_UNIT = Math.PI * RADIUS / 180;
  *
  * @constructor
  * @extends {module:ol/proj/Projection}
- * @param {string} code Code.
- * @param {string=} opt_axisOrientation Axis orientation.
  */
 class EPSG4326Projection {
 
+  /**
+   * @param {string} code Code.
+   * @param {string=} opt_axisOrientation Axis orientation.
+   */
   constructor(code, opt_axisOrientation) {
     Projection.call(this, {
       code: code,

src/ol/render/webgl/circlereplay/defaultshader/Locations.js

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
 
     /**

src/ol/render/webgl/linestringreplay/defaultshader/Locations.js

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
 
     /**

src/ol/render/webgl/polygonreplay/defaultshader/Locations.js

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
 
     /**

src/ol/render/webgl/texturereplay/defaultshader/Locations.js

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
 
     /**

src/ol/renderer/webgl/defaultmapshader/Locations.js

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
 
     /**

src/ol/renderer/webgl/tilelayershader/Locations.js

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
 
     /**

src/ol/webgl/Buffer.js

@@ -12,39 +12,39 @@ const BufferUsage = {
   DYNAMIC_DRAW: DYNAMIC_DRAW
 };
 
-/**
+
- * @constructor
- * @param {Array.<number>=} opt_arr Array.
- * @param {number=} opt_usage Usage.
- * @struct
- */
 class WebGLBuffer {
+
+  /**
+   * @param {Array.<number>=} opt_arr Array.
+   * @param {number=} opt_usage Usage.
+   */
   constructor(opt_arr, opt_usage) {
 
     /**
-    * @private
+     * @private
-    * @type {Array.<number>}
+     * @type {Array.<number>}
-    */
+     */
     this.arr_ = opt_arr !== undefined ? opt_arr : [];
 
     /**
-    * @private
+     * @private
-    * @type {number}
+     * @type {number}
-    */
+     */
     this.usage_ = opt_usage !== undefined ? opt_usage : BufferUsage.STATIC_DRAW;
 
   }
 
   /**
-  * @return {Array.<number>} Array.
+   * @return {Array.<number>} Array.
-  */
+   */
   getArray() {
     return this.arr_;
   }
 
   /**
-  * @return {number} Usage.
+   * @return {number} Usage.
-  */
+   */
   getUsage() {
     return this.usage_;
   }

src/ol/webgl/Context.js

@@ -22,12 +22,14 @@ import ContextEventType from '../webgl/ContextEventType.js';
  * @classdesc
  * A WebGL context for accessing low-level WebGL capabilities.
  *
- * @constructor
  * @extends {module:ol/Disposable}
- * @param {HTMLCanvasElement} canvas Canvas.
- * @param {WebGLRenderingContext} gl GL.
  */
 class WebGLContext {
+
+  /**
+   * @param {HTMLCanvasElement} canvas Canvas.
+   * @param {WebGLRenderingContext} gl GL.
+   */
   constructor(canvas, gl) {
 
     /**

src/ol/webgl/Fragment.js

@@ -6,19 +6,20 @@ import {FRAGMENT_SHADER} from '../webgl.js';
 import WebGLShader from '../webgl/Shader.js';
 
 /**
- * @constructor
  * @extends {module:ol/webgl/Shader}
- * @param {string} source Source.
- * @struct
  */
 class WebGLFragment {
+
+  /**
+   * @param {string} source Source.
+   */
   constructor(source) {
     WebGLShader.call(this, source);
   }
 
   /**
-  * @inheritDoc
+   * @inheritDoc
-  */
+   */
   getType() {
     return FRAGMENT_SHADER;
   }

src/ol/webgl/Shader.js

@@ -4,31 +4,32 @@
 import {FALSE} from '../functions.js';
 
 /**
- * @constructor
  * @abstract
- * @param {string} source Source.
- * @struct
  */
 class WebGLShader {
+
+  /**
+   * @param {string} source Source.
+   */
   constructor(source) {
 
     /**
-    * @private
+     * @private
-    * @type {string}
+     * @type {string}
-    */
+     */
     this.source_ = source;
 
   }
 
   /**
-  * @abstract
+   * @abstract
-  * @return {number} Type.
+   * @return {number} Type.
-  */
+   */
   getType() {}
 
   /**
-  * @return {string} Source.
+   * @return {string} Source.
-  */
+   */
   getSource() {
     return this.source_;
   }

src/ol/webgl/Vertex.js

@@ -6,19 +6,20 @@ import {VERTEX_SHADER} from '../webgl.js';
 import WebGLShader from '../webgl/Shader.js';
 
 /**
- * @constructor
  * @extends {module:ol/webgl/Shader}
- * @param {string} source Source.
- * @struct
  */
 class WebGLVertex {
+
+  /**
+   * @param {string} source Source.
+   */
   constructor(source) {
     WebGLShader.call(this, source);
   }
 
   /**
-  * @inheritDoc
+   * @inheritDoc
-  */
+   */
   getType() {
     return VERTEX_SHADER;
   }

src/ol/webgl/shaderlocations.mustache

@@ -6,14 +6,12 @@
 
 import {DEBUG as DEBUG_WEBGL} from '../../../../webgl.js';
 
-/**
- * @constructor
- * @param {WebGLRenderingContext} gl GL.
- * @param {WebGLProgram} program Program.
- * @struct
- */
 class Locations {
 
+  /**
+   * @param {WebGLRenderingContext} gl GL.
+   * @param {WebGLProgram} program Program.
+   */
   constructor(gl, program) {
   {{#uniforms}}