From 0edbfde4d31856626ece1af7499239de36e6a67c Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 18 Mar 2018 09:48:06 -0600 Subject: [PATCH 1/4] Module type for MapEvent --- src/ol/control/Attribution.js | 4 ++-- src/ol/control/Control.js | 4 ++-- src/ol/control/MousePosition.js | 4 ++-- src/ol/control/OverviewMap.js | 4 ++-- src/ol/control/Rotate.js | 4 ++-- src/ol/control/ScaleLine.js | 4 ++-- src/ol/control/ZoomSlider.js | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/ol/control/Attribution.js b/src/ol/control/Attribution.js index b4fb686f3c..fe9d927a27 100644 --- a/src/ol/control/Attribution.js +++ b/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. */ @@ -208,7 +208,7 @@ Attribution.prototype.getSourceAttributions_ = function(frameState) { /** * Update the attribution element. - * @param {ol.MapEvent} mapEvent Map event. + * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. * @this {ol.control.Attribution} * @api */ diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index 489369122b..9a5597a22f 100644 --- a/src/ol/control/Control.js +++ b/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 @@ -80,7 +80,7 @@ const Control = function(options) { this.listenerKeys = []; /** - * @type {function(ol.MapEvent)} + * @type {function(module:ol/MapEvent~MapEvent)} */ this.render = options.render ? options.render : UNDEFINED; diff --git a/src/ol/control/MousePosition.js b/src/ol/control/MousePosition.js index 22f2b884c3..9eabb4ad16 100644 --- a/src/ol/control/MousePosition.js +++ b/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 @@ -109,7 +109,7 @@ inherits(MousePosition, Control); /** * Update the mouseposition element. - * @param {ol.MapEvent} mapEvent Map event. + * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. * @this {ol.control.MousePosition} * @api */ diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index f2914d8eb5..3d0ea760c3 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -48,7 +48,7 @@ const MIN_RATIO = 0.1; * @property {Array.|ol.Collection.} [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. @@ -322,7 +322,7 @@ OverviewMap.prototype.handleRotationChanged_ = function() { /** * Update the overview map element. - * @param {ol.MapEvent} mapEvent Map event. + * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. * @this {ol.control.OverviewMap} * @api */ diff --git a/src/ol/control/Rotate.js b/src/ol/control/Rotate.js index 6c3d7f1cd3..b7bae0e3bd 100644 --- a/src/ol/control/Rotate.js +++ b/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`. @@ -153,7 +153,7 @@ Rotate.prototype.resetNorth_ = function() { /** * Update the rotate control element. - * @param {ol.MapEvent} mapEvent Map event. + * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. * @this {ol.control.Rotate} * @api */ diff --git a/src/ol/control/ScaleLine.js b/src/ol/control/ScaleLine.js index d3b6b2fb42..cfed578da4 100644 --- a/src/ol/control/ScaleLine.js +++ b/src/ol/control/ScaleLine.js @@ -29,7 +29,7 @@ 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. @@ -135,7 +135,7 @@ ScaleLine.prototype.getUnits = function() { /** * Update the scale line element. - * @param {ol.MapEvent} mapEvent Map event. + * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. * @this {ol.control.ScaleLine} * @api */ diff --git a/src/ol/control/ZoomSlider.js b/src/ol/control/ZoomSlider.js index 8717cc22d8..657e6e654b 100644 --- a/src/ol/control/ZoomSlider.js +++ b/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. */ @@ -209,7 +209,7 @@ ZoomSlider.prototype.initSlider_ = function() { /** * Update the zoomslider element. - * @param {ol.MapEvent} mapEvent Map event. + * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. * @this {ol.control.ZoomSlider} * @api */ From 414792f707dc2d4129e930cd8ddcc9f9f63878f2 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 18 Mar 2018 09:50:48 -0600 Subject: [PATCH 2/4] Module type for BaseObject --- src/ol/control/Control.js | 4 ++-- src/ol/control/OverviewMap.js | 2 +- src/ol/geom/Geometry.js | 2 +- src/ol/layer/Base.js | 4 ++-- src/ol/layer/Heatmap.js | 2 +- src/ol/layer/Image.js | 2 +- src/ol/layer/Tile.js | 2 +- src/ol/layer/Vector.js | 2 +- src/ol/layer/VectorTile.js | 2 +- src/ol/source/Source.js | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index 9a5597a22f..2d7d5926a6 100644 --- a/src/ol/control/Control.js +++ b/src/ol/control/Control.js @@ -39,14 +39,14 @@ import {listen, unlistenByKey} from '../events.js'; * * 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 + * will also be `module:ol/Object~BaseObject`s 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 diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index 3d0ea760c3..ac9eaae772 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -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) { diff --git a/src/ol/geom/Geometry.js b/src/ol/geom/Geometry.js index cdcb3f0b02..d7027d8acf 100644 --- a/src/ol/geom/Geometry.js +++ b/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() { diff --git a/src/ol/layer/Base.js b/src/ol/layer/Base.js index 7f1ef3f412..c2593eaf90 100644 --- a/src/ol/layer/Base.js +++ b/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 */ diff --git a/src/ol/layer/Heatmap.js b/src/ol/layer/Heatmap.js index ec8474503e..17e2a48dd2 100644 --- a/src/ol/layer/Heatmap.js +++ b/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. * diff --git a/src/ol/layer/Image.js b/src/ol/layer/Image.js index 782a5c3639..ae762793ff 100644 --- a/src/ol/layer/Image.js +++ b/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. * diff --git a/src/ol/layer/Tile.js b/src/ol/layer/Tile.js index f0e0d11f66..0ca438faf2 100644 --- a/src/ol/layer/Tile.js +++ b/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. * diff --git a/src/ol/layer/Vector.js b/src/ol/layer/Vector.js index bd7a66de7e..842303e128 100644 --- a/src/ol/layer/Vector.js +++ b/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. * diff --git a/src/ol/layer/VectorTile.js b/src/ol/layer/VectorTile.js index 9cf9d95f09..91cec5a911 100644 --- a/src/ol/layer/VectorTile.js +++ b/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. * diff --git a/src/ol/source/Source.js b/src/ol/source/Source.js index 43e07bb0ea..d644c0f11d 100644 --- a/src/ol/source/Source.js +++ b/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 */ From 2e0fd1c12d9cc7a08d502532120f4c4f810957ec Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 18 Mar 2018 09:53:35 -0600 Subject: [PATCH 3/4] Module type for Control --- src/ol/control/Attribution.js | 2 +- src/ol/control/Control.js | 2 +- src/ol/control/FullScreen.js | 2 +- src/ol/control/MousePosition.js | 2 +- src/ol/control/OverviewMap.js | 2 +- src/ol/control/Rotate.js | 2 +- src/ol/control/ScaleLine.js | 2 +- src/ol/control/Zoom.js | 2 +- src/ol/control/ZoomSlider.js | 2 +- src/ol/control/ZoomToExtent.js | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/ol/control/Attribution.js b/src/ol/control/Attribution.js index fe9d927a27..e6626dc467 100644 --- a/src/ol/control/Attribution.js +++ b/src/ol/control/Attribution.js @@ -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 */ diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index 2d7d5926a6..b762345f78 100644 --- a/src/ol/control/Control.js +++ b/src/ol/control/Control.js @@ -33,7 +33,7 @@ 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 module:ol/control/Control~Control({element: myElement}); * ``` * and then adding this to the map. * diff --git a/src/ol/control/FullScreen.js b/src/ol/control/FullScreen.js index b138abc152..0fd100fa98 100644 --- a/src/ol/control/FullScreen.js +++ b/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 */ diff --git a/src/ol/control/MousePosition.js b/src/ol/control/MousePosition.js index 9eabb4ad16..28f576c543 100644 --- a/src/ol/control/MousePosition.js +++ b/src/ol/control/MousePosition.js @@ -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 diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index ac9eaae772..a2ad83d392 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -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 */ diff --git a/src/ol/control/Rotate.js b/src/ol/control/Rotate.js index b7bae0e3bd..3c05ed8b82 100644 --- a/src/ol/control/Rotate.js +++ b/src/ol/control/Rotate.js @@ -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 */ diff --git a/src/ol/control/ScaleLine.js b/src/ol/control/ScaleLine.js index cfed578da4..bf3813fc04 100644 --- a/src/ol/control/ScaleLine.js +++ b/src/ol/control/ScaleLine.js @@ -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 */ diff --git a/src/ol/control/Zoom.js b/src/ol/control/Zoom.js index 2f5dac07fe..271e92ca1e 100644 --- a/src/ol/control/Zoom.js +++ b/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 */ diff --git a/src/ol/control/ZoomSlider.js b/src/ol/control/ZoomSlider.js index 657e6e654b..d7cb9da3af 100644 --- a/src/ol/control/ZoomSlider.js +++ b/src/ol/control/ZoomSlider.js @@ -45,7 +45,7 @@ const Direction = { * map.addControl(new ol.control.ZoomSlider()); * * @constructor - * @extends {ol.control.Control} + * @extends {module:ol/control/Control~Control} * @param {module:ol/control/ZoomSlider~Options=} opt_options Zoom slider options. * @api */ diff --git a/src/ol/control/ZoomToExtent.js b/src/ol/control/ZoomToExtent.js index a3ecb403d6..5656807f66 100644 --- a/src/ol/control/ZoomToExtent.js +++ b/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 */ From a3ead88c57b3c0f6620f720bcb18f9a53d467685 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Sun, 18 Mar 2018 10:23:01 -0600 Subject: [PATCH 4/4] Module types for controls --- examples/custom-controls.js | 2 +- src/ol/control/Attribution.js | 2 +- src/ol/control/Control.js | 5 ++--- src/ol/control/MousePosition.js | 2 +- src/ol/control/OverviewMap.js | 2 +- src/ol/control/Rotate.js | 2 +- src/ol/control/ScaleLine.js | 14 +++++++------- src/ol/control/ZoomSlider.js | 4 ++-- 8 files changed, 16 insertions(+), 17 deletions(-) diff --git a/examples/custom-controls.js b/examples/custom-controls.js index 7d94e1b046..2516619362 100644 --- a/examples/custom-controls.js +++ b/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) { diff --git a/src/ol/control/Attribution.js b/src/ol/control/Attribution.js index e6626dc467..cf2932a81f 100644 --- a/src/ol/control/Attribution.js +++ b/src/ol/control/Attribution.js @@ -209,7 +209,7 @@ Attribution.prototype.getSourceAttributions_ = function(frameState) { /** * Update the attribution element. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {ol.control.Attribution} + * @this {module:ol/control/Attribution~Attribution} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index b762345f78..7832bfd562 100644 --- a/src/ol/control/Control.js +++ b/src/ol/control/Control.js @@ -33,14 +33,13 @@ 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 module:ol/control/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 `module:ol/Object~BaseObject`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. diff --git a/src/ol/control/MousePosition.js b/src/ol/control/MousePosition.js index 28f576c543..20c9c48b84 100644 --- a/src/ol/control/MousePosition.js +++ b/src/ol/control/MousePosition.js @@ -110,7 +110,7 @@ inherits(MousePosition, Control); /** * Update the mouseposition element. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {ol.control.MousePosition} + * @this {module:ol/control/MousePosition~MousePosition} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index a2ad83d392..9f99531d00 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -323,7 +323,7 @@ OverviewMap.prototype.handleRotationChanged_ = function() { /** * Update the overview map element. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {ol.control.OverviewMap} + * @this {module:ol/control/OverviewMap~OverviewMap} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/Rotate.js b/src/ol/control/Rotate.js index 3c05ed8b82..f4cd00cf89 100644 --- a/src/ol/control/Rotate.js +++ b/src/ol/control/Rotate.js @@ -154,7 +154,7 @@ Rotate.prototype.resetNorth_ = function() { /** * Update the rotate control element. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {ol.control.Rotate} + * @this {module:ol/control/Rotate~Rotate} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/ScaleLine.js b/src/ol/control/ScaleLine.js index bf3813fc04..f4993f30a3 100644 --- a/src/ol/control/ScaleLine.js +++ b/src/ol/control/ScaleLine.js @@ -33,7 +33,7 @@ const LEADING_DIGITS = [1, 2, 5]; * 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. */ @@ -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 {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {ol.control.ScaleLine} + * @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 */ diff --git a/src/ol/control/ZoomSlider.js b/src/ol/control/ZoomSlider.js index d7cb9da3af..a2e2fdef25 100644 --- a/src/ol/control/ZoomSlider.js +++ b/src/ol/control/ZoomSlider.js @@ -42,7 +42,7 @@ const Direction = { * * Example: * - * map.addControl(new ol.control.ZoomSlider()); + * map.addControl(new ZoomSlider()); * * @constructor * @extends {module:ol/control/Control~Control} @@ -210,7 +210,7 @@ ZoomSlider.prototype.initSlider_ = function() { /** * Update the zoomslider element. * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {ol.control.ZoomSlider} + * @this {module:ol/control/ZoomSlider~ZoomSlider} * @api */ export function render(mapEvent) {