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