From 2eb07aa0819c7db4e7af31985d3516aa94105874 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Wed, 25 Jul 2018 18:37:08 -0700 Subject: [PATCH] Use Template instead of Template. --- src/ol/Collection.js | 2 +- src/ol/PluggableMap.js | 28 ++++++++++++++-------------- src/ol/control/OverviewMap.js | 2 +- src/ol/control/util.js | 2 +- src/ol/interaction.js | 2 +- src/ol/interaction/Draw.js | 4 ++-- src/ol/interaction/Modify.js | 10 +++++----- src/ol/interaction/Select.js | 4 ++-- src/ol/interaction/Snap.js | 10 +++++----- src/ol/interaction/Translate.js | 8 ++++---- src/ol/layer/Group.js | 8 ++++---- src/ol/render/canvas.js | 2 +- src/ol/renderer/webgl/Map.js | 6 +++--- src/ol/source/Vector.js | 12 ++++++------ 14 files changed, 50 insertions(+), 50 deletions(-) diff --git a/src/ol/Collection.js b/src/ol/Collection.js index 1bdf22478d..c4f11d298d 100644 --- a/src/ol/Collection.js +++ b/src/ol/Collection.js @@ -107,7 +107,7 @@ class Collection extends BaseObject { * 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.} This collection. + * @return {module:ol/Collection} This collection. * @api */ extend(arr) { diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 16162585d6..ffddf09188 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -74,10 +74,10 @@ import {create as createTransform, apply as applyTransform} from './transform.js /** * @typedef {Object} MapOptionsInternal - * @property {module:ol/Collection.} [controls] - * @property {module:ol/Collection.} [interactions] + * @property {module:ol/Collection} [controls] + * @property {module:ol/Collection} [interactions] * @property {HTMLElement|Document} keyboardEventTarget - * @property {module:ol/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.|Array} [controls] + * @property {module:ol/Collection|Array} [controls] * Controls initially added to the map. If not specified, * {@link module:ol/control/util~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.|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 {HTMLElement|Document|string} [keyboardEventTarget] The element to @@ -101,7 +101,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js * map target (i.e. the user-provided div for the map). If this is not * `document`, the target element needs to be focused for key events to be * emitted, requiring that the target element has a `tabindex` attribute. - * @property {Array|module:ol/Collection.} [layers] + * @property {Array|module:ol/Collection} [layers] * Layers. If this is not defined, a map with no layers will be rendered. Note * that layers are rendered in the order supplied, so if you want, for example, * a vector layer to appear on top of a tile layer, it must come after the tile @@ -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.|Array} [overlays] + * @property {module:ol/Collection|Array} [overlays] * Overlays initially added to the map. By default, no overlays are added. * @property {HTMLElement|string} [target] The container for the map, either the * element itself or the `id` of the element. If not specified at construction @@ -310,19 +310,19 @@ class PluggableMap extends BaseObject { listen(this.viewport_, EventType.MOUSEWHEEL, this.handleBrowserEvent, this); /** - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @protected */ this.controls = optionsInternal.controls || new Collection(); /** - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @protected */ this.interactions = optionsInternal.interactions || new Collection(); /** - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @private */ this.overlays_ = optionsInternal.overlays; @@ -716,7 +716,7 @@ class PluggableMap extends BaseObject { /** * Get the map controls. Modifying this collection changes the controls * associated with the map. - * @return {module:ol/Collection.} Controls. + * @return {module:ol/Collection} Controls. * @api */ getControls() { @@ -726,7 +726,7 @@ class PluggableMap extends BaseObject { /** * Get the map overlays. Modifying this collection changes the overlays * associated with the map. - * @return {module:ol/Collection.} Overlays. + * @return {module:ol/Collection} Overlays. * @api */ getOverlays() { @@ -751,7 +751,7 @@ class PluggableMap extends BaseObject { * associated with the map. * * Interactions are used for e.g. pan, zoom and rotate. - * @return {module:ol/Collection.} Interactions. + * @return {module:ol/Collection} Interactions. * @api */ getInteractions() { @@ -772,7 +772,7 @@ class PluggableMap extends BaseObject { /** * Get the collection of layers associated with this map. - * @return {!module:ol/Collection.} Layers. + * @return {!module:ol/Collection} Layers. * @api */ getLayers() { diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index b06b9079ce..dd5d69039e 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -44,7 +44,7 @@ const MIN_RATIO = 0.1; * @property {boolean} [collapsible=true] Whether the control can be collapsed or not. * @property {string|HTMLElement} [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.} [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)} [render] Function called when the control diff --git a/src/ol/control/util.js b/src/ol/control/util.js index 6f3a0f0aa4..6ca0477751 100644 --- a/src/ol/control/util.js +++ b/src/ol/control/util.js @@ -34,7 +34,7 @@ import Zoom from './Zoom.js'; * * @param {module:ol/control/util~DefaultsOptions=} opt_options * Defaults options. - * @return {module:ol/Collection.} + * @return {module:ol/Collection} * Controls. * @function module:ol/control.defaults * @api diff --git a/src/ol/interaction.js b/src/ol/interaction.js index e28c6a638b..d7be0bb234 100644 --- a/src/ol/interaction.js +++ b/src/ol/interaction.js @@ -77,7 +77,7 @@ export {default as Translate} from './interaction/Translate.js'; * * @param {module:ol/interaction/Interaction~DefaultsOptions=} opt_options * Defaults options. - * @return {module:ol/Collection.} + * @return {module:ol/Collection} * A collection of interactions to be used with the {@link module:ol/Map~Map} * constructor's `interactions` option. * @api diff --git a/src/ol/interaction/Draw.js b/src/ol/interaction/Draw.js index 85111f6322..b9fb7419f1 100644 --- a/src/ol/interaction/Draw.js +++ b/src/ol/interaction/Draw.js @@ -37,7 +37,7 @@ import {createEditingStyle} from '../style/Style.js'; * actually add a point/vertex to the geometry being drawn. The default of `6` * was chosen for the draw interaction to behave correctly on mouse as well as * on touch devices. - * @property {module:ol/Collection.} [features] + * @property {module:ol/Collection} [features] * Destination collection for the drawn features. * @property {module:ol/source/Vector} [source] Destination source for * the drawn features. @@ -208,7 +208,7 @@ class Draw extends PointerInteraction { /** * Target collection for drawn features. - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @private */ this.features_ = options.features ? options.features : null; diff --git a/src/ol/interaction/Modify.js b/src/ol/interaction/Modify.js index f953b2e0c8..37879f6298 100644 --- a/src/ol/interaction/Modify.js +++ b/src/ol/interaction/Modify.js @@ -93,7 +93,7 @@ const ModifyEventType = { * @property {module:ol/source/Vector} [source] The vector source with * features to modify. If a vector source is not provided, a feature collection * must be provided with the features option. - * @property {module:ol/Collection.} [features] + * @property {module:ol/Collection} [features] * The features the interaction works on. If a feature collection is not * provided, a vector source must be provided with the source option. * @property {boolean} [wrapX=false] Wrap the world horizontally on the sketch @@ -109,7 +109,7 @@ const ModifyEventType = { export class ModifyEvent extends Event { /** * @param {ModifyEventType} type Type. - * @param {module:ol/Collection.} features + * @param {module:ol/Collection} features * The features modified. * @param {module:ol/MapBrowserPointerEvent} mapBrowserPointerEvent * Associated {@link module:ol/MapBrowserPointerEvent}. @@ -119,7 +119,7 @@ export class ModifyEvent extends Event { /** * The features being modified. - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @api */ this.features = features; @@ -230,7 +230,7 @@ class Modify extends PointerInteraction { /** * Segment RTree for each layer - * @type {module:ol/structs/RBush.} + * @type {module:ol/structs/RBush} * @private */ this.rBush_ = new RBush(); @@ -318,7 +318,7 @@ class Modify extends PointerInteraction { } /** - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @private */ this.features_ = features; diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index 3cdf2a3430..4c123fa154 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -80,7 +80,7 @@ const SelectEventType = { * @property {boolean} [multi=false] A boolean that determines if the default * behaviour should select only single features or all (overlapping) features at * the clicked map position. The default of `false` means single select. - * @property {module:ol/Collection.} [features] + * @property {module:ol/Collection} [features] * Collection where the interaction will place selected features. Optional. If * not set the interaction will create a collection. In any case the collection * used by the interaction is returned by @@ -275,7 +275,7 @@ class Select extends Interaction { /** * Get the selected features. - * @return {module:ol/Collection.} Features collection. + * @return {module:ol/Collection} Features collection. * @api */ getFeatures() { diff --git a/src/ol/interaction/Snap.js b/src/ol/interaction/Snap.js index eac861a732..2d5c5d87ec 100644 --- a/src/ol/interaction/Snap.js +++ b/src/ol/interaction/Snap.js @@ -35,7 +35,7 @@ import RBush from '../structs/RBush.js'; /** * @typedef {Object} Options - * @property {module:ol/Collection.} [features] Snap to these features. Either this option or source should be provided. + * @property {module:ol/Collection} [features] Snap to these features. Either this option or source should be provided. * @property {boolean} [edge=true] Snap to edges. * @property {boolean} [vertex=true] Snap to vertices. * @property {number} [pixelTolerance=10] Pixel tolerance for considering the pointer close enough to a segment or @@ -99,7 +99,7 @@ class Snap extends PointerInteraction { this.edge_ = options.edge !== undefined ? options.edge : true; /** - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @private */ this.features_ = options.features ? options.features : null; @@ -156,7 +156,7 @@ class Snap extends PointerInteraction { /** * Segment RTree for each layer - * @type {module:ol/structs/RBush.} + * @type {module:ol/structs/RBush} * @private */ this.rBush_ = new RBush(); @@ -224,7 +224,7 @@ class Snap extends PointerInteraction { } /** - * @return {module:ol/Collection.|Array} Features. + * @return {module:ol/Collection|Array} Features. * @private */ getFeatures_() { @@ -235,7 +235,7 @@ class Snap extends PointerInteraction { features = this.source_.getFeatures(); } return ( - /** @type {!Array|!module:ol/Collection.} */ (features) + /** @type {!Array|!module:ol/Collection} */ (features) ); } diff --git a/src/ol/interaction/Translate.js b/src/ol/interaction/Translate.js index 64468cb0bb..7522180b17 100644 --- a/src/ol/interaction/Translate.js +++ b/src/ol/interaction/Translate.js @@ -38,7 +38,7 @@ const TranslateEventType = { /** * @typedef {Object} Options - * @property {module:ol/Collection.} [features] Only features contained in this collection will be able to be translated. If + * @property {module:ol/Collection} [features] Only features contained in this collection will be able to be translated. If * not specified, all features on the map will be able to be translated. * @property {Array|function(module:ol/layer/Layer): boolean} [layers] A list of layers from which features should be * translated. Alternatively, a filter function can be provided. The @@ -59,7 +59,7 @@ const TranslateEventType = { export class TranslateEvent extends Event { /** * @param {module:ol/interaction/Translate~TranslateEventType} type Type. - * @param {module:ol/Collection.} features The features translated. + * @param {module:ol/Collection} features The features translated. * @param {module:ol/coordinate~Coordinate} coordinate The event coordinate. */ constructor(type, features, coordinate) { @@ -68,7 +68,7 @@ export class TranslateEvent extends Event { /** * The features being translated. - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @api */ this.features = features; @@ -116,7 +116,7 @@ class Translate extends PointerInteraction { /** - * @type {module:ol/Collection.} + * @type {module:ol/Collection} * @private */ this.features_ = options.features !== undefined ? options.features : null; diff --git a/src/ol/layer/Group.js b/src/ol/layer/Group.js index af0d61eb6a..33afeb902c 100644 --- a/src/ol/layer/Group.js +++ b/src/ol/layer/Group.js @@ -27,7 +27,7 @@ import SourceState from '../source/State.js'; * visible. * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will * be visible. - * @property {Array|module:ol/Collection.} [layers] Child layers. + * @property {Array|module:ol/Collection} [layers] Child layers. */ @@ -161,21 +161,21 @@ class LayerGroup extends BaseLayer { /** * Returns the {@link module:ol/Collection collection} of {@link module:ol/layer/Layer~Layer layers} * in this group. - * @return {!module:ol/Collection.} Collection of + * @return {!module:ol/Collection} Collection of * {@link module:ol/layer/Base layers} that are part of this group. * @observable * @api */ getLayers() { return ( - /** @type {!module:ol/Collection.} */ (this.get(Property.LAYERS)) + /** @type {!module:ol/Collection} */ (this.get(Property.LAYERS)) ); } /** * Set the {@link module:ol/Collection collection} of {@link module:ol/layer/Layer~Layer layers} * in this group. - * @param {!module:ol/Collection.} layers Collection of + * @param {!module:ol/Collection} layers Collection of * {@link module:ol/layer/Base layers} that are part of this group. * @observable * @api diff --git a/src/ol/render/canvas.js b/src/ol/render/canvas.js index 9f01072668..55dc517279 100644 --- a/src/ol/render/canvas.js +++ b/src/ol/render/canvas.js @@ -156,7 +156,7 @@ export const defaultLineWidth = 1; /** * The label cache for text rendering. To change the default cache size of 2048 * entries, use {@link module:ol/structs/LRUCache#setSize}. - * @type {module:ol/structs/LRUCache.} + * @type {module:ol/structs/LRUCache} * @api */ export const labelCache = new LRUCache(); diff --git a/src/ol/renderer/webgl/Map.js b/src/ol/renderer/webgl/Map.js index 00f9f2968f..eddf98a8f7 100644 --- a/src/ol/renderer/webgl/Map.js +++ b/src/ol/renderer/webgl/Map.js @@ -113,7 +113,7 @@ class WebGLMapRenderer extends MapRenderer { /** * @private - * @type {module:ol/structs/LRUCache.} + * @type {module:ol/structs/LRUCache} */ this.textureCache_ = new LRUCache(); @@ -125,7 +125,7 @@ class WebGLMapRenderer extends MapRenderer { /** * @private - * @type {module:ol/structs/PriorityQueue.} + * @type {module:ol/structs/PriorityQueue} */ this.tileTextureQueue_ = new PriorityQueue( /** @@ -333,7 +333,7 @@ class WebGLMapRenderer extends MapRenderer { } /** - * @return {module:ol/structs/PriorityQueue.} Tile texture queue. + * @return {module:ol/structs/PriorityQueue} Tile texture queue. */ getTileTextureQueue() { return this.tileTextureQueue_; diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index bd6b3589b1..17f061c771 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -61,7 +61,7 @@ export class VectorSourceEvent extends Event { /** * @typedef {Object} Options * @property {module:ol/source/Source~AttributionLike} [attributions] Attributions. - * @property {Array|module:ol/Collection.} [features] + * @property {Array|module:ol/Collection} [features] * Features. If provided as {@link module:ol/Collection}, the features in the source * and the collection will stay in sync. * @property {module:ol/format/Feature} [format] The feature format used by the XHR @@ -215,13 +215,13 @@ class VectorSource extends Source { /** * @private - * @type {module:ol/structs/RBush.} + * @type {module:ol/structs/RBush} */ this.featuresRtree_ = useSpatialIndex ? new RBush() : null; /** * @private - * @type {module:ol/structs/RBush.<{extent: module:ol/extent~Extent}>} + * @type {module:ol/structs/RBush<{extent: module:ol/extent~Extent}>} */ this.loadedExtentsRtree_ = new RBush(); @@ -253,7 +253,7 @@ class VectorSource extends Source { /** * @private - * @type {module:ol/Collection.} + * @type {module:ol/Collection} */ this.featuresCollection_ = null; @@ -417,7 +417,7 @@ VectorSource.prototype.addFeaturesInternal = function(features) { /** - * @param {!module:ol/Collection.} collection Collection. + * @param {!module:ol/Collection} collection Collection. * @private */ VectorSource.prototype.bindFeaturesCollection_ = function(collection) { @@ -610,7 +610,7 @@ VectorSource.prototype.forEachFeatureIntersectingExtent = function(extent, callb * Get the features collection associated with this source. Will be `null` * unless the source was configured with `useSpatialIndex` set to `false`, or * with an {@link module:ol/Collection} as `features`. - * @return {module:ol/Collection.} The collection of features. + * @return {module:ol/Collection} The collection of features. * @api */ VectorSource.prototype.getFeaturesCollection = function() {