fixed jsdoc type annotations

This commit is contained in:
Simon Seyock
2019-09-29 19:30:43 +02:00
parent c69201d5ad
commit 2e1dee1994
6 changed files with 8 additions and 13 deletions

View File

@@ -231,7 +231,7 @@ class Feature extends BaseObject {
* styles. If it is `null` the feature has no style (a `null` style). * styles. If it is `null` the feature has no style (a `null` style).
* @param {import("./style/Style.js").StyleLike} style Style for this feature. * @param {import("./style/Style.js").StyleLike} style Style for this feature.
* @api * @api
* @fires module:ol/events/Event~Event#event:change * @fires module:ol/events/Event~BaseEvent#event:change
*/ */
setStyle(style) { setStyle(style) {
this.style_ = style; this.style_ = style;
@@ -246,7 +246,7 @@ class Feature extends BaseObject {
* {@link module:ol/source/Vector~VectorSource#getFeatureById} method. * {@link module:ol/source/Vector~VectorSource#getFeatureById} method.
* @param {number|string|undefined} id The feature id. * @param {number|string|undefined} id The feature id.
* @api * @api
* @fires module:ol/events/Event~Event#event:change * @fires module:ol/events/Event~BaseEvent#event:change
*/ */
setId(id) { setId(id) {
this.id_ = id; this.id_ = id;

View File

@@ -81,7 +81,7 @@ class GeolocationError extends BaseEvent {
* window.console.log(geolocation.getPosition()); * window.console.log(geolocation.getPosition());
* }); * });
* *
* @fires module:ol/events/Event~Event#event:error * @fires module:ol/events/Event~BaseEvent#event:error
* @api * @api
*/ */
class Geolocation extends BaseObject { class Geolocation extends BaseObject {

View File

@@ -13,7 +13,7 @@ import EventType from './events/EventType.js';
* and unregistration. A generic `change` event is always available through * and unregistration. A generic `change` event is always available through
* {@link module:ol/Observable~Observable#changed}. * {@link module:ol/Observable~Observable#changed}.
* *
* @fires import("./events/Event.js").Event * @fires import("./events/Event.js").default
* @api * @api
*/ */
class Observable extends EventTarget { class Observable extends EventTarget {

View File

@@ -9,14 +9,14 @@
export default { export default {
/** /**
* Generic change event. Triggered when the revision counter is increased. * Generic change event. Triggered when the revision counter is increased.
* @event module:ol/events/Event~Event#change * @event module:ol/events/Event~BaseEvent#change
* @api * @api
*/ */
CHANGE: 'change', CHANGE: 'change',
/** /**
* Generic error event. Triggered when an error occurs. * Generic error event. Triggered when an error occurs.
* @event module:ol/events/Event~Event#error * @event module:ol/events/Event~BaseEvent#error
* @api * @api
*/ */
ERROR: 'error', ERROR: 'error',

View File

@@ -5,11 +5,6 @@ import BaseImageLayer from './BaseImage.js';
import CanvasImageLayerRenderer from '../renderer/canvas/ImageLayer.js'; import CanvasImageLayerRenderer from '../renderer/canvas/ImageLayer.js';
/**
* @typedef {import("./BaseImage.js").Options} Options
*/
/** /**
* @classdesc * @classdesc
* Server-rendered images that are available for arbitrary extents and * Server-rendered images that are available for arbitrary extents and
@@ -23,7 +18,7 @@ import CanvasImageLayerRenderer from '../renderer/canvas/ImageLayer.js';
class ImageLayer extends BaseImageLayer { class ImageLayer extends BaseImageLayer {
/** /**
* @param {Options=} opt_options Layer options. * @param {import("./BaseImage.js").Options=} opt_options Layer options.
*/ */
constructor(opt_options) { constructor(opt_options) {
super(opt_options); super(opt_options);

View File

@@ -22,7 +22,7 @@ import EventType from '../events/EventType.js';
* Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring * Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring
* items from the cache is the responsibility of the user. * items from the cache is the responsibility of the user.
* *
* @fires import("../events/Event.js").Event * @fires import("../events/Event.js").default
* @template T * @template T
*/ */
class LRUCache extends EventTarget { class LRUCache extends EventTarget {