Module types for ol/geom

This commit is contained in:
Tim Schaub
2018-03-11 23:08:50 -06:00
parent 41d9a84a8f
commit ef70d71636
60 changed files with 482 additions and 482 deletions

View File

@@ -16,7 +16,7 @@ import {clear} from '../obj.js';
*
* @constructor
* @abstract
* @extends {ol.geom.Geometry}
* @extends {module:ol/geom/Geometry~Geometry}
* @api
*/
const SimpleGeometry = function() {
@@ -25,7 +25,7 @@ const SimpleGeometry = function() {
/**
* @protected
* @type {ol.geom.GeometryLayout}
* @type {module:ol/geom/GeometryLayout~GeometryLayout}
*/
this.layout = GeometryLayout.XY;
@@ -48,7 +48,7 @@ inherits(SimpleGeometry, Geometry);
/**
* @param {number} stride Stride.
* @return {ol.geom.GeometryLayout} layout Layout.
* @return {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout.
*/
function getLayoutForStride(stride) {
let layout;
@@ -59,12 +59,12 @@ function getLayoutForStride(stride) {
} else if (stride == 4) {
layout = GeometryLayout.XYZM;
}
return /** @type {ol.geom.GeometryLayout} */ (layout);
return /** @type {module:ol/geom/GeometryLayout~GeometryLayout} */ (layout);
}
/**
* @param {ol.geom.GeometryLayout} layout Layout.
* @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout.
* @return {number} Stride.
*/
export function getStrideForLayout(layout) {
@@ -131,8 +131,8 @@ SimpleGeometry.prototype.getLastCoordinate = function() {
/**
* Return the {@link ol.geom.GeometryLayout layout} of the geometry.
* @return {ol.geom.GeometryLayout} Layout.
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
* @return {module:ol/geom/GeometryLayout~GeometryLayout} Layout.
* @api
*/
SimpleGeometry.prototype.getLayout = function() {
@@ -182,7 +182,7 @@ SimpleGeometry.prototype.getSimplifiedGeometry = function(squaredTolerance) {
/**
* @param {number} squaredTolerance Squared tolerance.
* @return {ol.geom.SimpleGeometry} Simplified geometry.
* @return {module:ol/geom/SimpleGeometry~SimpleGeometry} Simplified geometry.
* @protected
*/
SimpleGeometry.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
@@ -199,7 +199,7 @@ SimpleGeometry.prototype.getStride = function() {
/**
* @param {ol.geom.GeometryLayout} layout Layout.
* @param {module:ol/geom/GeometryLayout~GeometryLayout} layout Layout.
* @param {Array.<number>} flatCoordinates Flat coordinates.
* @protected
*/
@@ -213,13 +213,13 @@ SimpleGeometry.prototype.setFlatCoordinatesInternal = function(layout, flatCoord
/**
* @abstract
* @param {Array} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @param {module:ol/geom/GeometryLayout~GeometryLayout=} opt_layout Layout.
*/
SimpleGeometry.prototype.setCoordinates = function(coordinates, opt_layout) {};
/**
* @param {ol.geom.GeometryLayout|undefined} layout Layout.
* @param {module:ol/geom/GeometryLayout~GeometryLayout|undefined} layout Layout.
* @param {Array} coordinates Coordinates.
* @param {number} nesting Nesting.
* @protected
@@ -316,7 +316,7 @@ SimpleGeometry.prototype.translate = function(deltaX, deltaY) {
/**
* @param {ol.geom.SimpleGeometry} simpleGeometry Simple geometry.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} simpleGeometry Simple geometry.
* @param {module:ol/transform~Transform} transform Transform.
* @param {Array.<number>=} opt_dest Destination.
* @return {Array.<number>} Transformed flat coordinates.