From a695ce86167e48763875399fcadfb735927218aa Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Thu, 26 Mar 2020 16:31:26 +0100 Subject: [PATCH] Remove all inheritDoc tags from src/ol/render --- src/ol/render/Box.js | 2 +- src/ol/render/VectorContext.js | 2 +- src/ol/render/canvas/Builder.js | 12 +++++++----- src/ol/render/canvas/ImageBuilder.js | 13 ++++++++----- src/ol/render/canvas/Immediate.js | 14 -------------- src/ol/render/canvas/LineStringBuilder.js | 12 +++++++----- src/ol/render/canvas/PolygonBuilder.js | 13 ++++++++----- src/ol/render/canvas/TextBuilder.js | 18 ++++++++++-------- 8 files changed, 42 insertions(+), 44 deletions(-) diff --git a/src/ol/render/Box.js b/src/ol/render/Box.js index 6b1f8c323e..3402b35857 100644 --- a/src/ol/render/Box.js +++ b/src/ol/render/Box.js @@ -47,7 +47,7 @@ class RenderBox extends Disposable { } /** - * @inheritDoc + * Clean up. */ disposeInternal() { this.setMap(null); diff --git a/src/ol/render/VectorContext.js b/src/ol/render/VectorContext.js index 838996200d..e00d586363 100644 --- a/src/ol/render/VectorContext.js +++ b/src/ol/render/VectorContext.js @@ -87,7 +87,7 @@ class VectorContext { drawPolygon(polygonGeometry, feature) {} /** - * @param {import("../geom/Geometry.js").default|import("./Feature.js").default} geometry Geometry. + * @param {import("../geom/SimpleGeometry.js").default|import("./Feature.js").default} geometry Geometry. * @param {import("../Feature.js").FeatureLike} feature Feature. */ drawText(geometry, feature) {} diff --git a/src/ol/render/canvas/Builder.js b/src/ol/render/canvas/Builder.js index ade18f1e61..f56abfe483 100644 --- a/src/ol/render/canvas/Builder.js +++ b/src/ol/render/canvas/Builder.js @@ -203,7 +203,9 @@ class CanvasBuilder extends VectorContext { } /** - * @inheritDoc. + * @param {import("../../geom/SimpleGeometry.js").default} geometry Geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. + * @param {Function} renderer Renderer. */ drawCustom(geometry, feature, renderer) { this.beginGeometry(geometry, feature); @@ -213,10 +215,9 @@ class CanvasBuilder extends VectorContext { let flatCoordinates, builderEnd, builderEnds, builderEndss; let offset; if (type == GeometryType.MULTI_POLYGON) { - geometry = /** @type {import("../../geom/MultiPolygon.js").default} */ (geometry); - flatCoordinates = geometry.getOrientedFlatCoordinates(); + flatCoordinates = /** @type {import("../../geom/MultiPolygon.js").default} */ (geometry).getOrientedFlatCoordinates(); builderEndss = []; - const endss = geometry.getEndss(); + const endss = /** @type {import("../../geom/MultiPolygon.js").default} */ (geometry).getEndss(); offset = 0; for (let i = 0, ii = endss.length; i < ii; ++i) { const myEnds = []; @@ -302,7 +303,8 @@ class CanvasBuilder extends VectorContext { } /** - * @inheritDoc + * @param {import("../../style/Fill.js").default} fillStyle Fill style. + * @param {import("../../style/Stroke.js").default} strokeStyle Stroke style. */ setFillStrokeStyle(fillStyle, strokeStyle) { const state = this.state; diff --git a/src/ol/render/canvas/ImageBuilder.js b/src/ol/render/canvas/ImageBuilder.js index f60304d577..dc217fd0b7 100644 --- a/src/ol/render/canvas/ImageBuilder.js +++ b/src/ol/render/canvas/ImageBuilder.js @@ -107,7 +107,8 @@ class CanvasImageBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/Point.js").default|import("../Feature.js").default} pointGeometry Point geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawPoint(pointGeometry, feature) { if (!this.image_) { @@ -136,7 +137,8 @@ class CanvasImageBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/MultiPoint.js").default|import("../Feature.js").default} multiPointGeometry MultiPoint geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawMultiPoint(multiPointGeometry, feature) { if (!this.image_) { @@ -166,7 +168,7 @@ class CanvasImageBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @return {import("./Builder.js").SerializableInstructions} the serializable instructions. */ finish() { this.reverseHitDetectionInstructions(); @@ -187,7 +189,8 @@ class CanvasImageBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../style/Image.js").default} imageStyle Image style. + * @param {import("../canvas.js").DeclutterGroup} declutterGroups Declutter. */ setImageStyle(imageStyle, declutterGroups) { const anchor = imageStyle.getAnchor(); @@ -197,7 +200,7 @@ class CanvasImageBuilder extends CanvasBuilder { const origin = imageStyle.getOrigin(); this.anchorX_ = anchor[0]; this.anchorY_ = anchor[1]; - this.declutterGroups_ = /** @type {import("../canvas.js").DeclutterGroups} */ (declutterGroups); + this.declutterGroups_ = declutterGroups; this.hitDetectionImage_ = hitDetectionImage; this.image_ = image; this.height_ = size[1]; diff --git a/src/ol/render/canvas/Immediate.js b/src/ol/render/canvas/Immediate.js index 4f16188299..13a2923115 100644 --- a/src/ol/render/canvas/Immediate.js +++ b/src/ol/render/canvas/Immediate.js @@ -390,7 +390,6 @@ class CanvasImmediateRenderer extends VectorContext { * the current fill and stroke styles. * * @param {import("../../geom/Circle.js").default} geometry Circle geometry. - * @override * @api */ drawCircle(geometry) { @@ -430,7 +429,6 @@ class CanvasImmediateRenderer extends VectorContext { * any `zIndex` on the provided style will be ignored. * * @param {import("../../style/Style.js").default} style The rendering style. - * @override * @api */ setStyle(style) { @@ -451,7 +449,6 @@ class CanvasImmediateRenderer extends VectorContext { * {@link module:ol/render/canvas/Immediate#setStyle} first to set the rendering style. * * @param {import("../../geom/Geometry.js").default|import("../Feature.js").default} geometry The geometry to render. - * @override * @api */ drawGeometry(geometry) { @@ -493,7 +490,6 @@ class CanvasImmediateRenderer extends VectorContext { * * @param {import("../../Feature.js").default} feature Feature. * @param {import("../../style/Style.js").default} style Style. - * @override * @api */ drawFeature(feature, style) { @@ -510,7 +506,6 @@ class CanvasImmediateRenderer extends VectorContext { * uses the current styles appropriate for each geometry in the collection. * * @param {import("../../geom/GeometryCollection.js").default} geometry Geometry collection. - * @override */ drawGeometryCollection(geometry) { const geometries = geometry.getGeometriesArray(); @@ -524,7 +519,6 @@ class CanvasImmediateRenderer extends VectorContext { * the current style. * * @param {import("../../geom/Point.js").default|import("../Feature.js").default} geometry Point geometry. - * @override */ drawPoint(geometry) { if (this.squaredTolerance_) { @@ -545,7 +539,6 @@ class CanvasImmediateRenderer extends VectorContext { * uses the current style. * * @param {import("../../geom/MultiPoint.js").default|import("../Feature.js").default} geometry MultiPoint geometry. - * @override */ drawMultiPoint(geometry) { if (this.squaredTolerance_) { @@ -566,7 +559,6 @@ class CanvasImmediateRenderer extends VectorContext { * the current style. * * @param {import("../../geom/LineString.js").default|import("../Feature.js").default} geometry LineString geometry. - * @override */ drawLineString(geometry) { if (this.squaredTolerance_) { @@ -595,7 +587,6 @@ class CanvasImmediateRenderer extends VectorContext { * and uses the current style. * * @param {import("../../geom/MultiLineString.js").default|import("../Feature.js").default} geometry MultiLineString geometry. - * @override */ drawMultiLineString(geometry) { if (this.squaredTolerance_) { @@ -629,7 +620,6 @@ class CanvasImmediateRenderer extends VectorContext { * the current style. * * @param {import("../../geom/Polygon.js").default|import("../Feature.js").default} geometry Polygon geometry. - * @override */ drawPolygon(geometry) { if (this.squaredTolerance_) { @@ -666,7 +656,6 @@ class CanvasImmediateRenderer extends VectorContext { * Render MultiPolygon geometry into the canvas. Rendering is immediate and * uses the current style. * @param {import("../../geom/MultiPolygon.js").default} geometry MultiPolygon geometry. - * @override */ drawMultiPolygon(geometry) { if (this.squaredTolerance_) { @@ -824,7 +813,6 @@ class CanvasImmediateRenderer extends VectorContext { * * @param {import("../../style/Fill.js").default} fillStyle Fill style. * @param {import("../../style/Stroke.js").default} strokeStyle Stroke style. - * @override */ setFillStrokeStyle(fillStyle, strokeStyle) { if (!fillStyle) { @@ -870,7 +858,6 @@ class CanvasImmediateRenderer extends VectorContext { * the image style. * * @param {import("../../style/Image.js").default} imageStyle Image style. - * @override */ setImageStyle(imageStyle) { if (!imageStyle) { @@ -900,7 +887,6 @@ class CanvasImmediateRenderer extends VectorContext { * remove the text style. * * @param {import("../../style/Text.js").default} textStyle Text style. - * @override */ setTextStyle(textStyle) { if (!textStyle) { diff --git a/src/ol/render/canvas/LineStringBuilder.js b/src/ol/render/canvas/LineStringBuilder.js index eedbc70b67..2d898ad9e1 100644 --- a/src/ol/render/canvas/LineStringBuilder.js +++ b/src/ol/render/canvas/LineStringBuilder.js @@ -34,7 +34,8 @@ class CanvasLineStringBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/LineString.js").default|import("../Feature.js").default} lineStringGeometry Line string geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawLineString(lineStringGeometry, feature) { const state = this.state; @@ -58,7 +59,8 @@ class CanvasLineStringBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/MultiLineString.js").default|import("../Feature.js").default} multiLineStringGeometry MultiLineString geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawMultiLineString(multiLineStringGeometry, feature) { const state = this.state; @@ -79,14 +81,14 @@ class CanvasLineStringBuilder extends CanvasBuilder { const stride = multiLineStringGeometry.getStride(); let offset = 0; for (let i = 0, ii = ends.length; i < ii; ++i) { - offset = this.drawFlatCoordinates_(flatCoordinates, offset, ends[i], stride); + offset = this.drawFlatCoordinates_(flatCoordinates, offset, /** @type {number} */ (ends[i]), stride); } this.hitDetectionInstructions.push(strokeInstruction); this.endGeometry(feature); } /** - * @inheritDoc + * @return {import("./Builder.js").SerializableInstructions} the serializable instructions. */ finish() { const state = this.state; @@ -99,7 +101,7 @@ class CanvasLineStringBuilder extends CanvasBuilder { } /** - * @inheritDoc. + * @param {import("../canvas.js").FillStrokeState} state State. */ applyStroke(state) { if (state.lastStroke != undefined && state.lastStroke != this.coordinates.length) { diff --git a/src/ol/render/canvas/PolygonBuilder.js b/src/ol/render/canvas/PolygonBuilder.js index 090ec6d1c7..6fa794fc55 100644 --- a/src/ol/render/canvas/PolygonBuilder.js +++ b/src/ol/render/canvas/PolygonBuilder.js @@ -62,7 +62,8 @@ class CanvasPolygonBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/Circle.js").default} circleGeometry Circle geometry. + * @param {import("../../Feature.js").default} feature Feature. */ drawCircle(circleGeometry, feature) { const state = this.state; @@ -106,7 +107,8 @@ class CanvasPolygonBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/Polygon.js").default|import("../Feature.js").default} polygonGeometry Polygon geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawPolygon(polygonGeometry, feature) { const state = this.state; @@ -133,12 +135,13 @@ class CanvasPolygonBuilder extends CanvasBuilder { const ends = polygonGeometry.getEnds(); const flatCoordinates = polygonGeometry.getOrientedFlatCoordinates(); const stride = polygonGeometry.getStride(); - this.drawFlatCoordinatess_(flatCoordinates, 0, ends, stride); + this.drawFlatCoordinatess_(flatCoordinates, 0, /** @type {Array} */ (ends), stride); this.endGeometry(feature); } /** - * @inheritDoc + * @param {import("../../geom/MultiPolygon.js").default} multiPolygonGeometry MultiPolygon geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawMultiPolygon(multiPolygonGeometry, feature) { const state = this.state; @@ -173,7 +176,7 @@ class CanvasPolygonBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @return {import("./Builder.js").SerializableInstructions} the serializable instructions. */ finish() { this.reverseHitDetectionInstructions(); diff --git a/src/ol/render/canvas/TextBuilder.js b/src/ol/render/canvas/TextBuilder.js index aec72113ad..942c31a73d 100644 --- a/src/ol/render/canvas/TextBuilder.js +++ b/src/ol/render/canvas/TextBuilder.js @@ -134,7 +134,7 @@ class CanvasTextBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @return {import("./Builder.js").SerializableInstructions} the serializable instructions. */ finish() { const instructions = super.finish(); @@ -145,7 +145,8 @@ class CanvasTextBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../geom/SimpleGeometry.js").default|import("../Feature.js").default} geometry Geometry. + * @param {import("../../Feature.js").FeatureLike} feature Feature. */ drawText(geometry, feature) { const fillState = this.textFillState_; @@ -173,11 +174,11 @@ class CanvasTextBuilder extends CanvasBuilder { if (geometryType == GeometryType.LINE_STRING) { ends = [flatCoordinates.length]; } else if (geometryType == GeometryType.MULTI_LINE_STRING) { - ends = geometry.getEnds(); + ends = /** @type {import("../../geom/MultiLineString.js").default} */ (geometry).getEnds(); } else if (geometryType == GeometryType.POLYGON) { - ends = geometry.getEnds().slice(0, 1); + ends = /** @type {import("../../geom/Polygon.js").default} */ (geometry).getEnds().slice(0, 1); } else if (geometryType == GeometryType.MULTI_POLYGON) { - const endss = geometry.getEndss(); + const endss = /** @type {import("../../geom/MultiPolygon.js").default} */ (geometry).getEndss(); ends = []; for (i = 0, ii = endss.length; i < ii; ++i) { ends.push(endss[i][0]); @@ -217,7 +218,7 @@ class CanvasTextBuilder extends CanvasBuilder { switch (geometryType) { case GeometryType.POINT: case GeometryType.MULTI_POINT: - flatCoordinates = geometry.getFlatCoordinates(); + flatCoordinates = /** @type {import("../../geom/MultiPoint.js").default} */ (geometry).getFlatCoordinates(); end = flatCoordinates.length; break; case GeometryType.LINE_STRING: @@ -379,14 +380,15 @@ class CanvasTextBuilder extends CanvasBuilder { } /** - * @inheritDoc + * @param {import("../../style/Text.js").default} textStyle Text style. + * @param {import("../canvas.js").DeclutterGroups} declutterGroups Declutter. */ setTextStyle(textStyle, declutterGroups) { let textState, fillState, strokeState; if (!textStyle) { this.text_ = ''; } else { - this.declutterGroups_ = /** @type {import("../canvas.js").DeclutterGroups} */ (declutterGroups); + this.declutterGroups_ = declutterGroups; const textFillStyle = textStyle.getFill(); if (!textFillStyle) {