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

Remove extra imports in jsdoc

Browse Source 
The symbols are already imported (es6 import)
This commit is contained in:
Frederic Junod
2018-09-08 10:20:57 +02:00
parent 058f81c0fa
commit 81bab31efb
19 changed files with 172 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/geom/GeometryCollection.js
+8 -8
View File
@@ -17,7 +17,7 @@ import {clear} from '../obj.js';
class GeometryCollection extends Geometry {
/**
* @param {Array<import("./Geometry.js").default>=} opt_geometries Geometries.
* @param {Array<Geometry>=} opt_geometries Geometries.
*/
constructor(opt_geometries) {
@@ -25,7 +25,7 @@ class GeometryCollection extends Geometry {
/**
* @private
* @type {Array<import("./Geometry.js").default>}
* @type {Array<Geometry>}
*/
this.geometries_ = opt_geometries ? opt_geometries : null;
@@ -114,7 +114,7 @@ class GeometryCollection extends Geometry {
/**
* Return the geometries that make up this geometry collection.
* @return {Array<import("./Geometry.js").default>} Geometries.
* @return {Array<Geometry>} Geometries.
* @api
*/
getGeometries() {
@@ -122,7 +122,7 @@ class GeometryCollection extends Geometry {
}
/**
* @return {Array<import("./Geometry.js").default>} Geometries.
* @return {Array<Geometry>} Geometries.
*/
getGeometriesArray() {
return this.geometries_;
@@ -228,7 +228,7 @@ class GeometryCollection extends Geometry {
/**
* Set the geometries that make up this geometry collection.
* @param {Array<import("./Geometry.js").default>} geometries Geometries.
* @param {Array<Geometry>} geometries Geometries.
* @api
*/
setGeometries(geometries) {
@@ -236,7 +236,7 @@ class GeometryCollection extends Geometry {
}
/**
* @param {Array<import("./Geometry.js").default>} geometries Geometries.
* @param {Array<Geometry>} geometries Geometries.
*/
setGeometriesArray(geometries) {
this.unlistenGeometriesChange_();
@@ -280,8 +280,8 @@ class GeometryCollection extends Geometry {
/**
* @param {Array<import("./Geometry.js").default>} geometries Geometries.
* @return {Array<import("./Geometry.js").default>} Cloned geometries.
* @param {Array<Geometry>} geometries Geometries.
* @return {Array<Geometry>} Cloned geometries.
*/
function cloneGeometries(geometries) {
const clonedGeometries = [];
src/ol/geom/LineString.js
+2 -2
View File
@@ -26,7 +26,7 @@ class LineString extends SimpleGeometry {
/**
* @param {Array<import("../coordinate.js").Coordinate>|Array<number>} coordinates Coordinates.
* For internal use, flat coordinates in combination with `opt_layout` are also accepted.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
*/
constructor(coordinates, opt_layout) {
@@ -224,7 +224,7 @@ class LineString extends SimpleGeometry {
/**
* Set the coordinates of the linestring.
* @param {!Array<import("../coordinate.js").Coordinate>} coordinates Coordinates.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
src/ol/geom/LinearRing.js
+2 -2
View File
@@ -23,7 +23,7 @@ class LinearRing extends SimpleGeometry {
/**
* @param {Array<import("../coordinate.js").Coordinate>|Array<number>} coordinates Coordinates.
* For internal use, flat coordinates in combination with `opt_layout` are also accepted.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
*/
constructor(coordinates, opt_layout) {
@@ -123,7 +123,7 @@ class LinearRing extends SimpleGeometry {
/**
* Set the coordinates of the linear ring.
* @param {!Array<import("../coordinate.js").Coordinate>} coordinates Coordinates.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
src/ol/geom/MultiLineString.js
+6 -6
View File
@@ -26,7 +26,7 @@ class MultiLineString extends SimpleGeometry {
* @param {Array<Array<import("../coordinate.js").Coordinate>|import("../geom.js").MultiLineString>|Array<number>} coordinates
* Coordinates or LineString geometries. (For internal use, flat coordinates in
* combination with `opt_layout` and `opt_ends` are also accepted.)
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @param {Array<number>=} opt_ends Flat coordinate ends for internal use.
*/
constructor(coordinates, opt_layout, opt_ends) {
@@ -76,7 +76,7 @@ class MultiLineString extends SimpleGeometry {
/**
* Append the passed linestring to the multilinestring.
* @param {import("./LineString.js").default} lineString LineString.
* @param {LineString} lineString LineString.
* @api
*/
appendLineString(lineString) {
@@ -171,7 +171,7 @@ class MultiLineString extends SimpleGeometry {
/**
* Return the linestring at the specified index.
* @param {number} index Index.
* @return {import("./LineString.js").default} LineString.
* @return {LineString} LineString.
* @api
*/
getLineString(index) {
@@ -184,14 +184,14 @@ class MultiLineString extends SimpleGeometry {
/**
* Return the linestrings of this multilinestring.
* @return {Array<import("./LineString.js").default>} LineStrings.
* @return {Array<LineString>} LineStrings.
* @api
*/
getLineStrings() {
const flatCoordinates = this.flatCoordinates;
const ends = this.ends_;
const layout = this.layout;
/** @type {Array<import("./LineString.js").default>} */
/** @type {Array<LineString>} */
const lineStrings = [];
let offset = 0;
for (let i = 0, ii = ends.length; i < ii; ++i) {
@@ -254,7 +254,7 @@ class MultiLineString extends SimpleGeometry {
/**
* Set the coordinates of the multilinestring.
* @param {!Array<Array<import("../coordinate.js").Coordinate>>} coordinates Coordinates.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
src/ol/geom/MultiPoint.js
+4 -4
View File
@@ -34,7 +34,7 @@ class MultiPoint extends SimpleGeometry {
/**
* Append the passed point to this multipoint.
* @param {import("./Point.js").default} point Point.
* @param {Point} point Point.
* @api
*/
appendPoint(point) {
@@ -94,7 +94,7 @@ class MultiPoint extends SimpleGeometry {
/**
* Return the point at the specified index.
* @param {number} index Index.
* @return {import("./Point.js").default} Point.
* @return {Point} Point.
* @api
*/
getPoint(index) {
@@ -108,14 +108,14 @@ class MultiPoint extends SimpleGeometry {
/**
* Return the points of this multipoint.
* @return {Array<import("./Point.js").default>} Points.
* @return {Array<Point>} Points.
* @api
*/
getPoints() {
const flatCoordinates = this.flatCoordinates;
const layout = this.layout;
const stride = this.stride;
/** @type {Array<import("./Point.js").default>} */
/** @type {Array<Point>} */
const points = [];
for (let i = 0, ii = flatCoordinates.length; i < ii; i += stride) {
const point = new Point(flatCoordinates.slice(i, i + stride), layout);
src/ol/geom/MultiPolygon.js
+6 -6
View File
@@ -30,7 +30,7 @@ class MultiPolygon extends SimpleGeometry {
/**
* @param {Array<Array<Array<import("../coordinate.js").Coordinate>>>|Array<number>} coordinates Coordinates.
* For internal use, flat coordinats in combination with `opt_layout` and `opt_endss` are also accepted.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @param {Array<number>=} opt_endss Array of ends for internal use with flat coordinates.
*/
constructor(coordinates, opt_layout, opt_endss) {
@@ -111,7 +111,7 @@ class MultiPolygon extends SimpleGeometry {
/**
* Append the passed polygon to this multipolygon.
* @param {import("./Polygon.js").default} polygon Polygon.
* @param {Polygon} polygon Polygon.
* @api
*/
appendPolygon(polygon) {
@@ -235,7 +235,7 @@ class MultiPolygon extends SimpleGeometry {
/**
* Return the interior points as {@link module:ol/geom/MultiPoint multipoint}.
* @return {import("./MultiPoint.js").default} Interior points as XYM coordinates, where M is
* @return {MultiPoint} Interior points as XYM coordinates, where M is
* the length of the horizontal intersection that the point belongs to.
* @api
*/
@@ -279,7 +279,7 @@ class MultiPolygon extends SimpleGeometry {
/**
* Return the polygon at the specified index.
* @param {number} index Index.
* @return {import("./Polygon.js").default} Polygon.
* @return {Polygon} Polygon.
* @api
*/
getPolygon(index) {
@@ -305,7 +305,7 @@ class MultiPolygon extends SimpleGeometry {
/**
* Return the polygons of this multipolygon.
* @return {Array<import("./Polygon.js").default>} Polygons.
* @return {Array<Polygon>} Polygons.
* @api
*/
getPolygons() {
@@ -349,7 +349,7 @@ class MultiPolygon extends SimpleGeometry {
/**
* Set the coordinates of the multipolygon.
* @param {!Array<Array<Array<import("../coordinate.js").Coordinate>>>} coordinates Coordinates.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
src/ol/geom/Polygon.js
+6 -6
View File
@@ -36,7 +36,7 @@ class Polygon extends SimpleGeometry {
* an array of vertices' coordinates where the first coordinate and the last are
* equivalent. (For internal use, flat coordinates in combination with
* `opt_layout` and `opt_ends` are also accepted.)
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @param {Array<number>=} opt_ends Ends (for internal use with flat coordinates).
*/
constructor(coordinates, opt_layout, opt_ends) {
@@ -96,7 +96,7 @@ class Polygon extends SimpleGeometry {
/**
* Append the passed linear ring to this polygon.
* @param {import("./LinearRing.js").default} linearRing Linear ring.
* @param {LinearRing} linearRing Linear ring.
* @api
*/
appendLinearRing(linearRing) {
@@ -203,7 +203,7 @@ class Polygon extends SimpleGeometry {
/**
* Return an interior point of the polygon.
* @return {import("./Point.js").default} Interior point as XYM coordinate, where M is the
* @return {Point} Interior point as XYM coordinate, where M is the
* length of the horizontal intersection that the point belongs to.
* @api
*/
@@ -229,7 +229,7 @@ class Polygon extends SimpleGeometry {
* at index `1` and beyond.
*
* @param {number} index Index.
* @return {import("./LinearRing.js").default} Linear ring.
* @return {LinearRing} Linear ring.
* @api
*/
getLinearRing(index) {
@@ -242,7 +242,7 @@ class Polygon extends SimpleGeometry {
/**
* Return the linear rings of the polygon.
* @return {Array<import("./LinearRing.js").default>} Linear rings.
* @return {Array<LinearRing>} Linear rings.
* @api
*/
getLinearRings() {
@@ -313,7 +313,7 @@ class Polygon extends SimpleGeometry {
/**
* Set the coordinates of the polygon.
* @param {!Array<Array<import("../coordinate.js").Coordinate>>} coordinates Coordinates.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
* @override
* @api
*/
src/ol/geom/SimpleGeometry.js
+8 -8
View File
@@ -23,7 +23,7 @@ class SimpleGeometry extends Geometry {
/**
* @protected
* @type {import("./GeometryLayout.js").default}
* @type {GeometryLayout}
*/
this.layout = GeometryLayout.XY;
@@ -82,7 +82,7 @@ class SimpleGeometry extends Geometry {
/**
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
* @return {import("./GeometryLayout.js").default} Layout.
* @return {GeometryLayout} Layout.
* @api
*/
getLayout() {
@@ -145,7 +145,7 @@ class SimpleGeometry extends Geometry {
}
/**
* @param {import("./GeometryLayout.js").default} layout Layout.
* @param {GeometryLayout} layout Layout.
* @param {Array<number>} flatCoordinates Flat coordinates.
*/
setFlatCoordinates(layout, flatCoordinates) {
@@ -157,12 +157,12 @@ class SimpleGeometry extends Geometry {
/**
* @abstract
* @param {!Array} coordinates Coordinates.
* @param {import("./GeometryLayout.js").default=} opt_layout Layout.
* @param {GeometryLayout=} opt_layout Layout.
*/
setCoordinates(coordinates, opt_layout) {}
/**
* @param {import("./GeometryLayout.js").default|undefined} layout Layout.
* @param {GeometryLayout|undefined} layout Layout.
* @param {Array} coordinates Coordinates.
* @param {number} nesting Nesting.
* @protected
@@ -257,7 +257,7 @@ class SimpleGeometry extends Geometry {
/**
* @param {number} stride Stride.
* @return {import("./GeometryLayout.js").default} layout Layout.
* @return {GeometryLayout} layout Layout.
*/
function getLayoutForStride(stride) {
let layout;
@@ -269,13 +269,13 @@ function getLayoutForStride(stride) {
layout = GeometryLayout.XYZM;
}
return (
/** @type {import("./GeometryLayout.js").default} */ (layout)
/** @type {GeometryLayout} */ (layout)
);
}
/**
* @param {import("./GeometryLayout.js").default} layout Layout.
* @param {GeometryLayout} layout Layout.
* @return {number} Stride.
*/
export function getStrideForLayout(layout) {