ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #8123 from fredj/jsdoc_module

Browse Source 
More Jsdoc module fixes
This commit is contained in:
Frédéric Junod
2018-04-27 08:21:08 +02:00
committed by GitHub
parent ad45f7294c 61067e6c2c
commit da72a7cebc
31 changed files with 124 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ol/PluggableMap.js
View File

@@ -336,7 +336,7 @@ const PluggableMap = function(options) {
this.overlayIdIndex_ = {};
/**
* @type {module:ol/renderer/Map~Map}
* @type {module:ol/renderer/Map}
* @private
*/
this.renderer_ = this.createRenderer(this.viewport_, this);
@@ -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.<module:ol/Feature|module:ol/render/Feature~Feature>} The detected features or
* @return {Array.<module:ol/Feature|module:ol/render/Feature>} The detected features or
* `null` if none were found.
* @api
*/
@@ -831,7 +831,7 @@ PluggableMap.prototype.getPixelFromCoordinate = function(coordinate) {
/**
* Get the map renderer.
* @return {module:ol/renderer/Map~Map} Renderer
* @return {module:ol/renderer/Map} Renderer
*/
PluggableMap.prototype.getRenderer = function() {
return this.renderer_;

2
src/ol/VectorTile.js
View File

@@ -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.<module:ol/Feature|module:ol/render/Feature~Feature>} Features.
* @return {Array.<module:ol/Feature|module:ol/render/Feature>} Features.
* @api
*/
VectorTile.prototype.getFeatures = function() {

12
src/ol/interaction/Select.js
View File

@@ -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) {

6
src/ol/render.js
View File

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

2
src/ol/render/canvas.js
View File

@@ -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 ol.structs.LRUCache#setSize}.
* @type {ol.structs.LRUCache.<HTMLCanvasElement>}
* @type {module:ol/structs/LRUCache.<HTMLCanvasElement>}
* @api
*/
export const labelCache = new LRUCache();

50
src/ol/render/webgl/PolygonReplay.js
View File

@@ -150,8 +150,8 @@ WebGLPolygonReplay.prototype.drawCoordinates_ = function(
* @private
* @param {Array.<number>} flatCoordinates Flat coordinates.
* @param {number} stride Stride.
* @param {ol.structs.LinkedList} list Linked list.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @param {boolean} clockwise Coordinate order should be clockwise.
*/
WebGLPolygonReplay.prototype.processFlatCoordinates_ = function(
@@ -203,7 +203,7 @@ WebGLPolygonReplay.prototype.processFlatCoordinates_ = function(
/**
* Returns the rightmost coordinates of a polygon on the X axis.
* @private
* @param {ol.structs.LinkedList} list Polygons ring.
* @param {module:ol/structs/LinkedList} list Polygons ring.
* @return {Array.<number>} Max X coordinates.
*/
WebGLPolygonReplay.prototype.getMaxCoords_ = function(list) {
@@ -225,8 +225,8 @@ WebGLPolygonReplay.prototype.getMaxCoords_ = function(list) {
/**
* Classifies the points of a polygon list as convex, reflex. Removes collinear vertices.
* @private
* @param {ol.structs.LinkedList} list Polygon ring.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Polygon ring.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @param {boolean} ccw The orientation of the polygon is counter-clockwise.
* @return {boolean} There were reclassified points.
*/
@@ -261,11 +261,11 @@ WebGLPolygonReplay.prototype.classifyPoints_ = function(list, rtree, ccw) {
/**
* @private
* @param {ol.structs.LinkedList} hole Linked list of the hole.
* @param {module:ol/structs/LinkedList} hole Linked list of the hole.
* @param {number} holeMaxX Maximum X value of the hole.
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @param {number} listMaxX Maximum X value of the polygon.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @return {boolean} Bridging was successful.
*/
WebGLPolygonReplay.prototype.bridgeHole_ = function(hole, holeMaxX,
@@ -338,8 +338,8 @@ WebGLPolygonReplay.prototype.bridgeHole_ = function(hole, holeMaxX,
/**
* @private
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
*/
WebGLPolygonReplay.prototype.triangulate_ = function(list, rtree) {
let ccw = false;
@@ -388,8 +388,8 @@ WebGLPolygonReplay.prototype.triangulate_ = function(list, rtree) {
/**
* @private
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @param {boolean} simple The polygon is simple.
* @param {boolean} ccw Orientation of the polygon is counter-clockwise.
* @return {boolean} There were processed ears.
@@ -447,8 +447,8 @@ WebGLPolygonReplay.prototype.clipEars_ = function(list, rtree, simple, ccw) {
/**
* @private
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @param {boolean=} opt_touch Resolve touching segments.
* @return {boolean} There were resolved intersections.
*/
@@ -516,8 +516,8 @@ WebGLPolygonReplay.prototype.resolveSelfIntersections_ = function(
/**
* @private
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @return {boolean} The polygon is simple.
*/
WebGLPolygonReplay.prototype.isSimple_ = function(list, rtree) {
@@ -535,7 +535,7 @@ WebGLPolygonReplay.prototype.isSimple_ = function(list, rtree) {
/**
* @private
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @return {boolean} Orientation is clockwise.
*/
WebGLPolygonReplay.prototype.isClockwise_ = function(list) {
@@ -555,8 +555,8 @@ WebGLPolygonReplay.prototype.isClockwise_ = function(list) {
/**
* @private
* @param {ol.structs.LinkedList} list Linked list of the polygon.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Linked list of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
*/
WebGLPolygonReplay.prototype.splitPolygon_ = function(list, rtree) {
const start = list.firstItem();
@@ -623,8 +623,8 @@ WebGLPolygonReplay.prototype.createPoint_ = function(x, y, i) {
* @private
* @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p0 First point of segment.
* @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p1 Second point of segment.
* @param {ol.structs.LinkedList} list Polygon ring.
* @param {ol.structs.RBush=} opt_rtree Insert the segment into the R-Tree.
* @param {module:ol/structs/LinkedList} list Polygon ring.
* @param {module:ol/structs/RBush=} opt_rtree Insert the segment into the R-Tree.
* @return {module:ol/render/webgl/PolygonReplay~PolygonSegment} segment.
*/
WebGLPolygonReplay.prototype.insertItem_ = function(p0, p1, list, opt_rtree) {
@@ -645,8 +645,8 @@ WebGLPolygonReplay.prototype.insertItem_ = function(p0, p1, list, opt_rtree) {
* @private
* @param {module:ol/render/webgl/PolygonReplay~PolygonSegment} s0 Segment before the remove candidate.
* @param {module:ol/render/webgl/PolygonReplay~PolygonSegment} s1 Remove candidate segment.
* @param {ol.structs.LinkedList} list Polygon ring.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/LinkedList} list Polygon ring.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
*/
WebGLPolygonReplay.prototype.removeItem_ = function(s0, s1, list, rtree) {
if (list.getCurrItem() === s1) {
@@ -664,7 +664,7 @@ WebGLPolygonReplay.prototype.removeItem_ = function(s0, s1, list, rtree) {
* @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p0 First point.
* @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p1 Second point.
* @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p2 Third point.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @param {boolean=} opt_reflex Only include reflex points.
* @return {Array.<module:ol/render/webgl/PolygonReplay~PolygonVertex>} Points in the triangle.
*/
@@ -692,7 +692,7 @@ WebGLPolygonReplay.prototype.getPointsInTriangle_ = function(p0, p1, p2, rtree,
/**
* @private
* @param {module:ol/render/webgl/PolygonReplay~PolygonSegment} segment Segment.
* @param {ol.structs.RBush} rtree R-Tree of the polygon.
* @param {module:ol/structs/RBush} rtree R-Tree of the polygon.
* @param {boolean=} opt_touch Touching segments should be considered an intersection.
* @return {Array.<module:ol/render/webgl/PolygonReplay~PolygonSegment>} Intersecting segments.
*/

10
src/ol/renderer/Map.js
View File

@@ -30,7 +30,7 @@ const MapRenderer = function(map) {
/**
* @private
* @type {!Object.<string, ol.renderer.Layer>}
* @type {!Object.<string, module:ol/renderer/Layer>}
*/
this.layerRenderers_ = {};
@@ -219,7 +219,7 @@ MapRenderer.prototype.hasFeatureAtCoordinate = function(coordinate, frameState,
/**
* @param {module:ol/layer/Layer} layer Layer.
* @protected
* @return {ol.renderer.Layer} Layer renderer.
* @return {module:ol/renderer/Layer} Layer renderer.
*/
MapRenderer.prototype.getLayerRenderer = function(layer) {
const layerKey = getUid(layer).toString();
@@ -249,7 +249,7 @@ MapRenderer.prototype.getLayerRenderer = function(layer) {
/**
* @param {string} layerKey Layer key.
* @protected
* @return {ol.renderer.Layer} Layer renderer.
* @return {module:ol/renderer/Layer} Layer renderer.
*/
MapRenderer.prototype.getLayerRendererByKey = function(layerKey) {
return this.layerRenderers_[layerKey];
@@ -258,7 +258,7 @@ MapRenderer.prototype.getLayerRendererByKey = function(layerKey) {
/**
* @protected
* @return {Object.<string, ol.renderer.Layer>} Layer renderers.
* @return {Object.<string, module:ol/renderer/Layer>} Layer renderers.
*/
MapRenderer.prototype.getLayerRenderers = function() {
return this.layerRenderers_;
@@ -284,7 +284,7 @@ MapRenderer.prototype.handleLayerRendererChange_ = function() {
/**
* @param {string} layerKey Layer key.
* @return {ol.renderer.Layer} Layer renderer.
* @return {module:ol/renderer/Layer} Layer renderer.
* @private
*/
MapRenderer.prototype.removeLayerRendererByKey_ = function(layerKey) {

10
src/ol/renderer/canvas/ImageLayer.js
View File

@@ -15,7 +15,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran
/**
* @constructor
* @extends {ol.renderer.canvas.IntermediateCanvas}
* @extends {module:ol/renderer/canvas/IntermediateCanvas}
* @param {module:ol/layer/Image} imageLayer Single image layer.
* @api
*/
@@ -42,7 +42,7 @@ const CanvasImageLayerRenderer = function(imageLayer) {
/**
* @private
* @type {ol.renderer.canvas.VectorLayer}
* @type {module:ol/renderer/canvas/VectorLayer}
*/
this.vectorRenderer_ = null;
@@ -65,9 +65,9 @@ CanvasImageLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.ImageLayer} The layer renderer.
* @return {module:ol/renderer/canvas/ImageLayer} The layer renderer.
*/
CanvasImageLayerRenderer['create'] = function(mapRenderer, layer) {
const renderer = new CanvasImageLayerRenderer(/** @type {module:ol/layer/Image} */ (layer));
@@ -216,7 +216,7 @@ CanvasImageLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordin
/**
* @param {ol.renderer.canvas.VectorLayer} renderer Vector renderer.
* @param {module:ol/renderer/canvas/VectorLayer} renderer Vector renderer.
*/
CanvasImageLayerRenderer.prototype.setVectorRenderer = function(renderer) {
if (this.vectorRenderer_) {

2
src/ol/renderer/canvas/IntermediateCanvas.js
View File

@@ -12,7 +12,7 @@ import {create as createTransform, apply as applyTransform} from '../../transfor
/**
* @constructor
* @abstract
* @extends {ol.renderer.canvas.Layer}
* @extends {module:ol/renderer/canvas/Layer}
* @param {module:ol/layer/Layer} layer Layer.
*/
const IntermediateCanvasRenderer = function(layer) {

2
src/ol/renderer/canvas/Layer.js
View File

@@ -14,7 +14,7 @@ import {create as createTransform, apply as applyTransform, compose as composeTr
/**
* @constructor
* @abstract
* @extends {ol.renderer.Layer}
* @extends {module:ol/renderer/Layer}
* @param {module:ol/layer/Layer} layer Layer.
*/
const CanvasLayerRenderer = function(layer) {

6
src/ol/renderer/canvas/Map.js
View File

@@ -16,7 +16,7 @@ import SourceState from '../../source/State.js';
/**
* @constructor
* @extends {ol.renderer.Map}
* @extends {module:ol/renderer/Map}
* @param {module:ol/PluggableMap} map Map.
* @api
*/
@@ -146,7 +146,7 @@ CanvasMapRenderer.prototype.renderFrame = function(frameState) {
for (i = 0, ii = layerStatesArray.length; i < ii; ++i) {
layerState = layerStatesArray[i];
layer = layerState.layer;
layerRenderer = /** @type {ol.renderer.canvas.Layer} */ (this.getLayerRenderer(layer));
layerRenderer = /** @type {module:ol/renderer/canvas/Layer} */ (this.getLayerRenderer(layer));
if (!visibleAtResolution(layerState, viewResolution) ||
layerState.sourceState != SourceState.READY) {
continue;
@@ -192,7 +192,7 @@ CanvasMapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, ca
const layerState = layerStates[i];
const layer = layerState.layer;
if (visibleAtResolution(layerState, viewResolution) && layerFilter.call(thisArg2, layer)) {
const layerRenderer = /** @type {ol.renderer.canvas.Layer} */ (this.getLayerRenderer(layer));
const layerRenderer = /** @type {module:ol/renderer/canvas/Layer} */ (this.getLayerRenderer(layer));
result = layerRenderer.forEachLayerAtCoordinate(
coordinate, frameState, callback, thisArg);
if (result) {

6
src/ol/renderer/canvas/TileLayer.js
View File

@@ -13,7 +13,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran
/**
* @constructor
* @extends {ol.renderer.canvas.IntermediateCanvas}
* @extends {module:ol/renderer/canvas/IntermediateCanvas}
* @param {module:ol/layer/Tile|module:ol/layer/VectorTile~VectorTile} tileLayer Tile layer.
* @api
*/
@@ -92,9 +92,9 @@ CanvasTileLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.TileLayer} The layer renderer.
* @return {module:ol/renderer/canvas/TileLayer} The layer renderer.
*/
CanvasTileLayerRenderer['create'] = function(mapRenderer, layer) {
return new CanvasTileLayerRenderer(/** @type {module:ol/layer/Tile} */ (layer));

8
src/ol/renderer/canvas/VectorLayer.js
View File

@@ -17,7 +17,7 @@ import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance,
/**
* @constructor
* @extends {ol.renderer.canvas.Layer}
* @extends {module:ol/renderer/canvas/Layer}
* @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/
@@ -97,9 +97,9 @@ CanvasVectorLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.VectorLayer} The layer renderer.
* @return {module:ol/renderer/canvas/VectorLayer} The layer renderer.
*/
CanvasVectorLayerRenderer['create'] = function(mapRenderer, layer) {
return new CanvasVectorLayerRenderer(/** @type {module:ol/layer/Vector} */ (layer));
@@ -357,7 +357,7 @@ CanvasVectorLayerRenderer.prototype.prepareFrame = function(frameState, layerSta
vectorSource.loadFeatures(extent, resolution, projection);
/**
* @param {module:ol/Feature} feature Feature.
* @this {ol.renderer.canvas.VectorLayer}
* @this {module:ol/renderer/canvas/VectorLayer}
*/
const render = function(feature) {
let styles;

8
src/ol/renderer/canvas/VectorTileLayer.js
View File

@@ -49,7 +49,7 @@ const VECTOR_REPLAYS = {
/**
* @constructor
* @extends {ol.renderer.canvas.TileLayer}
* @extends {module:ol/renderer/canvas/TileLayer}
* @param {module:ol/layer/VectorTile~VectorTile} layer VectorTile layer.
* @api
*/
@@ -108,9 +108,9 @@ CanvasVectorTileLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.VectorTileLayer} The layer renderer.
* @return {module:ol/renderer/canvas/VectorTileLayer} The layer renderer.
*/
CanvasVectorTileLayerRenderer['create'] = function(mapRenderer, layer) {
return new CanvasVectorTileLayerRenderer(/** @type {module:ol/layer/VectorTile~VectorTile} */ (layer));
@@ -196,7 +196,7 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @this {ol.renderer.canvas.VectorTileLayer}
* @this {module:ol/renderer/canvas/VectorTileLayer}
*/
const render = function(feature) {
let styles;

10
src/ol/renderer/webgl/ImageLayer.js
View File

@@ -24,8 +24,8 @@ import {createTexture} from '../../webgl/Context.js';
/**
* @constructor
* @extends {ol.renderer.webgl.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/webgl/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Image} imageLayer Tile layer.
* @api
*/
@@ -69,13 +69,13 @@ WebGLImageLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.webgl.ImageLayer} The layer renderer.
* @return {module:ol/renderer/webgl/ImageLayer} The layer renderer.
*/
WebGLImageLayerRenderer['create'] = function(mapRenderer, layer) {
return new WebGLImageLayerRenderer(
/** @type {ol.renderer.webgl.Map} */ (mapRenderer),
/** @type {module:ol/renderer/webgl/Map} */ (mapRenderer),
/** @type {module:ol/layer/Image} */ (layer)
);
};

8
src/ol/renderer/webgl/Layer.js
View File

@@ -18,8 +18,8 @@ import {createEmptyTexture} from '../../webgl/Context.js';
/**
* @constructor
* @abstract
* @extends {ol.renderer.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Layer} layer Layer.
*/
const WebGLLayerRenderer = function(mapRenderer, layer) {
@@ -28,7 +28,7 @@ const WebGLLayerRenderer = function(mapRenderer, layer) {
/**
* @protected
* @type {ol.renderer.webgl.Map}
* @type {module:ol/renderer/webgl/Map}
*/
this.mapRenderer = mapRenderer;
@@ -81,7 +81,7 @@ const WebGLLayerRenderer = function(mapRenderer, layer) {
/**
* @private
* @type {ol.renderer.webgl.defaultmapshader.Locations}
* @type {module:ol/renderer/webgl/defaultmapshader/Locations}
*/
this.defaultLocations_ = null;

20
src/ol/renderer/webgl/Map.js
View File

@@ -40,7 +40,7 @@ const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024;
/**
* @constructor
* @extends {ol.renderer.Map}
* @extends {module:ol/renderer/Map}
* @param {module:ol/PluggableMap} map Map.
* @api
*/
@@ -110,7 +110,7 @@ const WebGLMapRenderer = function(map) {
/**
* @private
* @type {ol.structs.LRUCache.<module:ol/renderer/webgl/Map~TextureCacheEntry|null>}
* @type {module:ol/structs/LRUCache.<module:ol/renderer/webgl/Map~TextureCacheEntry|null>}
*/
this.textureCache_ = new LRUCache();
@@ -122,13 +122,13 @@ const WebGLMapRenderer = function(map) {
/**
* @private
* @type {ol.structs.PriorityQueue.<Array>}
* @type {module:ol/structs/PriorityQueue.<Array>}
*/
this.tileTextureQueue_ = new PriorityQueue(
/**
* @param {Array.<*>} element Element.
* @return {number} Priority.
* @this {ol.renderer.webgl.Map}
* @this {module:ol/renderer/webgl/Map}
*/
function(element) {
const tileCenter = /** @type {module:ol/coordinate~Coordinate} */ (element[1]);
@@ -153,7 +153,7 @@ const WebGLMapRenderer = function(map) {
* @param {module:ol/PluggableMap} map Map.
* @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
* @return {boolean} false.
* @this {ol.renderer.webgl.Map}
* @this {module:ol/renderer/webgl/Map}
*/
this.loadNextTileTexture_ =
function(map, frameState) {
@@ -339,7 +339,7 @@ WebGLMapRenderer.prototype.getGL = function() {
/**
* @return {ol.structs.PriorityQueue.<Array>} Tile texture queue.
* @return {module:ol/structs/PriorityQueue.<Array>} Tile texture queue.
*/
WebGLMapRenderer.prototype.getTileTextureQueue = function() {
return this.tileTextureQueue_;
@@ -357,7 +357,7 @@ WebGLMapRenderer.prototype.handleWebGLContextLost = function(event) {
const renderers = this.getLayerRenderers();
for (const id in renderers) {
const renderer = /** @type {ol.renderer.webgl.Layer} */ (renderers[id]);
const renderer = /** @type {module:ol/renderer/webgl/Layer} */ (renderers[id]);
renderer.handleWebGLContextLost();
}
};
@@ -435,7 +435,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) {
layerState = layerStatesArray[i];
if (visibleAtResolution(layerState, viewResolution) &&
layerState.sourceState == SourceState.READY) {
layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layerState.layer));
layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layerState.layer));
if (layerRenderer.prepareFrame(frameState, layerState, context)) {
layerStatesToDraw.push(layerState);
}
@@ -458,7 +458,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) {
for (i = 0, ii = layerStatesToDraw.length; i < ii; ++i) {
layerState = layerStatesToDraw[i];
layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layerState.layer));
layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layerState.layer));
layerRenderer.composeFrame(frameState, layerState, context);
}
@@ -574,7 +574,7 @@ WebGLMapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, cal
const layer = layerState.layer;
if (visibleAtResolution(layerState, viewState.resolution) &&
layerFilter.call(thisArg, layer)) {
const layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layer));
const layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layer));
result = layerRenderer.forEachLayerAtPixel(
pixel, frameState, callback, thisArg);
if (result) {

12
src/ol/renderer/webgl/TileLayer.js
View File

@@ -27,8 +27,8 @@ import WebGLBuffer from '../../webgl/Buffer.js';
/**
* @constructor
* @extends {ol.renderer.webgl.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/webgl/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Tile} tileLayer Tile layer.
* @api
*/
@@ -50,7 +50,7 @@ const WebGLTileLayerRenderer = function(mapRenderer, tileLayer) {
/**
* @private
* @type {ol.renderer.webgl.tilelayershader.Locations}
* @type {module:ol/renderer/webgl/tilelayershader/Locations}
*/
this.locations_ = null;
@@ -106,13 +106,13 @@ WebGLTileLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.webgl.TileLayer} The layer renderer.
* @return {module:ol/renderer/webgl/TileLayer} The layer renderer.
*/
WebGLTileLayerRenderer['create'] = function(mapRenderer, layer) {
return new WebGLTileLayerRenderer(
/** @type {ol.renderer.webgl.Map} */ (mapRenderer),
/** @type {module:ol/renderer/webgl/Map} */ (mapRenderer),
/** @type {module:ol/layer/Tile} */ (layer)
);
};

12
src/ol/renderer/webgl/VectorLayer.js
View File

@@ -12,8 +12,8 @@ import {apply as applyTransform} from '../../transform.js';
/**
* @constructor
* @extends {ol.renderer.webgl.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/webgl/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/
@@ -81,13 +81,13 @@ WebGLVectorLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.webgl.VectorLayer} The layer renderer.
* @return {module:ol/renderer/webgl/VectorLayer} The layer renderer.
*/
WebGLVectorLayerRenderer['create'] = function(mapRenderer, layer) {
return new WebGLVectorLayerRenderer(
/** @type {ol.renderer.webgl.Map} */ (mapRenderer),
/** @type {module:ol/renderer/webgl/Map} */ (mapRenderer),
/** @type {module:ol/layer/Vector} */ (layer)
);
};
@@ -260,7 +260,7 @@ WebGLVectorLayerRenderer.prototype.prepareFrame = function(frameState, layerStat
vectorSource.loadFeatures(extent, resolution, projection);
/**
* @param {module:ol/Feature} feature Feature.
* @this {ol.renderer.webgl.VectorLayer}
* @this {module:ol/renderer/webgl/VectorLayer}
*/
const render = function(feature) {
let styles;

2
src/ol/source/ImageArcGISRest.js
View File

@@ -46,7 +46,7 @@ import {appendParams} from '../uri.js';
*
* If underlying map service is not using labels,
* take advantage of ol image caching and use
* {@link ol.source.TileArcGISRest} data source.
* {@link module:ol/source/TileArcGISRest} data source.
*
* @constructor
* @fires ol.source.Image.Event

6
src/ol/source/ImageWMS.js
View File

@@ -26,7 +26,7 @@ import {appendParams} from '../uri.js';
* {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail.
* @property {boolean} [hidpi=true] Use the `ol.Map#pixelRatio` value when requesting
* the image from the remote server.
* @property {ol.source.WMSServerType|string} [serverType] The type of
* @property {module:ol/source/WMSServerType|string} [serverType] The type of
* the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only needed if `hidpi` is `true`.
* @property {ol.ImageLoadFunctionType} [imageLoadFunction] Optional function to load an image given a URL.
* @property {Object.<string,*>} params WMS request parameters.
@@ -98,9 +98,9 @@ const ImageWMS = function(opt_options) {
/**
* @private
* @type {ol.source.WMSServerType|undefined}
* @type {module:ol/source/WMSServerType|undefined}
*/
this.serverType_ = /** @type {ol.source.WMSServerType|undefined} */ (options.serverType);
this.serverType_ = /** @type {module:ol/source/WMSServerType|undefined} */ (options.serverType);
/**
* @private

14
src/ol/source/Raster.js
View File

@@ -156,7 +156,7 @@ const RasterSource = function(options) {
/**
* @private
* @type {Array.<ol.renderer.canvas.Layer>}
* @type {Array.<module:ol/renderer/canvas/Layer>}
*/
this.renderers_ = createRenderers(options.sources);
@@ -415,7 +415,7 @@ let sharedContext = null;
/**
* Get image data from a renderer.
* @param {ol.renderer.canvas.Layer} renderer Layer renderer.
* @param {module:ol/renderer/canvas/Layer} renderer Layer renderer.
* @param {module:ol/PluggableMap~FrameState} frameState The frame state.
* @param {module:ol/layer/Layer~State} layerState The layer state.
* @return {ImageData} The image data.
@@ -443,7 +443,7 @@ function getImageData(renderer, frameState, layerState) {
/**
* Get a list of layer states from a list of renderers.
* @param {Array.<ol.renderer.canvas.Layer>} renderers Layer renderers.
* @param {Array.<module:ol/renderer/canvas/Layer>} renderers Layer renderers.
* @return {Array.<module:ol/layer/Layer~State>} The layer states.
*/
function getLayerStatesArray(renderers) {
@@ -456,7 +456,7 @@ function getLayerStatesArray(renderers) {
/**
* Create renderers for all sources.
* @param {Array.<module:ol/source/Source>} sources The sources.
* @return {Array.<ol.renderer.canvas.Layer>} Array of layer renderers.
* @return {Array.<module:ol/renderer/canvas/Layer>} Array of layer renderers.
*/
function createRenderers(sources) {
const len = sources.length;
@@ -471,7 +471,7 @@ function createRenderers(sources) {
/**
* Create a renderer for the provided source.
* @param {module:ol/source/Source} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
* @return {module:ol/renderer/canvas/Layer} The renderer.
*/
function createRenderer(source) {
let renderer = null;
@@ -487,7 +487,7 @@ function createRenderer(source) {
/**
* Create an image renderer for the provided source.
* @param {module:ol/source/Image} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
* @return {module:ol/renderer/canvas/Layer} The renderer.
*/
function createImageRenderer(source) {
const layer = new ImageLayer({source: source});
@@ -498,7 +498,7 @@ function createImageRenderer(source) {
/**
* Create a tile renderer for the provided source.
* @param {module:ol/source/Tile} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
* @return {module:ol/renderer/canvas/Layer} The renderer.
*/
function createTileRenderer(source) {
const layer = new TileLayer({source: source});

2
src/ol/source/TileImage.js
View File

@@ -60,7 +60,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js';
*
* @constructor
* @fires module:ol/source/Tile~TileSourceEvent
* @extends {ol.source.UrlTile}
* @extends {module:ol/source/UrlTile}
* @param {module:ol/source/TileImage~Options=} options Image tile options.
* @api
*/

6
src/ol/source/TileWMS.js
View File

@@ -50,7 +50,7 @@ import {appendParams} from '../uri.js';
* If this is not defined, a default grid will be used: if there is a projection
* extent, the grid will be based on that; if not, a grid based on a global
* extent with origin at 0,0 will be used..
* @property {ol.source.WMSServerType|string} [serverType]
* @property {module:ol/source/WMSServerType|string} [serverType]
* The type of the remote WMS server. Currently only used when `hidpi` is
* `true`.
* @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is
@@ -124,9 +124,9 @@ const TileWMS = function(opt_options) {
/**
* @private
* @type {ol.source.WMSServerType|undefined}
* @type {module:ol/source/WMSServerType|undefined}
*/
this.serverType_ = /** @type {ol.source.WMSServerType|undefined} */ (options.serverType);
this.serverType_ = /** @type {module:ol/source/WMSServerType|undefined} */ (options.serverType);
/**
* @private

6
src/ol/source/Vector.js
View File

@@ -209,13 +209,13 @@ const VectorSource = function(opt_options) {
/**
* @private
* @type {ol.structs.RBush.<module:ol/Feature>}
* @type {module:ol/structs/RBush.<module:ol/Feature>}
*/
this.featuresRtree_ = useSpatialIndex ? new RBush() : null;
/**
* @private
* @type {ol.structs.RBush.<{extent: module:ol/extent~Extent}>}
* @type {module:ol/structs/RBush.<{extent: module:ol/extent~Extent}>}
*/
this.loadedExtentsRtree_ = new RBush();
@@ -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
*/

2
src/ol/source/VectorTile.js
View File

@@ -64,7 +64,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid.
*
* @constructor
* @fires module:ol/source/Tile~TileSourceEvent
* @extends {ol.source.UrlTile}
* @extends {module:ol/source/UrlTile}
* @param {module:ol/source/VectorTile~Options=} options Vector tile options.
* @api
*/

8
src/ol/source/WMTS.js
View File

@@ -24,7 +24,7 @@ import {appendParams} from '../uri.js';
* @property {module:ol/proj~ProjectionLike} projection Projection.
* @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision.
* @property {ol.source.WMTSRequestEncoding|string} [requestEncoding='KVP'] Request encoding.
* @property {module:ol/source/WMTSRequestEncoding|string} [requestEncoding='KVP'] Request encoding.
* @property {string} layer Layer name as advertised in the WMTS capabilities.
* @property {string} style Style name as advertised in the WMTS capabilities.
* @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. Default is {@link module:ol/ImageTile~ImageTile}.
@@ -115,10 +115,10 @@ const WMTS = function(options) {
/**
* @private
* @type {ol.source.WMTSRequestEncoding}
* @type {module:ol/source/WMTSRequestEncoding}
*/
this.requestEncoding_ = options.requestEncoding !== undefined ?
/** @type {ol.source.WMTSRequestEncoding} */ (options.requestEncoding) :
/** @type {module:ol/source/WMTSRequestEncoding} */ (options.requestEncoding) :
WMTSRequestEncoding.KVP;
const requestEncoding = this.requestEncoding_;
@@ -276,7 +276,7 @@ WMTS.prototype.getMatrixSet = function() {
/**
* Return the request encoding, either "KVP" or "REST".
* @return {ol.source.WMTSRequestEncoding} Request encoding.
* @return {module:ol/source/WMTSRequestEncoding} Request encoding.
* @api
*/
WMTS.prototype.getRequestEncoding = function() {

2
src/ol/structs/LRUCache.js
View File

@@ -95,7 +95,7 @@ LRUCache.prototype.containsKey = function(key) {
/**
* @param {function(this: S, T, string, ol.structs.LRUCache): ?} f The function
* @param {function(this: S, T, string, module:ol/structs/LRUCache): ?} f The function
* to call for every entry from the oldest to the newer. This function takes
* 3 arguments (the entry value, the entry key and the LRUCache object).
* The return value is ignored.

2
src/ol/structs/LinkedList.js
View File

@@ -225,7 +225,7 @@ LinkedList.prototype.setFirstItem = function() {
/**
* Concatenates two lists.
* @param {ol.structs.LinkedList} list List to merge into the current list.
* @param {module:ol/structs/LinkedList} list List to merge into the current list.
*/
LinkedList.prototype.concat = function(list) {
if (list.head_) {

2
src/ol/structs/RBush.js
View File

@@ -227,7 +227,7 @@ RBush.prototype.getExtent = function(opt_extent) {
/**
* @param {ol.structs.RBush} rbush R-Tree.
* @param {module:ol/structs/RBush} rbush R-Tree.
*/
RBush.prototype.concat = function(rbush) {
this.rbush_.load(rbush.rbush_.all());

2
src/ol/style.js
View File

@@ -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.<module:ol/style/Style>)} StyleFunction
* @api
*/