JSDoc fixes

This commit is contained in:
ahocevar
2019-01-30 09:42:20 +01:00
parent 61b20da539
commit 37eb6de37d
9 changed files with 20 additions and 20 deletions

View File

@@ -64,7 +64,7 @@
"istanbul": "0.4.5", "istanbul": "0.4.5",
"jquery": "3.3.1", "jquery": "3.3.1",
"jsdoc": "3.5.5", "jsdoc": "3.5.5",
"jsdoc-plugin-typescript": "^1.0.4", "jsdoc-plugin-typescript": "^1.0.6",
"karma": "^4.0.0", "karma": "^4.0.0",
"karma-chrome-launcher": "2.2.0", "karma-chrome-launcher": "2.2.0",
"karma-coverage": "^1.1.2", "karma-coverage": "^1.1.2",

View File

@@ -19,21 +19,21 @@ const ImageSourceEventType = {
/** /**
* Triggered when an image starts loading. * Triggered when an image starts loading.
* @event ol/source/Image~ImageSourceEvent#imageloadstart * @event module:ol/source/Image.ImageSourceEvent#imageloadstart
* @api * @api
*/ */
IMAGELOADSTART: 'imageloadstart', IMAGELOADSTART: 'imageloadstart',
/** /**
* Triggered when an image finishes loading. * Triggered when an image finishes loading.
* @event ol/source/Image~ImageSourceEvent#imageloadend * @event module:ol/source/Image.ImageSourceEvent#imageloadend
* @api * @api
*/ */
IMAGELOADEND: 'imageloadend', IMAGELOADEND: 'imageloadend',
/** /**
* Triggered if image loading results in an error. * Triggered if image loading results in an error.
* @event ol/source/Image~ImageSourceEvent#imageloaderror * @event module:ol/source/Image.ImageSourceEvent#imageloaderror
* @api * @api
*/ */
IMAGELOADERROR: 'imageloaderror' IMAGELOADERROR: 'imageloaderror'
@@ -46,7 +46,7 @@ const ImageSourceEventType = {
* Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this * Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this
* type. * type.
*/ */
class ImageSourceEvent extends Event { export class ImageSourceEvent extends Event {
/** /**
* @param {string} type Type. * @param {string} type Type.
* @param {import("../Image.js").default} image The image. * @param {import("../Image.js").default} image The image.
@@ -82,6 +82,7 @@ class ImageSourceEvent extends Event {
* instantiated in apps. * instantiated in apps.
* Base class for sources providing a single image. * Base class for sources providing a single image.
* @abstract * @abstract
* @fires module:ol/source/Image.ImageSourceEvent
* @api * @api
*/ */
class ImageSource extends Source { class ImageSource extends Source {
@@ -236,5 +237,4 @@ export function defaultImageLoadFunction(image, src) {
/** @type {HTMLImageElement|HTMLVideoElement} */ (image.getImage()).src = src; /** @type {HTMLImageElement|HTMLVideoElement} */ (image.getImage()).src = src;
} }
export default ImageSource; export default ImageSource;

View File

@@ -47,7 +47,7 @@ import {appendParams} from '../uri.js';
* take advantage of ol image caching and use * take advantage of ol image caching and use
* {@link module:ol/source/TileArcGISRest} data source. * {@link module:ol/source/TileArcGISRest} data source.
* *
* @fires ol/source/Image~ImageSourceEvent * @fires module:ol/source/Image.ImageSourceEvent
* @api * @api
*/ */
class ImageArcGISRest extends ImageSource { class ImageArcGISRest extends ImageSource {

View File

@@ -35,7 +35,7 @@ import {appendParams} from '../uri.js';
* @classdesc * @classdesc
* Source for images from Mapguide servers * Source for images from Mapguide servers
* *
* @fires ol/source/Image~ImageSourceEvent * @fires module:ol/source/Image.ImageSourceEvent
* @api * @api
*/ */
class ImageMapGuide extends ImageSource { class ImageMapGuide extends ImageSource {

View File

@@ -54,7 +54,7 @@ const GETFEATUREINFO_IMAGE_SIZE = [101, 101];
* @classdesc * @classdesc
* Source for WMS servers providing single, untiled images. * Source for WMS servers providing single, untiled images.
* *
* @fires ol/source/Image~ImageSourceEvent * @fires module:ol/source/Image.ImageSourceEvent
* @api * @api
*/ */
class ImageWMS extends ImageSource { class ImageWMS extends ImageSource {

View File

@@ -44,14 +44,14 @@ import Source from './Source.js';
const RasterEventType = { const RasterEventType = {
/** /**
* Triggered before operations are run. * Triggered before operations are run.
* @event ol/source/Raster~RasterSourceEvent#beforeoperations * @event module:ol/source/Raster.RasterSourceEvent#beforeoperations
* @api * @api
*/ */
BEFOREOPERATIONS: 'beforeoperations', BEFOREOPERATIONS: 'beforeoperations',
/** /**
* Triggered after operations are run. * Triggered after operations are run.
* @event ol/source/Raster~RasterSourceEvent#afteroperations * @event module:ol/source/Raster.RasterSourceEvent#afteroperations
* @api * @api
*/ */
AFTEROPERATIONS: 'afteroperations' AFTEROPERATIONS: 'afteroperations'
@@ -73,7 +73,7 @@ const RasterOperationType = {
* Events emitted by {@link module:ol/source/Raster} instances are instances of this * Events emitted by {@link module:ol/source/Raster} instances are instances of this
* type. * type.
*/ */
class RasterSourceEvent extends Event { export class RasterSourceEvent extends Event {
/** /**
* @param {string} type Type. * @param {string} type Type.
* @param {import("../PluggableMap.js").FrameState} frameState The frame state. * @param {import("../PluggableMap.js").FrameState} frameState The frame state.
@@ -135,7 +135,7 @@ class RasterSourceEvent extends Event {
* {@link module:ol/source/Raster~Operation} function to transform input pixel values into * {@link module:ol/source/Raster~Operation} function to transform input pixel values into
* output pixel values. * output pixel values.
* *
* @fires ol/source/Raster~RasterSourceEvent * @fires module:ol/source/Raster.RasterSourceEvent
* @api * @api
*/ */
class RasterSource extends ImageSource { class RasterSource extends ImageSource {

View File

@@ -21,7 +21,7 @@ import SourceState from './State.js';
* It represents either * It represents either
* * a simple string (e.g. `'© Acme Inc.'`) * * a simple string (e.g. `'© Acme Inc.'`)
* * an array of simple strings (e.g. `['© Acme Inc.', '© Bacme Inc.']`) * * an array of simple strings (e.g. `['© Acme Inc.', '© Bacme Inc.']`)
* * a function that returns a string or array of strings (`{@link module:ol/source/Source~Attribution}`) * * a function that returns a string or array of strings ({@link module:ol/source/Source~Attribution})
* *
* @typedef {string|Array<string>|Attribution} AttributionLike * @typedef {string|Array<string>|Attribution} AttributionLike
*/ */
@@ -155,7 +155,7 @@ class Source extends BaseObject {
/** /**
* Set the attributions of the source. * Set the attributions of the source.
* @param {AttributionLike|undefined} attributions Attributions. * @param {AttributionLike|undefined} attributions Attributions.
* Can be passed as `string`, `Array<string>`, `{@link module:ol/source/Source~Attribution}`, * Can be passed as `string`, `Array<string>`, {@link module:ol/source/Source~Attribution},
* or `undefined`. * or `undefined`.
* @api * @api
*/ */

View File

@@ -154,7 +154,7 @@ export class VectorSourceEvent extends Event {
* by this source are suitable for editing. See {@link module:ol/source/VectorTile~VectorTile} for * by this source are suitable for editing. See {@link module:ol/source/VectorTile~VectorTile} for
* vector data that is optimized for rendering. * vector data that is optimized for rendering.
* *
* @fires ol/source/Vector.VectorSourceEvent * @fires VectorSourceEvent
* @api * @api
*/ */
class VectorSource extends Source { class VectorSource extends Source {

View File

@@ -8,21 +8,21 @@
export default { export default {
/** /**
* Triggered when a feature is added to the source. * Triggered when a feature is added to the source.
* @event ol/source/Vector.VectorSourceEvent#addfeature * @event module:ol/source/Vector.VectorSourceEvent#addfeature
* @api * @api
*/ */
ADDFEATURE: 'addfeature', ADDFEATURE: 'addfeature',
/** /**
* Triggered when a feature is updated. * Triggered when a feature is updated.
* @event ol/source/Vector.VectorSourceEvent#changefeature * @event module:ol/source/Vector.VectorSourceEvent#changefeature
* @api * @api
*/ */
CHANGEFEATURE: 'changefeature', CHANGEFEATURE: 'changefeature',
/** /**
* Triggered when the clear method is called on the source. * Triggered when the clear method is called on the source.
* @event ol/source/Vector.VectorSourceEvent#clear * @event module:ol/source/Vector.VectorSourceEvent#clear
* @api * @api
*/ */
CLEAR: 'clear', CLEAR: 'clear',
@@ -30,7 +30,7 @@ export default {
/** /**
* Triggered when a feature is removed from the source. * Triggered when a feature is removed from the source.
* See {@link module:ol/source/Vector#clear source.clear()} for exceptions. * See {@link module:ol/source/Vector#clear source.clear()} for exceptions.
* @event ol/source/Vector.VectorSourceEvent#removefeature * @event module:ol/source/Vector.VectorSourceEvent#removefeature
* @api * @api
*/ */
REMOVEFEATURE: 'removefeature' REMOVEFEATURE: 'removefeature'