Get rid of olx.js and typedef.js typedefs for ol

This commit is contained in:
Andreas Hocevar
2018-03-08 18:42:57 +01:00
parent 8f0ffe2043
commit 95d6251dbb
198 changed files with 2262 additions and 2698 deletions

View File

@@ -71,7 +71,7 @@ const Icon = function(opt_options) {
const image = options.img !== undefined ? options.img : null;
/**
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
const imgSize = options.imgSize !== undefined ? options.imgSize : null;
@@ -131,7 +131,7 @@ const Icon = function(opt_options) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.size_ = options.size !== undefined ? options.size : null;

View File

@@ -13,11 +13,11 @@ import {iconImageCache} from '../style.js';
* @constructor
* @param {Image|HTMLCanvasElement} image Image.
* @param {string|undefined} src Src.
* @param {ol.Size} size Size.
* @param {module:ol/size~Size} size Size.
* @param {?string} crossOrigin Cross origin.
* @param {ol.ImageState} imageState Image state.
* @param {ol.Color} color Color.
* @extends {ol.events.EventTarget}
* @extends {module:ol/events/EventTarget~EventTarget}
*/
const IconImage = function(image, src, size, crossOrigin, imageState, color) {
@@ -55,7 +55,7 @@ const IconImage = function(image, src, size, crossOrigin, imageState, color) {
/**
* @private
* @type {Array.<ol.EventsKey>}
* @type {Array.<module:ol/events~EventsKey>}
*/
this.imageListenerKeys_ = null;
@@ -67,7 +67,7 @@ const IconImage = function(image, src, size, crossOrigin, imageState, color) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.size_ = size;
@@ -94,7 +94,7 @@ inherits(IconImage, EventTarget);
/**
* @param {Image|HTMLCanvasElement} image Image.
* @param {string} src Src.
* @param {ol.Size} size Size.
* @param {module:ol/size~Size} size Size.
* @param {?string} crossOrigin Cross origin.
* @param {ol.ImageState} imageState Image state.
* @param {ol.Color} color Color.
@@ -197,7 +197,7 @@ IconImage.prototype.getHitDetectionImage = function(pixelRatio) {
/**
* @return {ol.Size} Image size.
* @return {module:ol/size~Size} Image size.
*/
IconImage.prototype.getSize = function() {
return this.size_;

View File

@@ -132,14 +132,14 @@ ImageStyle.prototype.getImageState = function() {};
/**
* @abstract
* @return {ol.Size} Image size.
* @return {module:ol/size~Size} Image size.
*/
ImageStyle.prototype.getImageSize = function() {};
/**
* @abstract
* @return {ol.Size} Size of the hit-detection image.
* @return {module:ol/size~Size} Size of the hit-detection image.
*/
ImageStyle.prototype.getHitDetectionImageSize = function() {};
@@ -155,7 +155,7 @@ ImageStyle.prototype.getOrigin = function() {};
/**
* Get the size of the symbolizer (in pixels).
* @abstract
* @return {ol.Size} Size.
* @return {module:ol/size~Size} Size.
*/
ImageStyle.prototype.getSize = function() {};
@@ -217,7 +217,7 @@ ImageStyle.prototype.setSnapToPixel = function(snapToPixel) {
* @abstract
* @param {function(this: T, ol.events.Event)} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`.
* @return {ol.EventsKey|undefined} Listener key.
* @return {module:ol/events~EventsKey|undefined} Listener key.
* @template T
*/
ImageStyle.prototype.listenImageChange = function(listener, thisArg) {};

View File

@@ -90,19 +90,19 @@ const RegularShape = function(options) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.size_ = null;
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.imageSize_ = null;
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.hitDetectionImageSize_ = null;

View File

@@ -274,9 +274,9 @@ Style.prototype.setZIndex = function(zIndex) {
* Convert the provided object into a style function. Functions passed through
* unchanged. Arrays of ol.style.Style or single style objects wrapped in a
* new style function.
* @param {ol.StyleFunction|Array.<ol.style.Style>|ol.style.Style} obj
* @param {module:ol/style~StyleFunction|Array.<ol.style.Style>|ol.style.Style} obj
* A style function, a single style, or an array of styles.
* @return {ol.StyleFunction} A style function.
* @return {module:ol/style~StyleFunction} A style function.
*/
export function toFunction(obj) {
let styleFunction;