Merge pull request #8166 from tschaub/types

Updated type annotations

src/ol/render/Event.js

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

src/ol/render/canvas.js

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

src/ol/render/canvas/Immediate.js

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

src/ol/render/canvas/ReplayGroup.js

@@ -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,

src/ol/render/canvas/index.jsdoc

@@ -1,3 +0,0 @@
-/**
- * @namespace ol.render.canvas
- */

src/ol/render/webgl/CircleReplay.js

@@ -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
@@ -27,7 +27,7 @@ const WebGLCircleReplay = function(tolerance, maxExtent) {
 
   /**
    * @private
-   * @type {ol.render.webgl.circlereplay.defaultshader.Locations}
+   * @type {module:ol/render/webgl/circlereplay/defaultshader/Locations}
    */
   this.defaultLocations_ = null;
 

src/ol/render/webgl/ImageReplay.js

@@ -7,7 +7,7 @@ import WebGLBuffer from '../../webgl/Buffer.js';
 
 /**
  * @constructor
- * @extends {ol.render.webgl.TextureReplay}
+ * @extends {module:ol/render/webgl/TextureReplay}
  * @param {number} tolerance Tolerance.
  * @param {module:ol/extent~Extent} maxExtent Max extent.
  * @struct

src/ol/render/webgl/Immediate.js

@@ -88,13 +88,13 @@ 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
  */
 WebGLImmediateRenderer.prototype.drawText_ = function(replayGroup, geometry) {
   const context = this.context_;
-  const replay = /** @type {ol.render.webgl.TextReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/TextReplay} */ (
     replayGroup.getReplay(0, ReplayType.TEXT));
   replay.setTextStyle(this.textStyle_);
   replay.drawText(geometry, null);
@@ -128,7 +128,7 @@ WebGLImmediateRenderer.prototype.setStyle = function(style) {
 
 /**
  * Render a geometry into the canvas.  Call
- * {@link ol.render.webgl.Immediate#setStyle} first to set the rendering style.
+ * {@link ol/render/webgl/Immediate#setStyle} first to set the rendering style.
  *
  * @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry The geometry to render.
  * @override
@@ -199,7 +199,7 @@ WebGLImmediateRenderer.prototype.drawGeometryCollection = function(geometry, dat
 WebGLImmediateRenderer.prototype.drawPoint = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.ImageReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/ImageReplay} */ (
     replayGroup.getReplay(0, ReplayType.IMAGE));
   replay.setImageStyle(this.imageStyle_);
   replay.drawPoint(geometry, data);
@@ -226,7 +226,7 @@ WebGLImmediateRenderer.prototype.drawPoint = function(geometry, data) {
 WebGLImmediateRenderer.prototype.drawMultiPoint = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.ImageReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/ImageReplay} */ (
     replayGroup.getReplay(0, ReplayType.IMAGE));
   replay.setImageStyle(this.imageStyle_);
   replay.drawMultiPoint(geometry, data);
@@ -252,7 +252,7 @@ WebGLImmediateRenderer.prototype.drawMultiPoint = function(geometry, data) {
 WebGLImmediateRenderer.prototype.drawLineString = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.LineStringReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/LineStringReplay} */ (
     replayGroup.getReplay(0, ReplayType.LINE_STRING));
   replay.setFillStrokeStyle(null, this.strokeStyle_);
   replay.drawLineString(geometry, data);
@@ -278,7 +278,7 @@ WebGLImmediateRenderer.prototype.drawLineString = function(geometry, data) {
 WebGLImmediateRenderer.prototype.drawMultiLineString = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.LineStringReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/LineStringReplay} */ (
     replayGroup.getReplay(0, ReplayType.LINE_STRING));
   replay.setFillStrokeStyle(null, this.strokeStyle_);
   replay.drawMultiLineString(geometry, data);
@@ -304,7 +304,7 @@ WebGLImmediateRenderer.prototype.drawMultiLineString = function(geometry, data)
 WebGLImmediateRenderer.prototype.drawPolygon = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.PolygonReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/PolygonReplay} */ (
     replayGroup.getReplay(0, ReplayType.POLYGON));
   replay.setFillStrokeStyle(this.fillStyle_, this.strokeStyle_);
   replay.drawPolygon(geometry, data);
@@ -330,7 +330,7 @@ WebGLImmediateRenderer.prototype.drawPolygon = function(geometry, data) {
 WebGLImmediateRenderer.prototype.drawMultiPolygon = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.PolygonReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/PolygonReplay} */ (
     replayGroup.getReplay(0, ReplayType.POLYGON));
   replay.setFillStrokeStyle(this.fillStyle_, this.strokeStyle_);
   replay.drawMultiPolygon(geometry, data);
@@ -356,7 +356,7 @@ WebGLImmediateRenderer.prototype.drawMultiPolygon = function(geometry, data) {
 WebGLImmediateRenderer.prototype.drawCircle = function(geometry, data) {
   const context = this.context_;
   const replayGroup = new WebGLReplayGroup(1, this.extent_);
-  const replay = /** @type {ol.render.webgl.CircleReplay} */ (
+  const replay = /** @type {module:ol/render/webgl/CircleReplay} */ (
     replayGroup.getReplay(0, ReplayType.CIRCLE));
   replay.setFillStrokeStyle(this.fillStyle_, this.strokeStyle_);
   replay.drawCircle(geometry, data);

src/ol/render/webgl/LineStringReplay.js

@@ -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
@@ -47,7 +47,7 @@ const WebGLLineStringReplay = function(tolerance, maxExtent) {
 
   /**
    * @private
-   * @type {ol.render.webgl.linestringreplay.defaultshader.Locations}
+   * @type {module:ol/render/webgl/linestringreplay/defaultshader/Locations}
    */
   this.defaultLocations_ = null;
 

src/ol/render/webgl/PolygonReplay.js

@@ -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
@@ -51,7 +51,7 @@ const WebGLPolygonReplay = function(tolerance, maxExtent) {
 
   /**
    * @private
-   * @type {ol.render.webgl.polygonreplay.defaultshader.Locations}
+   * @type {module:ol/render/webgl/polygonreplay/defaultshader/Locations}
    */
   this.defaultLocations_ = null;
 

src/ol/render/webgl/Replay.js

@@ -114,7 +114,7 @@ const WebGLReplay = function(tolerance, maxExtent) {
   /**
    * Optional parameter for PolygonReplay instances.
    * @protected
-   * @type {ol.render.webgl.LineStringReplay|undefined}
+   * @type {module:ol/render/webgl/LineStringReplay|undefined}
    */
   this.lineStringReplay = undefined;
 
@@ -145,10 +145,10 @@ WebGLReplay.prototype.finish = function(context) {};
  * @param {module:ol/webgl/Context} context Context.
  * @param {module:ol/size~Size} size Size.
  * @param {number} pixelRatio Pixel ratio.
- * @return {ol.render.webgl.circlereplay.defaultshader.Locations|
-            ol.render.webgl.linestringreplay.defaultshader.Locations|
-            ol.render.webgl.polygonreplay.defaultshader.Locations|
-            ol.render.webgl.texturereplay.defaultshader.Locations} Locations.
+ * @return {module:ol/render/webgl/circlereplay/defaultshader/Locations|
+            module:ol/render/webgl/linestringreplay/defaultshader/Locations|
+            module:ol/render/webgl/polygonreplay/defaultshader/Locations|
+            module:ol/render/webgl/texturereplay/defaultshader/Locations} Locations.
  */
 WebGLReplay.prototype.setUpProgram = function(gl, context, size, pixelRatio) {};
 
@@ -157,10 +157,10 @@ WebGLReplay.prototype.setUpProgram = function(gl, context, size, pixelRatio) {};
  * @abstract
  * @protected
  * @param {WebGLRenderingContext} gl gl.
- * @param {ol.render.webgl.circlereplay.defaultshader.Locations|
-           ol.render.webgl.linestringreplay.defaultshader.Locations|
-           ol.render.webgl.polygonreplay.defaultshader.Locations|
-           ol.render.webgl.texturereplay.defaultshader.Locations} locations Locations.
+ * @param {module:ol/render/webgl/circlereplay/defaultshader/Locations|
+           module:ol/render/webgl/linestringreplay/defaultshader/Locations|
+           module:ol/render/webgl/polygonreplay/defaultshader/Locations|
+           module:ol/render/webgl/texturereplay/defaultshader/Locations} locations Locations.
  */
 WebGLReplay.prototype.shutDownProgram = function(gl, locations) {};
 

src/ol/render/webgl/ReplayGroup.js

@@ -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_ = {};
 

src/ol/render/webgl/TextReplay.js

@@ -24,7 +24,7 @@ import WebGLBuffer from '../../webgl/Buffer.js';
 
 /**
  * @constructor
- * @extends {ol.render.webgl.TextureReplay}
+ * @extends {module:ol/render/webgl/TextureReplay}
  * @param {number} tolerance Tolerance.
  * @param {module:ol/extent~Extent} maxExtent Max extent.
  * @struct

src/ol/render/webgl/TextureReplay.js

@@ -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
@@ -65,7 +65,7 @@ const WebGLTextureReplay = function(tolerance, maxExtent) {
 
   /**
    * @protected
-   * @type {ol.render.webgl.texturereplay.defaultshader.Locations}
+   * @type {module:ol/render/webgl/texturereplay/defaultshader/Locations}
    */
   this.defaultLocations = null;
 

src/ol/render/webgl/index.jsdoc

@@ -1,3 +0,0 @@
-/**
- * @namespace ol.render.webgl
- */