From b26e370b5b1b544ad1f005fe4b0a36f15364b5e5 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Mon, 19 Mar 2018 16:32:39 +0100 Subject: [PATCH] Module type for ol.Collection --- src/ol/control/Control.js | 2 +- src/ol/control/OverviewMap.js | 2 +- src/ol/layer/Group.js | 12 ++++++------ src/ol/source/Vector.js | 8 ++++---- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/ol/control/Control.js b/src/ol/control/Control.js index 5509ae7e74..f1ab4a614b 100644 --- a/src/ol/control/Control.js +++ b/src/ol/control/Control.js @@ -39,7 +39,7 @@ import {listen, unlistenByKey} from '../events.js'; * * The main advantage of having this as a control rather than a simple separate * DOM element is that preventing propagation is handled for you. Controls - * will also be objects in a `ol.Collection`, so you can use their methods. + * will also be objects in a {@link module:ol/Collection~Collection}, so you can use their methods. * * You can also extend this base for your own control class. See * examples/custom-controls for an example of how to do this. diff --git a/src/ol/control/OverviewMap.js b/src/ol/control/OverviewMap.js index 9e79f01dd9..11e9cd1de5 100644 --- a/src/ol/control/OverviewMap.js +++ b/src/ol/control/OverviewMap.js @@ -45,7 +45,7 @@ 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.|ol.Collection.} [layers] + * @property {Array.|module:ol/Collection~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 diff --git a/src/ol/layer/Group.js b/src/ol/layer/Group.js index 00b690e585..1f854eab46 100644 --- a/src/ol/layer/Group.js +++ b/src/ol/layer/Group.js @@ -26,7 +26,7 @@ const Property = { /** * @classdesc - * A {@link ol.Collection} of layers that are handled together. + * A {@link module:ol/Collection~Collection} of layers that are handled together. * * A generic `change` event is triggered when the group/Collection changes. * @@ -149,22 +149,22 @@ LayerGroup.prototype.handleLayersRemove_ = function(collectionEvent) { /** - * Returns the {@link ol.Collection collection} of {@link ol.layer.Layer layers} + * Returns the {@link module:ol/Collection~Collection collection} of {@link ol.layer.Layer layers} * in this group. - * @return {!ol.Collection.} Collection of + * @return {!module:ol/Collection~Collection.} Collection of * {@link ol.layer.Base layers} that are part of this group. * @observable * @api */ LayerGroup.prototype.getLayers = function() { - return /** @type {!ol.Collection.} */ (this.get(Property.LAYERS)); + return /** @type {!module:ol/Collection~Collection.} */ (this.get(Property.LAYERS)); }; /** - * Set the {@link ol.Collection collection} of {@link ol.layer.Layer layers} + * Set the {@link module:ol/Collection~Collection collection} of {@link ol.layer.Layer layers} * in this group. - * @param {!ol.Collection.} layers Collection of + * @param {!module:ol/Collection~Collection.} layers Collection of * {@link ol.layer.Base layers} that are part of this group. * @observable * @api diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index ca4d115dc9..ddb9b51ce5 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -152,7 +152,7 @@ const VectorSource = function(opt_options) { /** * @private - * @type {ol.Collection.} + * @type {module:ol/Collection~Collection.} */ this.featuresCollection_ = null; @@ -316,7 +316,7 @@ VectorSource.prototype.addFeaturesInternal = function(features) { /** - * @param {!ol.Collection.} collection Collection. + * @param {!module:ol/Collection~Collection.} collection Collection. * @private */ VectorSource.prototype.bindFeaturesCollection_ = function(collection) { @@ -509,8 +509,8 @@ 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 ol.Collection} as `features`. - * @return {ol.Collection.} The collection of features. + * with an {@link module:ol/Collection~Collection} as `features`. + * @return {module:ol/Collection~Collection.} The collection of features. * @api */ VectorSource.prototype.getFeaturesCollection = function() {