From 61067e6c2cd14cf4bd941267d6a9391618e06617 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Thu, 26 Apr 2018 15:26:15 +0200 Subject: [PATCH] Module type for ol.Feature and short notation for ol/render/Feature --- src/ol/PluggableMap.js | 4 ++-- src/ol/VectorTile.js | 2 +- src/ol/interaction/Select.js | 12 ++++++------ src/ol/render.js | 6 +++--- src/ol/renderer/canvas/VectorTileLayer.js | 2 +- src/ol/source/Vector.js | 2 +- src/ol/style.js | 2 +- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index e164eb096a..eba2e31907 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -555,7 +555,7 @@ 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|module:ol/render/Feature~Feature), + * @param {function(this: S, (module:ol/Feature|module:ol/render/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} or @@ -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 */ diff --git a/src/ol/VectorTile.js b/src/ol/VectorTile.js index 308d3ed9e6..119ddf49ac 100644 --- a/src/ol/VectorTile.js +++ b/src/ol/VectorTile.js @@ -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() { diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index e9a463fb23..05e8114649 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -34,7 +34,7 @@ const SelectEventType = { * {@link module:ol/render/Feature~Feature} and an * {@link module:ol/layer/Layer} and returns `true` if the feature may be * selected or `false` otherwise. - * @typedef {function((module:ol/Feature|module:ol/render/Feature~Feature), module:ol/layer/Layer): + * @typedef {function((module:ol/Feature|module:ol/render/Feature), module:ol/layer/Layer): * boolean} FilterFunction */ @@ -266,7 +266,7 @@ inherits(Select, Interaction); /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @param {module:ol/layer/Layer} layer Layer. * @private */ @@ -301,7 +301,7 @@ Select.prototype.getHitTolerance = function() { * the (last) selected feature. Note that this will not work with any * programmatic method like pushing features to * {@link module:ol/interaction/Select~Select#getFeatures collection}. - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature * @return {module:ol/layer/Vector~Vector} Layer. * @api */ @@ -340,7 +340,7 @@ function handleEvent(mapBrowserEvent) { map.forEachFeatureAtPixel(mapBrowserEvent.pixel, ( /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @param {module:ol/layer/Layer} layer Layer. * @return {boolean|undefined} Continue to iterate over the features. */ @@ -373,7 +373,7 @@ function handleEvent(mapBrowserEvent) { map.forEachFeatureAtPixel(mapBrowserEvent.pixel, ( /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @param {module:ol/layer/Layer} layer Layer. * @return {boolean|undefined} Continue to iterate over the features. */ @@ -482,7 +482,7 @@ Select.prototype.removeFeature_ = function(evt) { /** - * @param {module:ol/Feature|module:ol/render/Feature~Feature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @private */ Select.prototype.removeFeatureLayerAssociation_ = function(feature) { diff --git a/src/ol/render.js b/src/ol/render.js index 11f7e15e5d..89dc8e5b47 100644 --- a/src/ol/render.js +++ b/src/ol/render.js @@ -9,7 +9,7 @@ import CanvasImmediateRenderer from './render/canvas/Immediate.js'; /** * @typedef {Object} State * @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to. - * @property {module:ol/Feature|module:ol/render/Feature~Feature} feature + * @property {module:ol/Feature|module:ol/render/Feature} feature * @property {module:ol/geom/SimpleGeometry} geometry * @property {number} pixelRatio Pixel ratio used by the layer renderer. * @property {number} resolution Resolution that the render batch was created and optimized for. @@ -23,8 +23,8 @@ import CanvasImmediateRenderer from './render/canvas/Immediate.js'; * It takes two instances of {@link module:ol/Feature} or * {@link module:ol/render/Feature} and returns a `{number}`. * - * @typedef {function((module:ol/Feature|module:ol/render/Feature~Feature), - * (module:ol/Feature|module:ol/render/Feature~Feature)):number} OrderFunction + * @typedef {function((module:ol/Feature|module:ol/render/Feature), + * (module:ol/Feature|module:ol/render/Feature)):number} OrderFunction */ diff --git a/src/ol/renderer/canvas/VectorTileLayer.js b/src/ol/renderer/canvas/VectorTileLayer.js index 3980de6252..969f70c0ca 100644 --- a/src/ol/renderer/canvas/VectorTileLayer.js +++ b/src/ol/renderer/canvas/VectorTileLayer.js @@ -195,7 +195,7 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram const squaredTolerance = getSquaredRenderTolerance(resolution, pixelRatio); /** - * @param {module:ol/Feature|module:ol/render/Feature~RenderFeature} feature Feature. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. * @this {module:ol/renderer/canvas/VectorTileLayer} */ const render = function(feature) { diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 0f93342361..0618209e75 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -840,7 +840,7 @@ VectorSource.prototype.handleFeatureChange_ = function(event) { /** * Returns true if the feature is contained within the source. - * @param {ol.Feature} feature Feature. + * @param {module:ol/Feature} feature Feature. * @return {boolean} Has feature. * @api */ diff --git a/src/ol/style.js b/src/ol/style.js index 0817ab5323..1202946a81 100644 --- a/src/ol/style.js +++ b/src/ol/style.js @@ -9,7 +9,7 @@ * {@link module:ol/style/Style} or an array of them. This way e.g. a * vector layer can be styled. * - * @typedef {function((module:ol/Feature|module:ol/render/Feature~Feature), number): + * @typedef {function((module:ol/Feature|module:ol/render/Feature), number): * (module:ol/style/Style|Array.)} StyleFunction * @api */