Merge pull request #7993 from tschaub/module-types

Module types

examples/custom-controls.js

@@ -21,7 +21,7 @@ const app = window.app;
 
 /**
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {Object=} opt_options Control options.
  */
 app.RotateNorthControl = function(opt_options) {

src/ol/control/Attribution.js

@@ -29,7 +29,7 @@ import {visibleAtResolution} from '../layer/Layer.js';
  * @property {string|Element} [collapseLabel='»'] Text label to use
  * for the expanded attributions button.
  * Instead of text, also an element (e.g. a `span` element) can be used.
- * @property {function(ol.MapEvent)} [render] Function called when
+ * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when
  * the control should be re-rendered. This is called in a `requestAnimationFrame`
  * callback.
  */
@@ -43,7 +43,7 @@ import {visibleAtResolution} from '../layer/Layer.js';
  * be changed by using a css selector for `.ol-attribution`.
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/Attribution~Options=} opt_options Attribution options.
  * @api
  */
@@ -208,8 +208,8 @@ Attribution.prototype.getSourceAttributions_ = function(frameState) {
 
 /**
  * Update the attribution element.
- * @param {ol.MapEvent} mapEvent Map event.
- * @this {ol.control.Attribution}
+ * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
+ * @this {module:ol/control/Attribution~Attribution}
  * @api
  */
 export function render(mapEvent) {

src/ol/control/Control.js

@@ -14,7 +14,7 @@ import {listen, unlistenByKey} from '../events.js';
  * @property {Element|undefined} element The element is the control's
  * container element. This only needs to be specified if you're developing
  * a custom control.
- * @property {function(ol.MapEvent)|undefined} render Function called when
+ * @property {function(module:ol/MapEvent~MapEvent)|undefined} render Function called when
  * the control should be re-rendered. This is called in a `requestAnimationFrame`
  * callback.
  * @property {Element|string|undefined} target Specify a target if you want
@@ -33,20 +33,19 @@ import {listen, unlistenByKey} from '../events.js';
  * This is the base class for controls. You can use it for simple custom
  * controls by creating the element with listeners, creating an instance:
  * ```js
- * var myControl = new ol.control.Control({element: myElement});
+ * var myControl = new Control({element: myElement});
  * ```
  * and then adding this to the map.
  *
  * The main advantage of having this as a control rather than a simple separate
  * DOM element is that preventing propagation is handled for you. Controls
- * will also be `ol.Object`s in a `ol.Collection`, so you can use their
- * methods.
+ * will also be objects in a `ol.Collection`, so you can use their methods.
  *
  * You can also extend this base for your own control class. See
  * examples/custom-controls for an example of how to do this.
  *
  * @constructor
- * @extends {ol.Object}
+ * @extends {module:ol/Object~BaseObject}
  * @implements {oli.control.Control}
  * @param {module:ol/control/Control~Options} options Control options.
  * @api
@@ -80,7 +79,7 @@ const Control = function(options) {
   this.listenerKeys = [];
 
   /**
-   * @type {function(ol.MapEvent)}
+   * @type {function(module:ol/MapEvent~MapEvent)}
    */
   this.render = options.render ? options.render : UNDEFINED;
 

src/ol/control/FullScreen.js

@@ -66,7 +66,7 @@ const getChangeType = (function() {
  *
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/FullScreen~Options=} opt_options Options.
  * @api
  */

src/ol/control/MousePosition.js

@@ -26,7 +26,7 @@ const COORDINATE_FORMAT = 'coordinateFormat';
  * @property {string} [className='ol-mouse-position'] CSS class name.
  * @property {module:ol/coordinate~CoordinateFormat} [coordinateFormat] Coordinate format.
  * @property {ol.ProjectionLike} projection Projection.
- * @property {function(ol.MapEvent)} [render] Function called when the
+ * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the
  * control should be re-rendered. This is called in a `requestAnimationFrame`
  * callback.
  * @property {Element|string} [target] Specify a target if you want the
@@ -43,7 +43,7 @@ const COORDINATE_FORMAT = 'coordinateFormat';
  * can be changed by using the css selector `.ol-mouse-position`.
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/MousePosition~Options=} opt_options Mouse position
  *     options.
  * @api
@@ -109,8 +109,8 @@ inherits(MousePosition, Control);
 
 /**
  * Update the mouseposition element.
- * @param {ol.MapEvent} mapEvent Map event.
- * @this {ol.control.MousePosition}
+ * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
+ * @this {module:ol/control/MousePosition~MousePosition}
  * @api
  */
 export function render(mapEvent) {

src/ol/control/OverviewMap.js

@@ -48,7 +48,7 @@ const MIN_RATIO = 0.1;
  * @property {Array.<ol.layer.Layer>|ol.Collection.<ol.layer.Layer>} [layers]
  * Layers for the overview map. If not set, then all main map layers are used
  * instead.
- * @property {function(ol.MapEvent)} [render] Function called when the control
+ * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
  * should be re-rendered. This is called in a `requestAnimationFrame` callback.
  * @property {Element|string} [target] Specify a target if you want the control
  * to be rendered outside of the map's viewport.
@@ -62,7 +62,7 @@ const MIN_RATIO = 0.1;
  * Create a new control with a map acting as an overview map for an other
  * defined map.
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/OverviewMap~Options=} opt_options OverviewMap options.
  * @api
  */
@@ -270,7 +270,7 @@ OverviewMap.prototype.setMap = function(map) {
 
 /**
  * Handle map property changes.  This only deals with changes to the map's view.
- * @param {ol.Object.Event} event The propertychange event.
+ * @param {module:ol/Object~BaseObject.Event} event The propertychange event.
  * @private
  */
 OverviewMap.prototype.handleMapPropertyChange_ = function(event) {
@@ -322,8 +322,8 @@ OverviewMap.prototype.handleRotationChanged_ = function() {
 
 /**
  * Update the overview map element.
- * @param {ol.MapEvent} mapEvent Map event.
- * @this {ol.control.OverviewMap}
+ * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
+ * @this {module:ol/control/OverviewMap~OverviewMap}
  * @api
  */
 export function render(mapEvent) {

src/ol/control/Rotate.js

@@ -18,7 +18,7 @@ import {inherits} from '../index.js';
  * @property {string} [tipLabel='Reset rotation'] Text label to use for the rotate tip.
  * @property {number} [duration=250] Animation duration in milliseconds.
  * @property {boolean} [autoHide=true] Hide the control when rotation is 0.
- * @property {function(ol.MapEvent)} [render] Function called when the control should
+ * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control should
  * be re-rendered. This is called in a `requestAnimationFrame` callback.
  * @property {function()} [resetNorth] Function called when the control is clicked.
  * This will override the default `resetNorth`.
@@ -34,7 +34,7 @@ import {inherits} from '../index.js';
  * selector is added to the button when the rotation is 0.
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/Rotate~Options=} opt_options Rotate options.
  * @api
  */
@@ -153,8 +153,8 @@ Rotate.prototype.resetNorth_ = function() {
 
 /**
  * Update the rotate control element.
- * @param {ol.MapEvent} mapEvent Map event.
- * @this {ol.control.Rotate}
+ * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
+ * @this {module:ol/control/Rotate~Rotate}
  * @api
  */
 export function render(mapEvent) {

src/ol/control/ScaleLine.js

@@ -29,11 +29,11 @@ const LEADING_DIGITS = [1, 2, 5];
  * @typedef {Object} Options
  * @property {string} [className='ol-scale-line'] CSS Class name.
  * @property {number} [minWidth=64] Minimum width in pixels.
- * @property {function(ol.MapEvent)} [render] Function called when the control
+ * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
  * should be re-rendered. This is called in a `requestAnimationFrame` callback.
  * @property {Element|string} [target] Specify a target if you want the control
  * to be rendered outside of the map's viewport.
- * @property {ol.control.ScaleLineUnits|string} [units='metric'] Units.
+ * @property {module:ol/control/ScaleLineUnits~ScaleLineUnits|string} [units='metric'] Units.
  */
 
 
@@ -48,7 +48,7 @@ const LEADING_DIGITS = [1, 2, 5];
  * but this can be changed by using the css selector `.ol-scale-line`.
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/ScaleLine~Options=} opt_options Scale line options.
  * @api
  */
@@ -113,7 +113,7 @@ const ScaleLine = function(opt_options) {
     this, getChangeEventType(UNITS),
     this.handleUnitsChanged_, this);
 
-  this.setUnits(/** @type {ol.control.ScaleLineUnits} */ (options.units) ||
+  this.setUnits(/** @type {module:ol/control/ScaleLineUnits~ScaleLineUnits} */ (options.units) ||
       ScaleLineUnits.METRIC);
 
 };
@@ -123,20 +123,20 @@ inherits(ScaleLine, Control);
 
 /**
  * Return the units to use in the scale line.
- * @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
- *     line.
+ * @return {module:ol/control/ScaleLineUnits~ScaleLineUnits|undefined} The units
+ * to use in the scale line.
  * @observable
  * @api
  */
 ScaleLine.prototype.getUnits = function() {
-  return /** @type {ol.control.ScaleLineUnits|undefined} */ (this.get(UNITS));
+  return /** @type {module:ol/control/ScaleLineUnits~ScaleLineUnits|undefined} */ (this.get(UNITS));
 };
 
 
 /**
  * Update the scale line element.
- * @param {ol.MapEvent} mapEvent Map event.
- * @this {ol.control.ScaleLine}
+ * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
+ * @this {module:ol/control/ScaleLine~ScaleLine}
  * @api
  */
 export function render(mapEvent) {
@@ -160,7 +160,7 @@ ScaleLine.prototype.handleUnitsChanged_ = function() {
 
 /**
  * Set the units to use in the scale line.
- * @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
+ * @param {module:ol/control/ScaleLineUnits~ScaleLineUnits} units The units to use in the scale line.
  * @observable
  * @api
  */

src/ol/control/Zoom.js

@@ -32,7 +32,7 @@ import {easeOut} from '../easing.js';
  * use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/Zoom~Options=} opt_options Zoom options.
  * @api
  */

src/ol/control/ZoomSlider.js

@@ -31,7 +31,7 @@ const Direction = {
  * @property {number} [duration=200] Animation duration in milliseconds.
  * @property {number|undefined} maxResolution Maximum resolution.
  * @property {number|undefined} minResolution Minimum resolution.
- * @property {function(ol.MapEvent)} [render] Function called when the control
+ * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
  * should be re-rendered. This is called in a `requestAnimationFrame` callback.
  */
 
@@ -42,10 +42,10 @@ const Direction = {
  *
  * Example:
  *
- *     map.addControl(new ol.control.ZoomSlider());
+ *     map.addControl(new ZoomSlider());
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/ZoomSlider~Options=} opt_options Zoom slider options.
  * @api
  */
@@ -209,8 +209,8 @@ ZoomSlider.prototype.initSlider_ = function() {
 
 /**
  * Update the zoomslider element.
- * @param {ol.MapEvent} mapEvent Map event.
- * @this {ol.control.ZoomSlider}
+ * @param {module:ol/MapEvent~MapEvent} mapEvent Map event.
+ * @this {module:ol/control/ZoomSlider~ZoomSlider}
  * @api
  */
 export function render(mapEvent) {

src/ol/control/ZoomToExtent.js

@@ -27,7 +27,7 @@ import {CLASS_CONTROL, CLASS_UNSELECTABLE} from '../css.js';
  * extent. To style this control use the css selector `.ol-zoom-extent`.
  *
  * @constructor
- * @extends {ol.control.Control}
+ * @extends {module:ol/control/Control~Control}
  * @param {module:ol/control/ZoomToExtent~Options=} opt_options Options.
  * @api
  */

src/ol/geom/Geometry.js

@@ -21,7 +21,7 @@ import {create as createTransform, compose as composeTransform} from '../transfo
  *
  * @constructor
  * @abstract
- * @extends {ol.Object}
+ * @extends {module:ol/Object~BaseObject}
  * @api
  */
 const Geometry = function() {

src/ol/layer/Base.js

@@ -12,12 +12,12 @@ import {assign} from '../obj.js';
  * Abstract base class; normally only used for creating subclasses and not
  * instantiated in apps.
  * Note that with `ol.layer.Base` and all its subclasses, any property set in
- * the options is set as a {@link ol.Object} property on the layer object, so
+ * the options is set as a {@link module:ol/Object~BaseObject} property on the layer object, so
  * is observable, and has get/set accessors.
  *
  * @constructor
  * @abstract
- * @extends {ol.Object}
+ * @extends {module:ol/Object~BaseObject}
  * @param {olx.layer.BaseOptions} options Layer options.
  * @api
  */

src/ol/layer/Heatmap.js

@@ -34,7 +34,7 @@ const DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00'];
 /**
  * @classdesc
  * Layer for rendering vector data as a heatmap.
- * Note that any property set in the options is set as a {@link ol.Object}
+ * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
  * property on the layer object; for example, setting `title: 'My Title'` in the
  * options means that `title` is observable, and has get/set accessors.
  *

src/ol/layer/Image.js

@@ -9,7 +9,7 @@ import Layer from '../layer/Layer.js';
  * @classdesc
  * Server-rendered images that are available for arbitrary extents and
  * resolutions.
- * Note that any property set in the options is set as a {@link ol.Object}
+ * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
  * property on the layer object; for example, setting `title: 'My Title'` in the
  * options means that `title` is observable, and has get/set accessors.
  *

src/ol/layer/Tile.js

@@ -11,7 +11,7 @@ import {assign} from '../obj.js';
  * @classdesc
  * For layer sources that provide pre-rendered, tiled images in grids that are
  * organized by zoom levels for specific resolutions.
- * Note that any property set in the options is set as a {@link ol.Object}
+ * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
  * property on the layer object; for example, setting `title: 'My Title'` in the
  * options means that `title` is observable, and has get/set accessors.
  *

src/ol/layer/Vector.js

@@ -21,7 +21,7 @@ const Property = {
 /**
  * @classdesc
  * Vector data that is rendered client-side.
- * Note that any property set in the options is set as a {@link ol.Object}
+ * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
  * property on the layer object; for example, setting `title: 'My Title'` in the
  * options means that `title` is observable, and has get/set accessors.
  *

src/ol/layer/VectorTile.js

@@ -12,7 +12,7 @@ import {assign} from '../obj.js';
 /**
  * @classdesc
  * Layer for vector tile data that is rendered client-side.
- * Note that any property set in the options is set as a {@link ol.Object}
+ * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
  * property on the layer object; for example, setting `title: 'My Title'` in the
  * options means that `title` is observable, and has get/set accessors.
  *

src/ol/source/Source.js

@@ -18,7 +18,7 @@ import SourceState from '../source/State.js';
  *
  * @constructor
  * @abstract
- * @extends {ol.Object}
+ * @extends {module:ol/Object~BaseObject}
  * @param {ol.SourceSourceOptions} options Source options.
  * @api
  */