Updated type annotations

This commit is contained in:
Tim Schaub
2018-05-07 15:50:56 -06:00
parent cfe88663aa
commit 8e7c88d9a5
24 changed files with 40 additions and 41 deletions
+1 -1
View File
@@ -21,7 +21,7 @@ const RenderEvent = function(
Event.call(this, type);
/**
* For canvas, this is an instance of {@link ol.render.canvas.Immediate}.
* For canvas, this is an instance of {@link module:ol/render/canvas/Immediate}.
* @type {module:ol/render/VectorContext|undefined}
* @api
*/
+2 -2
View File
@@ -64,7 +64,7 @@ import {create as createTransform} from '../transform.js';
* rendered extent of the group in pixel space. `count` is the number of styles
* in the group, i.e. 2 when an image and a text are grouped, or 1 otherwise.
* In addition to these four elements, declutter instruction arrays (i.e. the
* arguments to @{link ol.render.canvas.drawImage} are appended to the array.
* arguments to {@link module:ol/render/canvas~drawImage} are appended to the array.
* @typedef {Array.<*>} DeclutterGroup
*/
@@ -155,7 +155,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}.
* entries, use {@link module:ol/structs/LRUCache#setSize}.
* @type {module:ol/structs/LRUCache.<HTMLCanvasElement>}
* @api
*/
+2 -2
View File
@@ -3,7 +3,7 @@
*/
// FIXME test, especially polygons with holes and multipolygons
// FIXME need to handle large thick features (where pixel size matters)
// FIXME add offset and end to ol.geom.flat.transform.transform2D?
// FIXME add offset and end to ol/geom/flat/transform~transform2D?
import {inherits} from '../../index.js';
import {equals} from '../../array.js';
@@ -448,7 +448,7 @@ CanvasImmediateRenderer.prototype.setStyle = function(style) {
/**
* Render a geometry into the canvas. Call
* {@link ol.render.canvas.Immediate#setStyle} first to set the rendering style.
* {@link module:ol/render/canvas/Immediate#setStyle} first to set the rendering style.
*
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry The geometry to render.
* @override
+1 -1
View File
@@ -452,7 +452,7 @@ CanvasReplayGroup.prototype.isEmpty = function() {
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {Array.<module:ol/render/ReplayType~ReplayType>=} opt_replayTypes Ordered replay types to replay.
* Default is {@link ol.render.replay.ORDER}
* Default is {@link module:ol/render/replay~ORDER}
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>=} opt_declutterReplays Declutter replays.
*/
CanvasReplayGroup.prototype.replay = function(context,
+1 -1
View File
@@ -17,7 +17,7 @@ import WebGLBuffer from '../../webgl/Buffer.js';
/**
* @constructor
* @extends {ol.render.webgl.Replay}
* @extends {module:ol/render/webgl/Replay}
* @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
+1 -1
View File
@@ -88,7 +88,7 @@ inherits(WebGLImmediateRenderer, VectorContext);
/**
* @param {ol.render.webgl.ReplayGroup} replayGroup Replay group.
* @param {module:ol/render/webgl/ReplayGroup} replayGroup Replay group.
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
* @private
*/
+1 -1
View File
@@ -37,7 +37,7 @@ const Instruction = {
/**
* @constructor
* @extends {ol.render.webgl.Replay}
* @extends {module:ol/render/webgl/Replay}
* @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
+1 -1
View File
@@ -38,7 +38,7 @@ import WebGLBuffer from '../../webgl/Buffer.js';
/**
* @constructor
* @extends {ol.render.webgl.Replay}
* @extends {module:ol/render/webgl/Replay}
* @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
+2 -2
View File
@@ -20,7 +20,7 @@ const HIT_DETECTION_SIZE = [1, 1];
/**
* @type {Object.<module:ol/render/ReplayType~ReplayType,
* function(new: ol.render.webgl.Replay, number,
* function(new: module:ol/render/webgl/Replay, number,
* module:ol/extent~Extent)>}
*/
const BATCH_CONSTRUCTORS = {
@@ -64,7 +64,7 @@ const WebGLReplayGroup = function(tolerance, maxExtent, opt_renderBuffer) {
/**
* @private
* @type {!Object.<string,
* Object.<module:ol/render/ReplayType~ReplayType, ol.render.webgl.Replay>>}
* Object.<module:ol/render/ReplayType~ReplayType, module:ol/render/webgl/Replay>>}
*/
this.replaysByZIndex_ = {};
+1 -1
View File
@@ -13,7 +13,7 @@ import {createTexture} from '../../webgl/Context.js';
/**
* @constructor
* @abstract
* @extends {ol.render.webgl.Replay}
* @extends {module:ol/render/webgl/Replay}
* @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct