diff --git a/src/ol/Collection.js b/src/ol/Collection.js index 925378b5d9..9c1e9c8937 100644 --- a/src/ol/Collection.js +++ b/src/ol/Collection.js @@ -23,7 +23,7 @@ const Property = { * type. * * @constructor - * @extends {module:ol/events/Event~Event} + * @extends {module:ol/events/Event} * @implements {oli.CollectionEvent} * @param {module:ol/CollectionEventType} type Type. * @param {*=} opt_element Element. @@ -59,7 +59,7 @@ inherits(CollectionEvent, Event); * Collection as a whole. * * @constructor - * @extends {module:ol/Object~BaseObject} + * @extends {module:ol/Object} * @fires module:ol/Collection~CollectionEvent * @param {Array.=} opt_array Array. * @param {module:ol/Collection~Options=} opt_options Collection options. @@ -112,7 +112,7 @@ Collection.prototype.clear = function() { * Add elements to the collection. This pushes each item in the provided array * to the end of the collection. * @param {!Array.} arr Array. - * @return {module:ol/Collection~Collection.} This collection. + * @return {module:ol/Collection.} This collection. * @api */ Collection.prototype.extend = function(arr) { diff --git a/src/ol/Feature.js b/src/ol/Feature.js index c7f7d46151..8b3e7aa5b7 100644 --- a/src/ol/Feature.js +++ b/src/ol/Feature.js @@ -18,7 +18,7 @@ import Style from './style/Style.js'; * Features can be styled individually with `setStyle`; otherwise they use the * style of their vector layer. * - * Note that attribute properties are set as {@link module:ol/Object~BaseObject} properties on + * Note that attribute properties are set as {@link module:ol/Object} properties on * the feature object, so they are observable, and have get/set accessors. * * Typically, a feature has a single geometry property. You can set the @@ -52,8 +52,8 @@ import Style from './style/Style.js'; * ``` * * @constructor - * @extends {module:ol/Object~BaseObject} - * @param {module:ol/geom/Geometry~Geometry|Object.=} opt_geometryOrProperties + * @extends {module:ol/Object} + * @param {module:ol/geom/Geometry|Object.=} 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. @@ -78,7 +78,7 @@ const Feature = function(opt_geometryOrProperties) { /** * User provided style. * @private - * @type {module:ol/style/Style~Style|Array.|module:ol/style~StyleFunction} + * @type {module:ol/style/Style|Array.|module:ol/style~StyleFunction} */ this.style_ = null; @@ -117,7 +117,7 @@ inherits(Feature, BaseObject); /** * Clone this feature. If the original feature has a geometry it * is also cloned. The feature id is not set in the clone. - * @return {module:ol/Feature~Feature} The clone. + * @return {module:ol/Feature} The clone. * @api */ Feature.prototype.clone = function() { @@ -139,13 +139,14 @@ Feature.prototype.clone = function() { * Get the feature's default geometry. A feature may have any number of named * geometries. The "default" geometry (the one that is rendered by default) is * set when calling {@link module:ol/Feature~Feature#setGeometry}. - * @return {module:ol/geom/Geometry~Geometry|undefined} The default geometry for the feature. + * @return {module:ol/geom/Geometry|undefined} The default geometry for the feature. * @api * @observable */ Feature.prototype.getGeometry = function() { - return /** @type {module:ol/geom/Geometry~Geometry|undefined} */ ( - this.get(this.geometryName_)); + return ( + /** @type {module:ol/geom/Geometry|undefined} */ (this.get(this.geometryName_)) + ); }; @@ -176,7 +177,7 @@ Feature.prototype.getGeometryName = function() { /** * Get the feature's style. Will return what was provided to the * {@link module:ol/Feature~Feature#setStyle} method. - * @return {module:ol/style/Style~Style|Array.|module:ol/style~StyleFunction} The feature style. + * @return {module:ol/style/Style|Array.|module:ol/style~StyleFunction} The feature style. * @api */ Feature.prototype.getStyle = function() { @@ -223,7 +224,7 @@ Feature.prototype.handleGeometryChanged_ = function() { /** * Set the default geometry for the feature. This will update the property * with the name returned by {@link module:ol/Feature~Feature#getGeometryName}. - * @param {module:ol/geom/Geometry~Geometry|undefined} geometry The new geometry. + * @param {module:ol/geom/Geometry|undefined} geometry The new geometry. * @api * @observable */ @@ -236,7 +237,7 @@ Feature.prototype.setGeometry = function(geometry) { * Set the style for the feature. This can be a single style object, an array * of styles, or a function that takes a resolution and returns an array of * styles. If it is `null` the feature has no style (a `null` style). - * @param {module:ol/style/Style~Style|Array.|module:ol/style~StyleFunction} style Style for this feature. + * @param {module:ol/style/Style|Array.|module:ol/style~StyleFunction} style Style for this feature. * @api * @fires module:ol/events/Event~Event#event:change */ @@ -283,9 +284,9 @@ Feature.prototype.setGeometryName = function(name) { /** * Convert the provided object into a feature style function. Functions passed - * through unchanged. Arrays of module:ol/style/Style~Style or single style objects wrapped + * through unchanged. Arrays of module:ol/style/Style or single style objects wrapped * in a new feature style function. - * @param {module:ol/style~StyleFunction|!Array.|!module:ol/style/Style~Style} obj + * @param {module:ol/style~StyleFunction|!Array.|!module:ol/style/Style} obj * A feature style function, a single style, or an array of styles. * @return {module:ol/style~StyleFunction} A style function. */ @@ -294,7 +295,7 @@ export function createStyleFunction(obj) { return obj; } else { /** - * @type {Array.} + * @type {Array.} */ let styles; if (Array.isArray(obj)) { diff --git a/src/ol/Geolocation.js b/src/ol/Geolocation.js index 52e387060e..d622914290 100644 --- a/src/ol/Geolocation.js +++ b/src/ol/Geolocation.js @@ -45,7 +45,7 @@ import {get as getProjection, getTransformFromProjections, identityTransform} fr * * @fires error * @constructor - * @extends {module:ol/Object~BaseObject} + * @extends {module:ol/Object} * @param {module:ol/Geolocation~Options=} opt_options Options. * @api */ @@ -199,12 +199,14 @@ Geolocation.prototype.getAccuracy = function() { /** * Get a geometry of the position accuracy. - * @return {?module:ol/geom/Polygon~Polygon} A geometry of the position accuracy. + * @return {?module:ol/geom/Polygon} A geometry of the position accuracy. * @observable * @api */ Geolocation.prototype.getAccuracyGeometry = function() { - return /** @type {?module:ol/geom/Polygon~Polygon} */ (this.get(GeolocationProperty.ACCURACY_GEOMETRY) || null); + return ( + /** @type {?module:ol/geom/Polygon} */ (this.get(GeolocationProperty.ACCURACY_GEOMETRY) || null) + ); }; @@ -253,19 +255,23 @@ Geolocation.prototype.getHeading = function() { * @api */ Geolocation.prototype.getPosition = function() { - return /** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(GeolocationProperty.POSITION)); + return ( + /** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(GeolocationProperty.POSITION)) + ); }; /** * Get the projection associated with the position. - * @return {module:ol/proj/Projection~Projection|undefined} The projection the position is + * @return {module:ol/proj/Projection|undefined} The projection the position is * reported in. * @observable * @api */ Geolocation.prototype.getProjection = function() { - return /** @type {module:ol/proj/Projection~Projection|undefined} */ (this.get(GeolocationProperty.PROJECTION)); + return ( + /** @type {module:ol/proj/Projection|undefined} */ (this.get(GeolocationProperty.PROJECTION)) + ); }; diff --git a/src/ol/Graticule.js b/src/ol/Graticule.js index 45ee3d5049..2005938013 100644 --- a/src/ol/Graticule.js +++ b/src/ol/Graticule.js @@ -17,7 +17,7 @@ import Text from './style/Text.js'; /** - * @type {module:ol/style/Stroke~Stroke} + * @type {module:ol/style/Stroke} * @private * @const */ @@ -36,13 +36,13 @@ const INTERVALS = [ /** * @typedef {Object} GraticuleLabelDataType - * @property {module:ol/geom/Point~Point} geom + * @property {module:ol/geom/Point} geom * @property {string} text */ /** * @typedef {Object} Options - * @property {module:ol/PluggableMap~PluggableMap} [map] Reference to an + * @property {module:ol/PluggableMap} [map] Reference to an * {@link module:ol/Map~Map} object. * @property {number} [maxLines=100] The maximum number of meridians and * parallels from the center of the map. The default value of 100 means that at @@ -50,7 +50,7 @@ const INTERVALS = [ * appropriate for conformal projections like Spherical Mercator. If you * increase the value, more lines will be drawn and the drawing performance will * decrease. - * @property {module:ol/style/Stroke~Stroke} [strokeStyle='rgba(0,0,0,0.2)'] The + * @property {module:ol/style/Stroke} [strokeStyle='rgba(0,0,0,0.2)'] The * stroke style to use for drawing the graticule. If not provided, a not fully * opaque black will be used. * @property {number} [targetSize=100] The target size of the graticule cells, @@ -67,7 +67,7 @@ const INTERVALS = [ * @property {number} [latLabelPosition=1] Latitude label position in fractions * (0..1) of view extent. 0 means at the left of the viewport, 1 means at the * right. - * @property {module:ol/style/Text~Text} [lonLabelStyle] Longitude label text + * @property {module:ol/style/Text} [lonLabelStyle] Longitude label text * style. If not provided, the following style will be used: * ```js * new Text({ @@ -85,7 +85,7 @@ const INTERVALS = [ * Note that the default's `textBaseline` configuration will not work well for * `lonLabelPosition` configurations that position labels close to the top of * the viewport. - * @param {module:ol/style/Text~Text} [latLabelStyle] Latitude label text style. + * @param {module:ol/style/Text} [latLabelStyle] Latitude label text style. * If not provided, the following style will be used: * ```js * new Text({ @@ -116,7 +116,7 @@ const Graticule = function(opt_options) { const options = opt_options || {}; /** - * @type {module:ol/PluggableMap~PluggableMap} + * @type {module:ol/PluggableMap} * @private */ this.map_ = null; @@ -128,7 +128,7 @@ const Graticule = function(opt_options) { this.postcomposeListenerKey_ = null; /** - * @type {module:ol/proj/Projection~Projection} + * @type {module:ol/proj/Projection} */ this.projection_ = null; @@ -193,19 +193,19 @@ const Graticule = function(opt_options) { this.maxLines_ = options.maxLines !== undefined ? options.maxLines : 100; /** - * @type {Array.} + * @type {Array.} * @private */ this.meridians_ = []; /** - * @type {Array.} + * @type {Array.} * @private */ this.parallels_ = []; /** - * @type {module:ol/style/Stroke~Stroke} + * @type {module:ol/style/Stroke} * @private */ this.strokeStyle_ = options.strokeStyle !== undefined ? options.strokeStyle : DEFAULT_STROKE_STYLE; @@ -276,7 +276,7 @@ const Graticule = function(opt_options) { options.latLabelPosition; /** - * @type {module:ol/style/Text~Text} + * @type {module:ol/style/Text} * @private */ this.lonLabelStyle_ = options.lonLabelStyle !== undefined ? options.lonLabelStyle : @@ -293,7 +293,7 @@ const Graticule = function(opt_options) { }); /** - * @type {module:ol/style/Text~Text} + * @type {module:ol/style/Text} * @private */ this.latLabelStyle_ = options.latLabelStyle !== undefined ? options.latLabelStyle : @@ -343,10 +343,10 @@ Graticule.prototype.addMeridian_ = function(lon, minLat, maxLat, squaredToleranc }; /** - * @param {module:ol/geom/LineString~LineString} lineString Meridian + * @param {module:ol/geom/LineString} lineString Meridian * @param {module:ol/extent~Extent} extent Extent. * @param {number} index Index. - * @return {module:ol/geom/Point~Point} Meridian point. + * @return {module:ol/geom/Point} Meridian point. * @private */ Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) { @@ -391,10 +391,10 @@ Graticule.prototype.addParallel_ = function(lat, minLon, maxLon, squaredToleranc /** - * @param {module:ol/geom/LineString~LineString} lineString Parallels. + * @param {module:ol/geom/LineString} lineString Parallels. * @param {module:ol/extent~Extent} extent Extent. * @param {number} index Index. - * @return {module:ol/geom/Point~Point} Parallel point. + * @return {module:ol/geom/Point} Parallel point. * @private */ Graticule.prototype.getParallelPoint_ = function(lineString, extent, index) { @@ -542,7 +542,7 @@ Graticule.prototype.getInterval_ = function(resolution) { /** * Get the map associated with this graticule. - * @return {module:ol/PluggableMap~PluggableMap} The map. + * @return {module:ol/PluggableMap} The map. * @api */ Graticule.prototype.getMap = function() { @@ -555,7 +555,7 @@ Graticule.prototype.getMap = function() { * @param {number} minLat Minimal latitude. * @param {number} maxLat Maximal latitude. * @param {number} squaredTolerance Squared tolerance. - * @return {module:ol/geom/LineString~LineString} The meridian line string. + * @return {module:ol/geom/LineString} The meridian line string. * @param {number} index Index. * @private */ @@ -569,7 +569,7 @@ Graticule.prototype.getMeridian_ = function(lon, minLat, maxLat, squaredToleranc /** * Get the list of meridians. Meridians are lines of equal longitude. - * @return {Array.} The meridians. + * @return {Array.} The meridians. * @api */ Graticule.prototype.getMeridians = function() { @@ -582,7 +582,7 @@ Graticule.prototype.getMeridians = function() { * @param {number} minLon Minimal longitude. * @param {number} maxLon Maximal longitude. * @param {number} squaredTolerance Squared tolerance. - * @return {module:ol/geom/LineString~LineString} The parallel line string. + * @return {module:ol/geom/LineString} The parallel line string. * @param {number} index Index. * @private */ @@ -596,7 +596,7 @@ Graticule.prototype.getParallel_ = function(lat, minLon, maxLon, squaredToleranc /** * Get the list of parallels. Parallels are lines of equal latitude. - * @return {Array.} The parallels. + * @return {Array.} The parallels. * @api */ Graticule.prototype.getParallels = function() { @@ -605,7 +605,7 @@ Graticule.prototype.getParallels = function() { /** - * @param {module:ol/render/Event~RenderEvent} e Event. + * @param {module:ol/render/Event} e Event. * @private */ Graticule.prototype.handlePostCompose_ = function(e) { @@ -661,7 +661,7 @@ Graticule.prototype.handlePostCompose_ = function(e) { /** - * @param {module:ol/proj/Projection~Projection} projection Projection. + * @param {module:ol/proj/Projection} projection Projection. * @private */ Graticule.prototype.updateProjectionInfo_ = function(projection) { @@ -705,7 +705,7 @@ Graticule.prototype.updateProjectionInfo_ = function(projection) { /** * Set the map for this graticule. The graticule will be rendered on the * provided map. - * @param {module:ol/PluggableMap~PluggableMap} map Map. + * @param {module:ol/PluggableMap} map Map. * @api */ Graticule.prototype.setMap = function(map) { diff --git a/src/ol/Image.js b/src/ol/Image.js index d55426a6cd..f887728bba 100644 --- a/src/ol/Image.js +++ b/src/ol/Image.js @@ -30,7 +30,7 @@ import {getHeight} from './extent.js'; /** * @constructor - * @extends {module:ol/ImageBase~ImageBase} + * @extends {module:ol/ImageBase} * @param {module:ol/extent~Extent} extent Extent. * @param {number|undefined} resolution Resolution. * @param {number} pixelRatio Pixel ratio. diff --git a/src/ol/ImageBase.js b/src/ol/ImageBase.js index 272f9f879b..530c1c5ac1 100644 --- a/src/ol/ImageBase.js +++ b/src/ol/ImageBase.js @@ -8,7 +8,7 @@ import EventType from './events/EventType.js'; /** * @constructor * @abstract - * @extends {module:ol/events/EventTarget~EventTarget} + * @extends {module:ol/events/EventTarget} * @param {module:ol/extent~Extent} extent Extent. * @param {number|undefined} resolution Resolution. * @param {number} pixelRatio Pixel ratio. diff --git a/src/ol/ImageCanvas.js b/src/ol/ImageCanvas.js index a975d3640d..c848a55077 100644 --- a/src/ol/ImageCanvas.js +++ b/src/ol/ImageCanvas.js @@ -18,7 +18,7 @@ import ImageState from './ImageState.js'; /** * @constructor - * @extends {module:ol/ImageBase~ImageBase} + * @extends {module:ol/ImageBase} * @param {module:ol/extent~Extent} extent Extent. * @param {number} resolution Resolution. * @param {number} pixelRatio Pixel ratio. diff --git a/src/ol/ImageTile.js b/src/ol/ImageTile.js index 02eb67d475..aa7557f356 100644 --- a/src/ol/ImageTile.js +++ b/src/ol/ImageTile.js @@ -9,14 +9,14 @@ import {listenOnce, unlistenByKey} from './events.js'; import EventType from './events/EventType.js'; /** - * @typedef {function(new: module:ol/ImageTile~ImageTile, module:ol/tilecoord~TileCoord, + * @typedef {function(new: module:ol/ImageTile, module:ol/tilecoord~TileCoord, * module:ol/TileState, string, ?string, module:ol/Tile~LoadFunction)} TileClass * @api */ /** * @constructor - * @extends {module:ol/Tile~Tile} + * @extends {module:ol/Tile} * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate. * @param {module:ol/TileState} state State. * @param {string} src Image source URI. diff --git a/src/ol/Map.js b/src/ol/Map.js index 4635894e78..d712949e3a 100644 --- a/src/ol/Map.js +++ b/src/ol/Map.js @@ -58,7 +58,7 @@ import CanvasVectorTileLayerRenderer from './renderer/canvas/VectorTileLayer.js' * groups, and so on. * * @constructor - * @extends {module:ol/PluggableMap~PluggableMap} + * @extends {module:ol/PluggableMap} * @param {module:ol/PluggableMap~MapOptions} options Map options. * @fires module:ol/MapBrowserEvent~MapBrowserEvent * @fires module:ol/MapEvent~MapEvent diff --git a/src/ol/MapBrowserEvent.js b/src/ol/MapBrowserEvent.js index b5cbcf9903..a17fd9b3da 100644 --- a/src/ol/MapBrowserEvent.js +++ b/src/ol/MapBrowserEvent.js @@ -10,10 +10,10 @@ import MapEvent from './MapEvent.js'; * See {@link module:ol/Map~Map} for which events trigger a map browser event. * * @constructor - * @extends {module:ol/MapEvent~MapEvent} + * @extends {module:ol/MapEvent} * @implements {oli.MapBrowserEvent} * @param {string} type Event type. - * @param {module:ol/PluggableMap~PluggableMap} map Map. + * @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. diff --git a/src/ol/MapBrowserEventHandler.js b/src/ol/MapBrowserEventHandler.js index 289c01afb0..e5af062b39 100644 --- a/src/ol/MapBrowserEventHandler.js +++ b/src/ol/MapBrowserEventHandler.js @@ -11,12 +11,12 @@ import PointerEventType from './pointer/EventType.js'; import PointerEventHandler from './pointer/PointerEventHandler.js'; /** - * @param {module:ol/PluggableMap~PluggableMap} map The map with the viewport to + * @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~EventTarget} + * @extends {module:ol/events/EventTarget} */ const MapBrowserEventHandler = function(map, moveTolerance) { @@ -24,7 +24,7 @@ const MapBrowserEventHandler = function(map, moveTolerance) { /** * This is the element that we will listen to the real events on. - * @type {module:ol/PluggableMap~PluggableMap} + * @type {module:ol/PluggableMap} * @private */ this.map_ = map; @@ -57,7 +57,7 @@ const MapBrowserEventHandler = function(map, moveTolerance) { /** * The most recent "down" type event (or null if none have occurred). * Set on pointerdown. - * @type {module:ol/pointer/PointerEvent~PointerEvent} + * @type {module:ol/pointer/PointerEvent} * @private */ this.down_ = null; @@ -80,7 +80,7 @@ const MapBrowserEventHandler = function(map, moveTolerance) { * Event handler which generates pointer events for * the viewport element. * - * @type {module:ol/pointer/PointerEventHandler~PointerEventHandler} + * @type {module:ol/pointer/PointerEventHandler} * @private */ this.pointerEventHandler_ = new PointerEventHandler(element); @@ -89,7 +89,7 @@ const MapBrowserEventHandler = function(map, moveTolerance) { * Event handler which generates pointer events for * the document (used when dragging). * - * @type {module:ol/pointer/PointerEventHandler~PointerEventHandler} + * @type {module:ol/pointer/PointerEventHandler} * @private */ this.documentPointerEventHandler_ = null; @@ -116,7 +116,7 @@ inherits(MapBrowserEventHandler, EventTarget); /** - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @private */ @@ -146,7 +146,7 @@ MapBrowserEventHandler.prototype.emulateClick_ = function(pointerEvent) { /** * Keeps track on how many pointers are currently active. * - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @private */ @@ -164,7 +164,7 @@ MapBrowserEventHandler.prototype.updateActivePointers_ = function(pointerEvent) /** - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @private */ @@ -196,7 +196,7 @@ MapBrowserEventHandler.prototype.handlePointerUp_ = function(pointerEvent) { /** - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @return {boolean} If the left mouse button was pressed. * @private @@ -207,7 +207,7 @@ MapBrowserEventHandler.prototype.isMouseActionButton_ = function(pointerEvent) { /** - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @private */ @@ -256,7 +256,7 @@ MapBrowserEventHandler.prototype.handlePointerDown_ = function(pointerEvent) { /** - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @private */ @@ -283,7 +283,7 @@ MapBrowserEventHandler.prototype.handlePointerMove_ = function(pointerEvent) { /** * Wrap and relay a pointer event. Note that this requires that the type * string for the MapBrowserPointerEvent matches the PointerEvent type. - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @private */ @@ -295,7 +295,7 @@ MapBrowserEventHandler.prototype.relayEvent_ = function(pointerEvent) { /** - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @param {module:ol/pointer/PointerEvent} pointerEvent Pointer * event. * @return {boolean} Is moving. * @private diff --git a/src/ol/MapBrowserPointerEvent.js b/src/ol/MapBrowserPointerEvent.js index f11219e044..4f5aa00376 100644 --- a/src/ol/MapBrowserPointerEvent.js +++ b/src/ol/MapBrowserPointerEvent.js @@ -6,10 +6,10 @@ import MapBrowserEvent from './MapBrowserEvent.js'; /** * @constructor - * @extends {module:ol/MapBrowserEvent~MapBrowserEvent} + * @extends {module:ol/MapBrowserEvent} * @param {string} type Event type. - * @param {module:ol/PluggableMap~PluggableMap} map Map. - * @param {module:ol/pointer/PointerEvent~PointerEvent} pointerEvent Pointer + * @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. @@ -22,7 +22,7 @@ const MapBrowserPointerEvent = function(type, map, pointerEvent, opt_dragging, /** * @const - * @type {module:ol/pointer/PointerEvent~PointerEvent} + * @type {module:ol/pointer/PointerEvent} */ this.pointerEvent = pointerEvent; diff --git a/src/ol/MapEvent.js b/src/ol/MapEvent.js index 5aac317f48..200b634802 100644 --- a/src/ol/MapEvent.js +++ b/src/ol/MapEvent.js @@ -10,10 +10,10 @@ import Event from './events/Event.js'; * See {@link module:ol/Map~Map} for which events trigger a map event. * * @constructor - * @extends {module:ol/events/Event~Event} + * @extends {module:ol/events/Event} * @implements {oli.MapEvent} * @param {string} type Event type. - * @param {module:ol/PluggableMap~PluggableMap} map Map. + * @param {module:ol/PluggableMap} map Map. * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state. */ const MapEvent = function(type, map, opt_frameState) { @@ -22,7 +22,7 @@ const MapEvent = function(type, map, opt_frameState) { /** * The map where the event occurred. - * @type {module:ol/PluggableMap~PluggableMap} + * @type {module:ol/PluggableMap} * @api */ this.map = map; diff --git a/src/ol/Object.js b/src/ol/Object.js index 82c13060a7..431d8d4983 100644 --- a/src/ol/Object.js +++ b/src/ol/Object.js @@ -16,7 +16,7 @@ import {assign} from './obj.js'; * @param {string} type The event type. * @param {string} key The property name. * @param {*} oldValue The old value for `key`. - * @extends {module:ol/events/Event~Event} + * @extends {module:ol/events/Event} * @implements {oli.Object.Event} * @constructor */ @@ -48,7 +48,7 @@ inherits(ObjectEvent, Event); * instantiated in apps. * Most non-trivial classes inherit from this. * - * This extends {@link module:ol/Observable~Observable} with observable + * This extends {@link module:ol/Observable} with observable * properties, where each property is observable as well as the object as a * whole. * @@ -83,7 +83,7 @@ inherits(ObjectEvent, Event); * object.unset('foo'). * * @constructor - * @extends {module:ol/Observable~Observable} + * @extends {module:ol/Observable} * @param {Object.=} opt_values An object with key-value pairs. * @fires module:ol/Object~ObjectEvent * @api diff --git a/src/ol/Observable.js b/src/ol/Observable.js index caaeb99b7c..5b7c99c84d 100644 --- a/src/ol/Observable.js +++ b/src/ol/Observable.js @@ -15,7 +15,7 @@ import EventType from './events/EventType.js'; * {@link module:ol/Observable~Observable#changed}. * * @constructor - * @extends {module:ol/events/EventTarget~EventTarget} + * @extends {module:ol/events/EventTarget} * @fires module:ol/events/Event~Event * @struct * @api @@ -68,8 +68,8 @@ Observable.prototype.changed = function() { * Object with a `type` property. * * @param {{type: string, - * target: (EventTarget|module:ol/events/EventTarget~EventTarget|undefined)}| - * module:ol/events/Event~Event|string} event Event object. + * target: (EventTarget|module:ol/events/EventTarget|undefined)}| + * module:ol/events/Event|string} event Event object. * @function * @api */ diff --git a/src/ol/Overlay.js b/src/ol/Overlay.js index 306ab8b55b..0891e4774b 100644 --- a/src/ol/Overlay.js +++ b/src/ol/Overlay.js @@ -94,7 +94,7 @@ const Property = { * map.addOverlay(popup); * * @constructor - * @extends {module:ol/Object~BaseObject} + * @extends {module:ol/Object} * @param {module:ol/Overlay~Options} options Overlay options. * @api */ @@ -239,13 +239,15 @@ Overlay.prototype.getId = function() { /** * Get the map associated with this overlay. - * @return {module:ol/PluggableMap~PluggableMap|undefined} The map that the + * @return {module:ol/PluggableMap|undefined} The map that the * overlay is part of. * @observable * @api */ Overlay.prototype.getMap = function() { - return /** @type {module:ol/PluggableMap~PluggableMap|undefined} */ (this.get(Property.MAP)); + return ( + /** @type {module:ol/PluggableMap|undefined} */ (this.get(Property.MAP)) + ); }; @@ -268,7 +270,9 @@ Overlay.prototype.getOffset = function() { * @api */ Overlay.prototype.getPosition = function() { - return /** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(Property.POSITION)); + return ( + /** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(Property.POSITION)) + ); }; @@ -280,7 +284,9 @@ Overlay.prototype.getPosition = function() { * @api */ Overlay.prototype.getPositioning = function() { - return /** @type {module:ol/OverlayPositioning~OverlayPositioning} */ (this.get(Property.POSITIONING)); + return ( + /** @type {module:ol/OverlayPositioning~OverlayPositioning} */ (this.get(Property.POSITIONING)) + ); }; @@ -369,7 +375,7 @@ Overlay.prototype.setElement = function(element) { /** * Set the map to be associated with this overlay. - * @param {module:ol/PluggableMap~PluggableMap|undefined} map The map that the + * @param {module:ol/PluggableMap|undefined} map The map that the * overlay is part of. * @observable * @api diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 9f98df2b52..426b6a9c3f 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -47,23 +47,23 @@ import {create as createTransform, apply as applyTransform} from './transform.js * @property {Array.} postRenderFunctions * @property {module:ol/size~Size} size * @property {!Object.} skippedFeatureUids - * @property {module:ol/TileQueue~TileQueue} tileQueue - * @property {Object.>} usedTiles + * @property {module:ol/TileQueue} tileQueue + * @property {Object.>} usedTiles * @property {Array.} viewHints * @property {!Object.>} wantedTiles */ /** - * @typedef {function(module:ol/PluggableMap~PluggableMap, ?module:ol/PluggableMap~FrameState): boolean} PostRenderFunction + * @typedef {function(module:ol/PluggableMap, ?module:ol/PluggableMap~FrameState): boolean} PostRenderFunction */ /** * @typedef {Object} AtPixelOptions - * @property {((function(module:ol/layer/Layer~Layer): boolean)|undefined)} layerFilter Layer filter + * @property {((function(module:ol/layer/Layer): boolean)|undefined)} layerFilter Layer filter * function. The filter function will receive one argument, the - * {@link module:ol/layer/Layer~Layer layer-candidate} and it should return a boolean value. + * {@link module:ol/layer/Layer layer-candidate} and it should return a boolean value. * Only layers which are visible and for which this function returns `true` * will be tested for features. By default, all visible layers will be tested. * @property {number} [hitTolerance=0] Hit-detection tolerance in pixels. Pixels @@ -74,10 +74,10 @@ import {create as createTransform, apply as applyTransform} from './transform.js /** * @typedef {Object} MapOptionsInternal - * @property {module:ol/Collection~Collection.} [controls] - * @property {module:ol/Collection~Collection.} [interactions] + * @property {module:ol/Collection.} [controls] + * @property {module:ol/Collection.} [interactions] * @property {Element|Document} keyboardEventTarget - * @property {module:ol/Collection~Collection.} overlays + * @property {module:ol/Collection.} overlays * @property {Object.} values */ @@ -85,12 +85,12 @@ import {create as createTransform, apply as applyTransform} from './transform.js /** * Object literal with config options for the map. * @typedef {Object} MapOptions - * @property {module:ol/Collection~Collection.|Array.} [controls] + * @property {module:ol/Collection.|Array.} [controls] * Controls initially added to the map. If not specified, * {@link module:ol/control~defaults} is used. * @property {number} [pixelRatio=window.devicePixelRatio] The ratio between * physical pixels and device-independent pixels (dips) on the device. - * @property {module:ol/Collection~Collection.|Array.} [interactions] + * @property {module:ol/Collection.|Array.} [interactions] * Interactions that are initially added to the map. If not specified, * {@link module:ol/interaction~defaults} is used. * @property {Element|Document|string} [keyboardEventTarget] The element to @@ -118,7 +118,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js * @property {number} [moveTolerance=1] The minimum distance in pixels the * cursor must move to be detected as a map move event instead of a click. * Increasing this value can make it easier to click on the map. - * @property {module:ol/Collection~Collection.|Array.} [overlays] + * @property {module:ol/Collection.|Array.} [overlays] * Overlays initially added to the map. By default, no overlays are added. * @property {Element|string} [target] The container for the map, either the * element itself or the `id` of the element. If not specified at construction @@ -132,7 +132,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js /** * @constructor - * @extends {module:ol/Object~BaseObject} + * @extends {module:ol/Object} * @param {module:ol/PluggableMap~MapOptions} options Map options. * @fires module:ol/MapBrowserEvent~MapBrowserEvent * @fires module:ol/MapEvent~MapEvent @@ -283,7 +283,7 @@ const PluggableMap = function(options) { /** * @private - * @type {module:ol/MapBrowserEventHandler~MapBrowserEventHandler} + * @type {module:ol/MapBrowserEventHandler} */ this.mapBrowserEventHandler_ = new MapBrowserEventHandler(this, options.moveTolerance); for (const key in MapBrowserEventType) { @@ -311,19 +311,19 @@ const PluggableMap = function(options) { this.handleBrowserEvent, this); /** - * @type {module:ol/Collection~Collection.} + * @type {module:ol/Collection.} * @protected */ this.controls = optionsInternal.controls || new Collection(); /** - * @type {module:ol/Collection~Collection.} + * @type {module:ol/Collection.} * @protected */ this.interactions = optionsInternal.interactions || new Collection(); /** - * @type {module:ol/Collection~Collection.} + * @type {module:ol/Collection.} * @private */ this.overlays_ = optionsInternal.overlays; @@ -331,7 +331,7 @@ const PluggableMap = function(options) { /** * A lookup of overlays by id. * @private - * @type {Object.} + * @type {Object.} */ this.overlayIdIndex_ = {}; @@ -361,7 +361,7 @@ const PluggableMap = function(options) { /** * @private - * @type {module:ol/TileQueue~TileQueue} + * @type {module:ol/TileQueue} */ this.tileQueue_ = new TileQueue( this.getTilePriority.bind(this), @@ -390,8 +390,8 @@ const PluggableMap = function(options) { this.controls.forEach( /** - * @param {module:ol/control/Control~Control} control Control. - * @this {module:ol/PluggableMap~PluggableMap} + * @param {module:ol/control/Control} control Control. + * @this {module:ol/PluggableMap} */ function(control) { control.setMap(this); @@ -415,8 +415,8 @@ const PluggableMap = function(options) { this.interactions.forEach( /** - * @param {module:ol/interaction/Interaction~Interaction} interaction Interaction. - * @this {module:ol/PluggableMap~PluggableMap} + * @param {module:ol/interaction/Interaction} interaction Interaction. + * @this {module:ol/PluggableMap} */ function(interaction) { interaction.setMap(this); @@ -445,7 +445,7 @@ const PluggableMap = function(options) { * @param {module:ol/Collection~CollectionEvent} event CollectionEvent. */ function(event) { - this.addOverlayInternal_(/** @type {module:ol/Overlay~Overlay} */ (event.element)); + this.addOverlayInternal_(/** @type {module:ol/Overlay} */ (event.element)); }, this); listen(this.overlays_, CollectionEventType.REMOVE, @@ -453,7 +453,7 @@ const PluggableMap = function(options) { * @param {module:ol/Collection~CollectionEvent} event CollectionEvent. */ function(event) { - const overlay = /** @type {module:ol/Overlay~Overlay} */ (event.element); + const overlay = /** @type {module:ol/Overlay} */ (event.element); const id = overlay.getId(); if (id !== undefined) { delete this.overlayIdIndex_[id.toString()]; @@ -473,7 +473,7 @@ PluggableMap.prototype.createRenderer = function() { /** * Add the given control to the map. - * @param {module:ol/control/Control~Control} control Control. + * @param {module:ol/control/Control} control Control. * @api */ PluggableMap.prototype.addControl = function(control) { @@ -483,7 +483,7 @@ PluggableMap.prototype.addControl = function(control) { /** * Add the given interaction to the map. - * @param {module:ol/interaction/Interaction~Interaction} interaction Interaction to add. + * @param {module:ol/interaction/Interaction} interaction Interaction to add. * @api */ PluggableMap.prototype.addInteraction = function(interaction) { @@ -506,7 +506,7 @@ PluggableMap.prototype.addLayer = function(layer) { /** * Add the given overlay to the map. - * @param {module:ol/Overlay~Overlay} overlay Overlay. + * @param {module:ol/Overlay} overlay Overlay. * @api */ PluggableMap.prototype.addOverlay = function(overlay) { @@ -516,7 +516,7 @@ PluggableMap.prototype.addOverlay = function(overlay) { /** * This deals with map's overlay collection changes. - * @param {module:ol/Overlay~Overlay} overlay Overlay. + * @param {module:ol/Overlay} overlay Overlay. * @private */ PluggableMap.prototype.addOverlayInternal_ = function(overlay) { @@ -555,12 +555,12 @@ PluggableMap.prototype.disposeInternal = function() { * callback with each intersecting feature. Layers included in the detection can * be configured through the `layerFilter` option in `opt_options`. * @param {module:ol~Pixel} pixel Pixel. - * @param {function(this: S, (module:ol/Feature~Feature|module:ol/render/Feature~Feature), - * module:ol/layer/Layer~Layer): T} callback Feature callback. The callback will be + * @param {function(this: S, (module:ol/Feature|module:ol/render/Feature~Feature), + * module:ol/layer/Layer): T} callback Feature callback. The callback will be * called with two arguments. The first argument is one - * {@link module:ol/Feature~Feature feature} or + * {@link module:ol/Feature feature} or * {@link module:ol/render/Feature~Feature render feature} at the pixel, the second is - * the {@link module:ol/layer/Layer~Layer layer} of the feature and will be null for + * the {@link module:ol/layer/Layer layer} of the feature and will be null for * unmanaged layers. To stop detection, callback functions can return a * truthy value. * @param {module:ol/PluggableMap~AtPixelOptions=} opt_options Optional options. @@ -589,7 +589,7 @@ PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_opt * Get all features that intersect a pixel on the viewport. * @param {module:ol~Pixel} pixel Pixel. * @param {module:ol/PluggableMap~AtPixelOptions=} opt_options Optional options. - * @return {Array.} The detected features or + * @return {Array.} The detected features or * `null` if none were found. * @api */ @@ -609,16 +609,16 @@ PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) { * execute a callback with each matching layer. Layers included in the * detection can be configured through `opt_layerFilter`. * @param {module:ol~Pixel} pixel Pixel. - * @param {function(this: S, module:ol/layer/Layer~Layer, (Uint8ClampedArray|Uint8Array)): T} callback + * @param {function(this: S, module:ol/layer/Layer, (Uint8ClampedArray|Uint8Array)): T} callback * Layer callback. This callback will receive two arguments: first is the - * {@link module:ol/layer/Layer~Layer layer}, second argument is an array representing + * {@link module:ol/layer/Layer layer}, second argument is an array representing * [R, G, B, A] pixel values (0 - 255) and will be `null` for layer types * that do not currently support this argument. To stop detection, callback * functions can return a truthy value. * @param {S=} opt_this Value to use as `this` when executing `callback`. - * @param {(function(this: U, module:ol/layer/Layer~Layer): boolean)=} opt_layerFilter Layer + * @param {(function(this: U, module:ol/layer/Layer): boolean)=} opt_layerFilter Layer * filter function. The filter function will receive one argument, the - * {@link module:ol/layer/Layer~Layer layer-candidate} and it should return a boolean + * {@link module:ol/layer/Layer layer-candidate} and it should return a boolean * value. Only layers which are visible and for which this function returns * `true` will be tested for features. By default, all visible layers will * be tested. @@ -742,7 +742,7 @@ PluggableMap.prototype.getCoordinateFromPixel = function(pixel) { /** * Get the map controls. Modifying this collection changes the controls * associated with the map. - * @return {module:ol/Collection~Collection.} Controls. + * @return {module:ol/Collection.} Controls. * @api */ PluggableMap.prototype.getControls = function() { @@ -753,7 +753,7 @@ PluggableMap.prototype.getControls = function() { /** * Get the map overlays. Modifying this collection changes the overlays * associated with the map. - * @return {module:ol/Collection~Collection.} Overlays. + * @return {module:ol/Collection.} Overlays. * @api */ PluggableMap.prototype.getOverlays = function() { @@ -766,7 +766,7 @@ PluggableMap.prototype.getOverlays = function() { * Note that the index treats string and numeric identifiers as the same. So * `map.getOverlayById(2)` will return an overlay with id `'2'` or `2`. * @param {string|number} id Overlay identifier. - * @return {module:ol/Overlay~Overlay} Overlay. + * @return {module:ol/Overlay} Overlay. * @api */ PluggableMap.prototype.getOverlayById = function(id) { @@ -780,7 +780,7 @@ PluggableMap.prototype.getOverlayById = function(id) { * associated with the map. * * Interactions are used for e.g. pan, zoom and rotate. - * @return {module:ol/Collection~Collection.} Interactions. + * @return {module:ol/Collection.} Interactions. * @api */ PluggableMap.prototype.getInteractions = function() { @@ -795,13 +795,15 @@ PluggableMap.prototype.getInteractions = function() { * @api */ PluggableMap.prototype.getLayerGroup = function() { - return /** @type {module:ol/layer/Group~Group} */ (this.get(MapProperty.LAYERGROUP)); + return ( + /** @type {module:ol/layer/Group~Group} */ (this.get(MapProperty.LAYERGROUP)) + ); }; /** * Get the collection of layers associated with this map. - * @return {!module:ol/Collection~Collection.} Layers. + * @return {!module:ol/Collection.} Layers. * @api */ PluggableMap.prototype.getLayers = function() { @@ -843,19 +845,23 @@ PluggableMap.prototype.getRenderer = function() { * @api */ PluggableMap.prototype.getSize = function() { - return /** @type {module:ol/size~Size|undefined} */ (this.get(MapProperty.SIZE)); + return ( + /** @type {module:ol/size~Size|undefined} */ (this.get(MapProperty.SIZE)) + ); }; /** * Get the view associated with this map. A view manages properties such as * center and resolution. - * @return {module:ol/View~View} The view that controls this map. + * @return {module:ol/View} The view that controls this map. * @observable * @api */ PluggableMap.prototype.getView = function() { - return /** @type {module:ol/View~View} */ (this.get(MapProperty.VIEW)); + return ( + /** @type {module:ol/View} */ (this.get(MapProperty.VIEW)) + ); }; @@ -894,7 +900,7 @@ PluggableMap.prototype.getOverlayContainerStopEvent = function() { /** - * @param {module:ol/Tile~Tile} tile Tile. + * @param {module:ol/Tile} tile Tile. * @param {string} tileSourceKey Tile source key. * @param {module:ol/coordinate~Coordinate} tileCenter Tile center. * @param {number} tileResolution Tile resolution. @@ -935,7 +941,7 @@ PluggableMap.prototype.handleBrowserEvent = function(browserEvent, opt_type) { /** - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent The event to handle. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent The event to handle. */ PluggableMap.prototype.handleMapBrowserEvent = function(mapBrowserEvent) { if (!this.frameState_) { @@ -1162,8 +1168,8 @@ PluggableMap.prototype.render = function() { /** * Remove the given control from the map. - * @param {module:ol/control/Control~Control} control Control. - * @return {module:ol/control/Control~Control|undefined} The removed control (or undefined + * @param {module:ol/control/Control} control Control. + * @return {module:ol/control/Control|undefined} The removed control (or undefined * if the control was not found). * @api */ @@ -1174,8 +1180,8 @@ PluggableMap.prototype.removeControl = function(control) { /** * Remove the given interaction from the map. - * @param {module:ol/interaction/Interaction~Interaction} interaction Interaction to remove. - * @return {module:ol/interaction/Interaction~Interaction|undefined} The removed interaction (or + * @param {module:ol/interaction/Interaction} interaction Interaction to remove. + * @return {module:ol/interaction/Interaction|undefined} The removed interaction (or * undefined if the interaction was not found). * @api */ @@ -1199,8 +1205,8 @@ PluggableMap.prototype.removeLayer = function(layer) { /** * Remove the given overlay from the map. - * @param {module:ol/Overlay~Overlay} overlay Overlay. - * @return {module:ol/Overlay~Overlay|undefined} The removed overlay (or undefined + * @param {module:ol/Overlay} overlay Overlay. + * @return {module:ol/Overlay|undefined} The removed overlay (or undefined * if the overlay was not found). * @api */ @@ -1339,7 +1345,7 @@ PluggableMap.prototype.setTarget = function(target) { /** * Set the view for this map. - * @param {module:ol/View~View} view The view that controls this map. + * @param {module:ol/View} view The view that controls this map. * @observable * @api */ @@ -1349,7 +1355,7 @@ PluggableMap.prototype.setView = function(view) { /** - * @param {module:ol/Feature~Feature} feature Feature. + * @param {module:ol/Feature} feature Feature. */ PluggableMap.prototype.skipFeature = function(feature) { const featureUid = getUid(feature).toString(); @@ -1387,7 +1393,7 @@ PluggableMap.prototype.updateSize = function() { /** - * @param {module:ol/Feature~Feature} feature Feature. + * @param {module:ol/Feature} feature Feature. */ PluggableMap.prototype.unskipFeature = function(feature) { const featureUid = getUid(feature).toString(); diff --git a/src/ol/Tile.js b/src/ol/Tile.js index 677bf9cbe9..980cf039fd 100644 --- a/src/ol/Tile.js +++ b/src/ol/Tile.js @@ -9,10 +9,10 @@ import EventType from './events/EventType.js'; /** - * A function that takes an {@link module:ol/Tile~Tile} for the tile and a + * A function that takes an {@link module:ol/Tile} for the tile and a * `{string}` for the url as arguments. * - * @typedef {function(module:ol/Tile~Tile, string)} LoadFunction + * @typedef {function(module:ol/Tile, string)} LoadFunction * @api */ @@ -22,12 +22,12 @@ import EventType from './events/EventType.js'; * * This function takes an {@link module:ol/tilecoord~TileCoord} for the tile * coordinate, a `{number}` representing the pixel ratio and a - * {@link module:ol/proj/Projection~Projection} for the projection as arguments + * {@link module:ol/proj/Projection} for the projection as arguments * and returns a `{string}` representing the tile URL, or undefined if no tile * should be requested for the passed tile coordinate. * * @typedef {function(module:ol/tilecoord~TileCoord, number, - * module:ol/proj/Projection~Projection): (string|undefined)} UrlFunction + * module:ol/proj/Projection): (string|undefined)} UrlFunction * @api */ @@ -46,7 +46,7 @@ import EventType from './events/EventType.js'; * * @constructor * @abstract - * @extends {module:ol/events/EventTarget~EventTarget} + * @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. @@ -71,7 +71,7 @@ const Tile = function(tileCoord, state, opt_options) { * An "interim" tile for this tile. The interim tile may be used while this * one is loading, for "smooth" transitions when changing params/dimensions * on the source. - * @type {module:ol/Tile~Tile} + * @type {module:ol/Tile} */ this.interimTile = null; @@ -120,7 +120,7 @@ Tile.prototype.getKey = function() { * Get the interim tile most suitable for rendering using the chain of interim * tiles. This corresponds to the most recent tile that has been loaded, if no * such tile exists, the original tile is returned. - * @return {!module:ol/Tile~Tile} Best tile for rendering. + * @return {!module:ol/Tile} Best tile for rendering. */ Tile.prototype.getInterimTile = function() { if (!this.interimTile) { diff --git a/src/ol/TileCache.js b/src/ol/TileCache.js index d670733ed9..a5ade7d6d1 100644 --- a/src/ol/TileCache.js +++ b/src/ol/TileCache.js @@ -7,7 +7,7 @@ import {fromKey, getKey} from './tilecoord.js'; /** * @constructor - * @extends {module:ol/structs/LRUCache~LRUCache.} + * @extends {module:ol/structs/LRUCache.} * @param {number=} opt_highWaterMark High water mark. * @struct */ @@ -21,7 +21,7 @@ inherits(TileCache, LRUCache); /** - * @param {!Object.} usedTiles Used tiles. + * @param {!Object.} usedTiles Used tiles. */ TileCache.prototype.expireCache = function(usedTiles) { while (this.canExpireCache()) { diff --git a/src/ol/TileQueue.js b/src/ol/TileQueue.js index 17ce82139d..f6fd1b533f 100644 --- a/src/ol/TileQueue.js +++ b/src/ol/TileQueue.js @@ -9,13 +9,13 @@ import PriorityQueue from './structs/PriorityQueue.js'; /** - * @typedef {function(module:ol/Tile~Tile, string, module:ol/coordinate~Coordinate, number): number} PriorityFunction + * @typedef {function(module:ol/Tile, string, module:ol/coordinate~Coordinate, number): number} PriorityFunction */ /** * @constructor - * @extends {module:ol/structs/PriorityQueue~PriorityQueue.} + * @extends {module:ol/structs/PriorityQueue.} * @param {module:ol/TileQueue~PriorityFunction} tilePriorityFunction * Tile priority function. * @param {function(): ?} tileChangeCallback @@ -38,7 +38,9 @@ const TileQueue = function(tilePriorityFunction, tileChangeCallback) { * @return {string} Key. */ function(element) { - return /** @type {module:ol/Tile~Tile} */ (element[0]).getKey(); + return ( + /** @type {module:ol/Tile} */ (element[0]).getKey() + ); }); /** @@ -87,11 +89,11 @@ TileQueue.prototype.getTilesLoading = function() { /** - * @param {module:ol/events/Event~Event} event Event. + * @param {module:ol/events/Event} event Event. * @protected */ TileQueue.prototype.handleTileChange = function(event) { - const tile = /** @type {module:ol/Tile~Tile} */ (event.target); + const tile = /** @type {module:ol/Tile} */ (event.target); const state = tile.getState(); if (state === TileState.LOADED || state === TileState.ERROR || state === TileState.EMPTY || state === TileState.ABORT) { @@ -117,7 +119,7 @@ TileQueue.prototype.loadMoreTiles = function(maxTotalLoading, maxNewLoads) { let state, tile, tileKey; while (this.tilesLoading_ < maxTotalLoading && newLoads < maxNewLoads && this.getCount() > 0) { - tile = /** @type {module:ol/Tile~Tile} */ (this.dequeue()[0]); + tile = /** @type {module:ol/Tile} */ (this.dequeue()[0]); tileKey = tile.getKey(); state = tile.getState(); if (state === TileState.ABORT) { diff --git a/src/ol/TileRange.js b/src/ol/TileRange.js index 7e203238d1..efa9129c42 100644 --- a/src/ol/TileRange.js +++ b/src/ol/TileRange.js @@ -42,8 +42,8 @@ const TileRange = function(minX, maxX, minY, maxY) { * @param {number} maxX Maximum X. * @param {number} minY Minimum Y. * @param {number} maxY Maximum Y. - * @param {module:ol/TileRange~TileRange=} tileRange TileRange. - * @return {module:ol/TileRange~TileRange} Tile range. + * @param {module:ol/TileRange=} tileRange TileRange. + * @return {module:ol/TileRange} Tile range. */ export function createOrUpdate(minX, maxX, minY, maxY, tileRange) { if (tileRange !== undefined) { @@ -68,7 +68,7 @@ TileRange.prototype.contains = function(tileCoord) { /** - * @param {module:ol/TileRange~TileRange} tileRange Tile range. + * @param {module:ol/TileRange} tileRange Tile range. * @return {boolean} Contains. */ TileRange.prototype.containsTileRange = function(tileRange) { @@ -88,7 +88,7 @@ TileRange.prototype.containsXY = function(x, y) { /** - * @param {module:ol/TileRange~TileRange} tileRange Tile range. + * @param {module:ol/TileRange} tileRange Tile range. * @return {boolean} Equals. */ TileRange.prototype.equals = function(tileRange) { @@ -98,7 +98,7 @@ TileRange.prototype.equals = function(tileRange) { /** - * @param {module:ol/TileRange~TileRange} tileRange Tile range. + * @param {module:ol/TileRange} tileRange Tile range. */ TileRange.prototype.extend = function(tileRange) { if (tileRange.minX < this.minX) { @@ -141,7 +141,7 @@ TileRange.prototype.getWidth = function() { /** - * @param {module:ol/TileRange~TileRange} tileRange Tile range. + * @param {module:ol/TileRange} tileRange Tile range. * @return {boolean} Intersects. */ TileRange.prototype.intersects = function(tileRange) { diff --git a/src/ol/VectorImageTile.js b/src/ol/VectorImageTile.js index c28b0ca06b..ed70e8f9f1 100644 --- a/src/ol/VectorImageTile.js +++ b/src/ol/VectorImageTile.js @@ -22,23 +22,23 @@ import {loadFeaturesXhr} from './featureloader.js'; /** * @constructor - * @extends {module:ol/Tile~Tile} + * @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~FeatureFormat} format Feature format. + * @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~TileGrid} sourceTileGrid Tile grid of the source. - * @param {module:ol/tilegrid/TileGrid~TileGrid} tileGrid Tile grid of the renderer. - * @param {Object.} sourceTiles Source tiles. + * @param {module:ol/tilegrid/TileGrid} sourceTileGrid Tile grid of the source. + * @param {module:ol/tilegrid/TileGrid} tileGrid Tile grid of the renderer. + * @param {Object.} sourceTiles Source tiles. * @param {number} pixelRatio Pixel ratio. - * @param {module:ol/proj/Projection~Projection} projection Projection. - * @param {function(new: module:ol/VectorTile~VectorTile, module:ol/tilecoord~TileCoord, module:ol/TileState, string, - * module:ol/format/Feature~FeatureFormat, module:ol/Tile~LoadFunction)} tileClass Class to + * @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~VectorTile, module:ol/events/Event~Event)} handleTileChange + * @param {function(this: module:ol/source/VectorTile, module:ol/events/Event)} handleTileChange * Function to call when a source tile's state changes. * @param {module:ol/Tile~Options=} opt_options Tile options. */ @@ -68,7 +68,7 @@ const VectorImageTile = function(tileCoord, state, sourceRevision, format, /** * @private - * @type {Object.} + * @type {Object.} */ this.sourceTiles_ = sourceTiles; @@ -164,7 +164,7 @@ VectorImageTile.prototype.disposeInternal = function() { /** - * @param {module:ol/layer/Layer~Layer} layer Layer. + * @param {module:ol/layer/Layer} layer Layer. * @return {CanvasRenderingContext2D} The rendering context. */ VectorImageTile.prototype.getContext = function(layer) { @@ -178,7 +178,7 @@ VectorImageTile.prototype.getContext = function(layer) { /** * Get the Canvas for this tile. - * @param {module:ol/layer/Layer~Layer} layer Layer. + * @param {module:ol/layer/Layer} layer Layer. * @return {HTMLCanvasElement} Canvas. */ VectorImageTile.prototype.getImage = function(layer) { @@ -188,7 +188,7 @@ VectorImageTile.prototype.getImage = function(layer) { /** - * @param {module:ol/layer/Layer~Layer} layer Layer. + * @param {module:ol/layer/Layer} layer Layer. * @return {module:ol/VectorImageTile~ReplayState} The replay state. */ VectorImageTile.prototype.getReplayState = function(layer) { @@ -215,7 +215,7 @@ VectorImageTile.prototype.getKey = function() { /** * @param {string} tileKey Key (tileCoord) of the source tile. - * @return {module:ol/VectorTile~VectorTile} Source tile. + * @return {module:ol/VectorTile} Source tile. */ VectorImageTile.prototype.getTile = function(tileKey) { return this.sourceTiles_[tileKey]; @@ -299,7 +299,7 @@ export default VectorImageTile; /** * Sets the loader for a tile. - * @param {module:ol/VectorTile~VectorTile} tile Vector tile. + * @param {module:ol/VectorTile} tile Vector tile. * @param {string} url URL. */ export function defaultLoadFunction(tile, url) { diff --git a/src/ol/VectorTile.js b/src/ol/VectorTile.js index 187c1a9b48..308d3ed9e6 100644 --- a/src/ol/VectorTile.js +++ b/src/ol/VectorTile.js @@ -6,18 +6,18 @@ import Tile from './Tile.js'; import TileState from './TileState.js'; /** - * @typedef {function(new: module:ol/VectorTile~VectorTile, module:ol/tilecoord~TileCoord, + * @typedef {function(new: module:ol/VectorTile, module:ol/tilecoord~TileCoord, * module:ol/TileState, string, ?string, module:ol/Tile~LoadFunction)} TileClass * @api */ /** * @constructor - * @extends {module:ol/Tile~Tile} + * @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~FeatureFormat} format Feature format. + * @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. */ @@ -38,13 +38,13 @@ const VectorTile = function(tileCoord, state, src, format, tileLoadFunction, opt /** * @private - * @type {module:ol/format/Feature~FeatureFormat} + * @type {module:ol/format/Feature} */ this.format_ = format; /** * @private - * @type {Array.} + * @type {Array.} */ this.features_ = null; @@ -57,13 +57,13 @@ const VectorTile = function(tileCoord, state, src, format, tileLoadFunction, opt /** * Data projection * @private - * @type {module:ol/proj/Projection~Projection} + * @type {module:ol/proj/Projection} */ this.projection_; /** * @private - * @type {Object.} + * @type {Object.} */ this.replayGroups_ = {}; @@ -114,7 +114,7 @@ VectorTile.prototype.getExtent = function() { /** * Get the feature format assigned for reading this tile's features. - * @return {module:ol/format/Feature~FeatureFormat} Feature format. + * @return {module:ol/format/Feature} Feature format. * @api */ VectorTile.prototype.getFormat = function() { @@ -125,7 +125,7 @@ VectorTile.prototype.getFormat = function() { /** * Get the features for this tile. Geometries will be in the projection returned * by {@link module:ol/VectorTile~VectorTile#getProjection}. - * @return {Array.} Features. + * @return {Array.} Features. * @api */ VectorTile.prototype.getFeatures = function() { @@ -144,7 +144,7 @@ VectorTile.prototype.getKey = function() { /** * Get the feature projection of features returned by * {@link module:ol/VectorTile~VectorTile#getFeatures}. - * @return {module:ol/proj/Projection~Projection} Feature projection. + * @return {module:ol/proj/Projection} Feature projection. * @api */ VectorTile.prototype.getProjection = function() { @@ -153,9 +153,9 @@ VectorTile.prototype.getProjection = function() { /** - * @param {module:ol/layer/Layer~Layer} layer Layer. + * @param {module:ol/layer/Layer} layer Layer. * @param {string} key Key. - * @return {module:ol/render/ReplayGroup~ReplayGroup} Replay group. + * @return {module:ol/render/ReplayGroup} Replay group. */ VectorTile.prototype.getReplayGroup = function(layer, key) { return this.replayGroups_[getUid(layer) + ',' + key]; @@ -176,8 +176,8 @@ VectorTile.prototype.load = function() { /** * Handler for successful tile load. - * @param {Array.} features The loaded features. - * @param {module:ol/proj/Projection~Projection} dataProjection Data projection. + * @param {Array.} features The loaded features. + * @param {module:ol/proj/Projection} dataProjection Data projection. * @param {module:ol/extent~Extent} extent Extent. */ VectorTile.prototype.onLoad = function(features, dataProjection, extent) { @@ -215,7 +215,7 @@ VectorTile.prototype.setExtent = function(extent) { /** * Function for use in an {@link module:ol/source/VectorTile~VectorTile}'s `tileLoadFunction`. * Sets the features for the tile. - * @param {Array.} features Features. + * @param {Array.} features Features. * @api */ VectorTile.prototype.setFeatures = function(features) { @@ -228,7 +228,7 @@ VectorTile.prototype.setFeatures = function(features) { * Function for use in an {@link module:ol/source/VectorTile~VectorTile}'s `tileLoadFunction`. * Sets the projection of the features that were added with * {@link module:ol/VectorTile~VectorTile#setFeatures}. - * @param {module:ol/proj/Projection~Projection} projection Feature projection. + * @param {module:ol/proj/Projection} projection Feature projection. * @api */ VectorTile.prototype.setProjection = function(projection) { @@ -237,9 +237,9 @@ VectorTile.prototype.setProjection = function(projection) { /** - * @param {module:ol/layer/Layer~Layer} layer Layer. + * @param {module:ol/layer/Layer} layer Layer. * @param {string} key Key. - * @param {module:ol/render/ReplayGroup~ReplayGroup} replayGroup Replay group. + * @param {module:ol/render/ReplayGroup} replayGroup Replay group. */ VectorTile.prototype.setReplayGroup = function(layer, key, replayGroup) { this.replayGroups_[getUid(layer) + ',' + key] = replayGroup; diff --git a/src/ol/View.js b/src/ol/View.js index 5e948456e8..8fcb3d5cb5 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -158,7 +158,7 @@ import Units from './proj/Units.js'; /** * @typedef {Object} State * @property {module:ol/coordinate~Coordinate} center - * @property {module:ol/proj/Projection~Projection} projection + * @property {module:ol/proj/Projection} projection * @property {number} resolution * @property {number} rotation * @property {number} zoom @@ -225,7 +225,7 @@ const DEFAULT_MIN_ZOOM = 0; * default the center is not constrained at all. * * @constructor - * @extends {module:ol/Object~BaseObject} + * @extends {module:ol/Object} * @param {module:ol/View~ViewOptions=} opt_options View options. * @api */ @@ -257,7 +257,7 @@ const View = function(opt_options) { /** * @private * @const - * @type {module:ol/proj/Projection~Projection} + * @type {module:ol/proj/Projection} */ this.projection_ = createProjection(options.projection, 'EPSG:3857'); @@ -711,7 +711,9 @@ View.prototype.constrainRotation = function(rotation, opt_delta) { * @api */ View.prototype.getCenter = function() { - return /** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(ViewProperty.CENTER)); + return ( + /** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(ViewProperty.CENTER)) + ); }; @@ -823,7 +825,7 @@ View.prototype.setMinZoom = function(zoom) { /** * Get the view projection. - * @return {module:ol/proj/Projection~Projection} The projection of the view. + * @return {module:ol/proj/Projection} The projection of the view. * @api */ View.prototype.getProjection = function() { @@ -935,13 +937,15 @@ View.prototype.getState = function() { const projection = this.getProjection(); const resolution = /** @type {number} */ (this.getResolution()); const rotation = this.getRotation(); - return /** @type {module:ol/View~State} */ ({ - center: center.slice(), - projection: projection !== undefined ? projection : null, - resolution: resolution, - rotation: rotation, - zoom: this.getZoom() - }); + return ( + /** @type {module:ol/View~State} */ ({ + center: center.slice(), + projection: projection !== undefined ? projection : null, + resolution: resolution, + rotation: rotation, + zoom: this.getZoom() + }) + ); }; @@ -1005,7 +1009,7 @@ View.prototype.getResolutionForZoom = function(zoom) { * The size is pixel dimensions of the box to fit the extent into. * In most cases you will want to use the map size, that is `map.getSize()`. * Takes care of the map angle. - * @param {module:ol/geom/SimpleGeometry~SimpleGeometry|module:ol/extent~Extent} geometryOrExtent The geometry or + * @param {module:ol/geom/SimpleGeometry|module:ol/extent~Extent} geometryOrExtent The geometry or * extent to fit the view to. * @param {module:ol/View~FitOptions=} opt_options Options. * @api @@ -1016,7 +1020,7 @@ View.prototype.fit = function(geometryOrExtent, opt_options) { if (!size) { size = this.getSizeFromViewport_(); } - /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ + /** @type {module:ol/geom/SimpleGeometry} */ let geometry; if (!(geometryOrExtent instanceof SimpleGeometry)) { assert(Array.isArray(geometryOrExtent), diff --git a/src/ol/WebGLMap.js b/src/ol/WebGLMap.js index ec5550c3df..cbcbc6f149 100644 --- a/src/ol/WebGLMap.js +++ b/src/ol/WebGLMap.js @@ -58,7 +58,7 @@ import WebGLVectorLayerRenderer from './renderer/webgl/VectorLayer.js'; * with `addLayer` can be groups, which can contain further groups, and so on. * * @constructor - * @extends {module:ol/PluggableMap~PluggableMap} + * @extends {module:ol/PluggableMap} * @param {module:ol/PluggableMap~MapOptions} options Map options. * @fires module:ol/MapBrowserEvent~MapBrowserEvent * @fires module:ol/MapEvent~MapEvent diff --git a/src/ol/color.js b/src/ol/color.js index e96b5a99a4..3dbcd4bd8b 100644 --- a/src/ol/color.js +++ b/src/ol/color.js @@ -185,7 +185,9 @@ function fromStringInternal_(s) { } else { assert(false, 14); // Invalid color } - return /** @type {module:ol/color~Color} */ (color); + return ( + /** @type {module:ol/color~Color} */ (color) + ); } diff --git a/src/ol/control.js b/src/ol/control.js index 30c7edd78b..aafb064e39 100644 --- a/src/ol/control.js +++ b/src/ol/control.js @@ -44,7 +44,7 @@ export {default as ZoomToExtent} from './control/ZoomToExtent.js'; * * @param {module:ol/control~DefaultsOptions=} opt_options * Defaults options. - * @return {module:ol/Collection~Collection.} + * @return {module:ol/Collection.} * Controls. * @api */ diff --git a/src/ol/control/Attribution.js b/src/ol/control/Attribution.js index cf2932a81f..e4aac2b217 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(module:ol/MapEvent~MapEvent)} [render] Function called when + * @property {function(module:ol/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 {module:ol/control/Control~Control} + * @extends {module:ol/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 {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {module:ol/control/Attribution~Attribution} + * @param {module:ol/MapEvent} mapEvent Map event. + * @this {module:ol/control/Attribution} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index f1ab4a614b..0d4989866d 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} [element] The element is the control's * container element. This only needs to be specified if you're developing * a custom control. - * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when + * @property {function(module:ol/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 @@ -45,7 +45,7 @@ import {listen, unlistenByKey} from '../events.js'; * examples/custom-controls for an example of how to do this. * * @constructor - * @extends {module:ol/Object~BaseObject} + * @extends {module:ol/Object} * @implements {oli.control.Control} * @param {module:ol/control/Control~Options} options Control options. * @api @@ -68,7 +68,7 @@ const Control = function(options) { /** * @private - * @type {module:ol/PluggableMap~PluggableMap} + * @type {module:ol/PluggableMap} */ this.map_ = null; @@ -79,7 +79,7 @@ const Control = function(options) { this.listenerKeys = []; /** - * @type {function(module:ol/MapEvent~MapEvent)} + * @type {function(module:ol/MapEvent)} */ this.render = options.render ? options.render : UNDEFINED; @@ -103,7 +103,7 @@ Control.prototype.disposeInternal = function() { /** * Get the map associated with this control. - * @return {module:ol/PluggableMap~PluggableMap} Map. + * @return {module:ol/PluggableMap} Map. * @api */ Control.prototype.getMap = function() { @@ -115,7 +115,7 @@ Control.prototype.getMap = function() { * Remove the control from its current map and attach it to the new map. * Subclasses may set up event handlers to get notified about changes to * the map here. - * @param {module:ol/PluggableMap~PluggableMap} map Map. + * @param {module:ol/PluggableMap} map Map. * @override * @api */ diff --git a/src/ol/control/FullScreen.js b/src/ol/control/FullScreen.js index f27ea87bd7..9ed4f543d1 100644 --- a/src/ol/control/FullScreen.js +++ b/src/ol/control/FullScreen.js @@ -63,7 +63,7 @@ const getChangeType = (function() { * * * @constructor - * @extends {module:ol/control/Control~Control} + * @extends {module:ol/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 1fa3761505..e2c26ce950 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 {module:ol/proj~ProjectionLike} projection Projection. - * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the + * @property {function(module:ol/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 @@ -47,7 +47,7 @@ const COORDINATE_FORMAT = 'coordinateFormat'; * can be changed by using the css selector `.ol-mouse-position`. * * @constructor - * @extends {module:ol/control/Control~Control} + * @extends {module:ol/control/Control} * @param {module:ol/control/MousePosition~Options=} opt_options Mouse position * options. * @api @@ -96,7 +96,7 @@ const MousePosition = function(opt_options) { /** * @private - * @type {module:ol/proj/Projection~Projection} + * @type {module:ol/proj/Projection} */ this.mapProjection_ = null; @@ -119,8 +119,8 @@ inherits(MousePosition, Control); /** * Update the mouseposition element. - * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {module:ol/control/MousePosition~MousePosition} + * @param {module:ol/MapEvent} mapEvent Map event. + * @this {module:ol/control/MousePosition} * @api */ export function render(mapEvent) { @@ -154,19 +154,23 @@ MousePosition.prototype.handleProjectionChanged_ = function() { * @api */ MousePosition.prototype.getCoordinateFormat = function() { - return /** @type {module:ol/coordinate~CoordinateFormat|undefined} */ (this.get(COORDINATE_FORMAT)); + return ( + /** @type {module:ol/coordinate~CoordinateFormat|undefined} */ (this.get(COORDINATE_FORMAT)) + ); }; /** * Return the projection that is used to report the mouse position. - * @return {module:ol/proj/Projection~Projection|undefined} The projection to report mouse + * @return {module:ol/proj/Projection|undefined} The projection to report mouse * position in. * @observable * @api */ MousePosition.prototype.getProjection = function() { - return /** @type {module:ol/proj/Projection~Projection|undefined} */ (this.get(PROJECTION)); + return ( + /** @type {module:ol/proj/Projection|undefined} */ (this.get(PROJECTION)) + ); }; diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index 2c50df1c94..2e30120d58 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -45,15 +45,15 @@ const MIN_RATIO = 0.1; * @property {boolean} [collapsible=true] Whether the control can be collapsed or not. * @property {string|Element} [label='»'] Text label to use for the collapsed * overviewmap button. Instead of text, also an element (e.g. a `span` element) can be used. - * @property {Array.|module:ol/Collection~Collection.} [layers] + * @property {Array.|module:ol/Collection.} [layers] * Layers for the overview map. If not set, then all main map layers are used * instead. - * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control + * @property {function(module:ol/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 {string} [tipLabel='Overview map'] Text label to use for the button tip. - * @property {module:ol/View~View} [view] Custom view for the overview map. If not provided, + * @property {module:ol/View} [view] Custom view for the overview map. If not provided, * a default view with an EPSG:3857 projection will be used. */ @@ -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 {module:ol/control/Control~Control} + * @extends {module:ol/control/Control} * @param {module:ol/control/OverviewMap~Options=} opt_options OverviewMap options. * @api */ @@ -136,7 +136,7 @@ const OverviewMap = function(opt_options) { this.ovmapDiv_.className = 'ol-overviewmap-map'; /** - * @type {module:ol/Map~Map} + * @type {module:ol/Map} * @private */ this.ovmap_ = new Map({ @@ -149,7 +149,7 @@ const OverviewMap = function(opt_options) { if (options.layers) { options.layers.forEach( /** - * @param {module:ol/layer/Layer~Layer} layer Layer. + * @param {module:ol/layer/Layer} layer Layer. */ function(layer) { ovmap.addLayer(layer); @@ -161,7 +161,7 @@ const OverviewMap = function(opt_options) { box.style.boxSizing = 'border-box'; /** - * @type {module:ol/Overlay~Overlay} + * @type {module:ol/Overlay} * @private */ this.boxOverlay_ = new Overlay({ @@ -275,7 +275,7 @@ OverviewMap.prototype.setMap = function(map) { */ OverviewMap.prototype.handleMapPropertyChange_ = function(event) { if (event.key === MapProperty.VIEW) { - const oldView = /** @type {module:ol/View~View} */ (event.oldValue); + const oldView = /** @type {module:ol/View} */ (event.oldValue); if (oldView) { this.unbindView_(oldView); } @@ -287,7 +287,7 @@ OverviewMap.prototype.handleMapPropertyChange_ = function(event) { /** * Register listeners for view property changes. - * @param {module:ol/View~View} view The view. + * @param {module:ol/View} view The view. * @private */ OverviewMap.prototype.bindView_ = function(view) { @@ -299,7 +299,7 @@ OverviewMap.prototype.bindView_ = function(view) { /** * Unregister listeners for view property changes. - * @param {module:ol/View~View} view The view. + * @param {module:ol/View} view The view. * @private */ OverviewMap.prototype.unbindView_ = function(view) { @@ -322,8 +322,8 @@ OverviewMap.prototype.handleRotationChanged_ = function() { /** * Update the overview map element. - * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {module:ol/control/OverviewMap~OverviewMap} + * @param {module:ol/MapEvent} mapEvent Map event. + * @this {module:ol/control/OverviewMap} * @api */ export function render(mapEvent) { @@ -588,7 +588,7 @@ OverviewMap.prototype.getCollapsed = function() { /** * Return the overview map. - * @return {module:ol/PluggableMap~PluggableMap} Overview map. + * @return {module:ol/PluggableMap} Overview map. * @api */ OverviewMap.prototype.getOverviewMap = function() { diff --git a/src/ol/control/Rotate.js b/src/ol/control/Rotate.js index f4cd00cf89..8ba9063613 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(module:ol/MapEvent~MapEvent)} [render] Function called when the control should + * @property {function(module:ol/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 {module:ol/control/Control~Control} + * @extends {module:ol/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 {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {module:ol/control/Rotate~Rotate} + * @param {module:ol/MapEvent} mapEvent Map event. + * @this {module:ol/control/Rotate} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/ScaleLine.js b/src/ol/control/ScaleLine.js index 12bb252d79..629acb252d 100644 --- a/src/ol/control/ScaleLine.js +++ b/src/ol/control/ScaleLine.js @@ -41,7 +41,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(module:ol/MapEvent~MapEvent)} [render] Function called when the control + * @property {function(module:ol/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. @@ -60,7 +60,7 @@ const LEADING_DIGITS = [1, 2, 5]; * but this can be changed by using the css selector `.ol-scale-line`. * * @constructor - * @extends {module:ol/control/Control~Control} + * @extends {module:ol/control/Control} * @param {module:ol/control/ScaleLine~Options=} opt_options Scale line options. * @api */ @@ -141,14 +141,16 @@ inherits(ScaleLine, Control); * @api */ ScaleLine.prototype.getUnits = function() { - return /** @type {module:ol/control/ScaleLine~Units|undefined} */ (this.get(UNITS_PROP)); + return ( + /** @type {module:ol/control/ScaleLine~Units|undefined} */ (this.get(UNITS_PROP)) + ); }; /** * Update the scale line element. - * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {module:ol/control/ScaleLine~ScaleLine} + * @param {module:ol/MapEvent} mapEvent Map event. + * @this {module:ol/control/ScaleLine} * @api */ export function render(mapEvent) { diff --git a/src/ol/control/Zoom.js b/src/ol/control/Zoom.js index 271e92ca1e..02b6b0ca83 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 {module:ol/control/Control~Control} + * @extends {module:ol/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 7eb5937853..d56d1b10cd 100644 --- a/src/ol/control/ZoomSlider.js +++ b/src/ol/control/ZoomSlider.js @@ -29,7 +29,7 @@ const Direction = { * @typedef {Object} Options * @property {string} [className='ol-zoomslider'] CSS class name. * @property {number} [duration=200] Animation duration in milliseconds. - * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control + * @property {function(module:ol/MapEvent)} [render] Function called when the control * should be re-rendered. This is called in a `requestAnimationFrame` callback. */ @@ -43,7 +43,7 @@ const Direction = { * map.addControl(new ZoomSlider()); * * @constructor - * @extends {module:ol/control/Control~Control} + * @extends {module:ol/control/Control} * @param {module:ol/control/ZoomSlider~Options=} opt_options Zoom slider options. * @api */ @@ -127,7 +127,7 @@ const ZoomSlider = function(opt_options) { containerElement.className = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL; containerElement.appendChild(thumbElement); /** - * @type {module:ol/pointer/PointerEventHandler~PointerEventHandler} + * @type {module:ol/pointer/PointerEventHandler} * @private */ this.dragger_ = new PointerEventHandler(containerElement); @@ -207,8 +207,8 @@ ZoomSlider.prototype.initSlider_ = function() { /** * Update the zoomslider element. - * @param {module:ol/MapEvent~MapEvent} mapEvent Map event. - * @this {module:ol/control/ZoomSlider~ZoomSlider} + * @param {module:ol/MapEvent} mapEvent Map event. + * @this {module:ol/control/ZoomSlider} * @api */ export function render(mapEvent) { @@ -249,7 +249,7 @@ ZoomSlider.prototype.handleContainerClick_ = function(event) { /** * Handle dragger start events. - * @param {module:ol/pointer/PointerEvent~PointerEvent} event The drag event. + * @param {module:ol/pointer/PointerEvent} event The drag event. * @private */ ZoomSlider.prototype.handleDraggerStart_ = function(event) { @@ -265,7 +265,7 @@ ZoomSlider.prototype.handleDraggerStart_ = function(event) { /** * Handle dragger drag events. * - * @param {module:ol/pointer/PointerEvent~PointerEvent|Event} event The drag event. + * @param {module:ol/pointer/PointerEvent|Event} event The drag event. * @private */ ZoomSlider.prototype.handleDraggerDrag_ = function(event) { @@ -285,7 +285,7 @@ ZoomSlider.prototype.handleDraggerDrag_ = function(event) { /** * Handle dragger end events. - * @param {module:ol/pointer/PointerEvent~PointerEvent|Event} event The drag event. + * @param {module:ol/pointer/PointerEvent|Event} event The drag event. * @private */ ZoomSlider.prototype.handleDraggerEnd_ = function(event) { diff --git a/src/ol/control/ZoomToExtent.js b/src/ol/control/ZoomToExtent.js index 5d3d79fa4d..34f0a30cf5 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 {module:ol/control/Control~Control} + * @extends {module:ol/control/Control} * @param {module:ol/control/ZoomToExtent~Options=} opt_options Options. * @api */ diff --git a/src/ol/coordinate.js b/src/ol/coordinate.js index 7d55aed45e..d38ee703d2 100644 --- a/src/ol/coordinate.js +++ b/src/ol/coordinate.js @@ -50,7 +50,7 @@ export function add(coordinate, delta) { * Calculates the point closest to the passed coordinate on the passed circle. * * @param {module:ol/coordinate~Coordinate} coordinate The coordinate. - * @param {module:ol/geom/Circle~Circle} circle The circle. + * @param {module:ol/geom/Circle} circle The circle. * @return {module:ol/coordinate~Coordinate} Closest point on the circumference. */ export function closestOnCircle(coordinate, circle) { diff --git a/src/ol/events.js b/src/ol/events.js index 720c0386d1..3519714521 100644 --- a/src/ol/events.js +++ b/src/ol/events.js @@ -12,7 +12,7 @@ import {clear} from './obj.js'; * @property {boolean} callOnce * @property {number} [deleteIndex] * @property {module:ol/events~ListenerFunction} listener - * @property {EventTarget|module:ol/events/EventTarget~EventTarget} target + * @property {EventTarget|module:ol/events/EventTarget} target * @property {string} type * @api */ @@ -22,7 +22,7 @@ import {clear} from './obj.js'; * Listener function. This function is called with an event object as argument. * When the function returns `false`, event propagation will stop. * - * @typedef {function(module:ol/events/Event~Event)|function(module:ol/events/Event~Event): boolean} ListenerFunction + * @typedef {function(module:ol/events/Event)|function(module:ol/events/Event): boolean} ListenerFunction * @api */ diff --git a/src/ol/events/Event.js b/src/ol/events/Event.js index 464967361c..159f8beed0 100644 --- a/src/ol/events/Event.js +++ b/src/ol/events/Event.js @@ -59,7 +59,7 @@ Event.prototype.preventDefault = /** - * @param {Event|module:ol/events/Event~Event} evt Event + * @param {Event|module:ol/events/Event} evt Event */ export function stopPropagation(evt) { evt.stopPropagation(); @@ -67,7 +67,7 @@ export function stopPropagation(evt) { /** - * @param {Event|module:ol/events/Event~Event} evt Event + * @param {Event|module:ol/events/Event} evt Event */ export function preventDefault(evt) { evt.preventDefault(); diff --git a/src/ol/events/EventTarget.js b/src/ol/events/EventTarget.js index a1088c7f05..87703732d6 100644 --- a/src/ol/events/EventTarget.js +++ b/src/ol/events/EventTarget.js @@ -9,7 +9,7 @@ import Event from '../events/Event.js'; /** - * @typedef {EventTarget|module:ol/events/EventTarget~EventTarget} EventTargetLike + * @typedef {EventTarget|module:ol/events/EventTarget} EventTargetLike */ @@ -29,7 +29,7 @@ import Event from '../events/Event.js'; * returns false. * * @constructor - * @extends {module:ol/Disposable~Disposable} + * @extends {module:ol/Disposable} */ const EventTarget = function() { @@ -75,7 +75,7 @@ EventTarget.prototype.addEventListener = function(type, listener) { /** * @param {{type: string, - * target: (EventTarget|module:ol/events/EventTarget~EventTarget|undefined)}|module:ol/events/Event~Event| + * target: (EventTarget|module:ol/events/EventTarget|undefined)}|module:ol/events/Event| * string} event Event or event type. * @return {boolean|undefined} `false` if anyone called preventDefault on the * event object or if any of the listeners returned false. diff --git a/src/ol/events/condition.js b/src/ol/events/condition.js index 536ba83697..ecfa991981 100644 --- a/src/ol/events/condition.js +++ b/src/ol/events/condition.js @@ -8,10 +8,10 @@ import {WEBKIT, MAC} from '../has.js'; /** - * A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a + * A function that takes an {@link module:ol/MapBrowserEvent} and returns a * `{boolean}`. If the condition is met, true should be returned. * - * @typedef {function(module:ol/MapBrowserEvent~MapBrowserEvent): boolean} Condition + * @typedef {function(module:ol/MapBrowserEvent): boolean} Condition */ @@ -19,7 +19,7 @@ import {WEBKIT, MAC} from '../has.js'; * Return `true` if only the alt-key is pressed, `false` otherwise (e.g. when * additionally the shift-key is pressed). * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt key is pressed. * @api */ @@ -36,7 +36,7 @@ export const altKeyOnly = function(mapBrowserEvent) { * Return `true` if only the alt-key and shift-key is pressed, `false` otherwise * (e.g. when additionally the platform-modifier-key is pressed). * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt and shift keys are pressed. * @api */ @@ -53,7 +53,7 @@ export const altShiftKeysOnly = function(mapBrowserEvent) { * Return `true` if the map has the focus. This condition requires a map target * element with a `tabindex` attribute, e.g. `
`. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} event Map browser event. + * @param {module:ol/MapBrowserEvent} event Map browser event. * @return {boolean} The map has the focus. * @api */ @@ -65,7 +65,7 @@ export const focus = function(event) { /** * Return always true. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True. * @function * @api @@ -76,7 +76,7 @@ export const always = TRUE; /** * Return `true` if the event is a `click` event, `false` otherwise. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event is a map `click` event. * @api */ @@ -91,7 +91,7 @@ export const click = function(mapBrowserEvent) { * By definition, this includes left-click on windows/linux, and left-click * without the ctrl key on Macs. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} The result. */ export const mouseActionButton = function(mapBrowserEvent) { @@ -104,7 +104,7 @@ export const mouseActionButton = function(mapBrowserEvent) { /** * Return always false. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} False. * @function * @api @@ -116,7 +116,7 @@ export const never = FALSE; * Return `true` if the browser event is a `pointermove` event, `false` * otherwise. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the browser event is a `pointermove` event. * @api */ @@ -128,7 +128,7 @@ export const pointerMove = function(mapBrowserEvent) { /** * Return `true` if the event is a map `singleclick` event, `false` otherwise. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event is a map `singleclick` event. * @api */ @@ -140,7 +140,7 @@ export const singleClick = function(mapBrowserEvent) { /** * Return `true` if the event is a map `dblclick` event, `false` otherwise. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event is a map `dblclick` event. * @api */ @@ -153,7 +153,7 @@ export const doubleClick = function(mapBrowserEvent) { * Return `true` if no modifier key (alt-, shift- or platform-modifier-key) is * pressed. * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True only if there no modifier keys are pressed. * @api */ @@ -171,7 +171,7 @@ export const noModifierKeys = function(mapBrowserEvent) { * ctrl-key otherwise) is pressed, `false` otherwise (e.g. when additionally * the shift-key is pressed). * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the platform modifier key is pressed. * @api */ @@ -187,7 +187,7 @@ export const platformModifierKeyOnly = function(mapBrowserEvent) { * Return `true` if only the shift-key is pressed, `false` otherwise (e.g. when * additionally the alt-key is pressed). * - * @param {module:ol/MapBrowserEvent~MapBrowserEvent} mapBrowserEvent Map browser event. + * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the shift key is pressed. * @api */ @@ -204,7 +204,7 @@ export const shiftKeyOnly = function(mapBrowserEvent) { * Return `true` if the target element is not editable, i.e. not a ``-, * `