Improve JSDoc

This commit is contained in:
ahocevar
2018-10-14 09:57:26 +02:00
parent 04f2174052
commit af4e5ca7cf
5 changed files with 6 additions and 6 deletions

View File

@@ -31,7 +31,7 @@ import SourceState from './State.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {AttributionLike} [attributions] * @property {AttributionLike} [attributions]
* @property {boolean} [attributionsCollapsible] Whether attributions should be collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {import("../proj.js").ProjectionLike} projection * @property {import("../proj.js").ProjectionLike} projection
* @property {SourceState} [state] * @property {SourceState} [state]
* @property {boolean} [wrapX] * @property {boolean} [wrapX]
@@ -129,7 +129,7 @@ class Source extends BaseObject {
} }
/** /**
* @return {boolean} Should the attributions be collapsible or not. * @return {boolean} Aattributions are collapsible.
*/ */
getAttributionsCollapsible() { getAttributionsCollapsible() {
return this.attributionsCollapsible_; return this.attributionsCollapsible_;

View File

@@ -14,7 +14,7 @@ import {wrapX, getForProjection as getTileGridForProjection} from '../tilegrid.j
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] * @property {import("./Source.js").AttributionLike} [attributions]
* @property {boolean} [attributionsCollapsible] Whether attributions should be collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize] * @property {number} [cacheSize]
* @property {boolean} [opaque] * @property {boolean} [opaque]
* @property {number} [tilePixelRatio] * @property {number} [tilePixelRatio]

View File

@@ -17,7 +17,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible] Whether attributions should be collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to

View File

@@ -11,7 +11,7 @@ import {getKeyZXY} from '../tilecoord.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] * @property {import("./Source.js").AttributionLike} [attributions]
* @property {boolean} [attributionsCollapsible] Whether attributions should be collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize] * @property {number} [cacheSize]
* @property {boolean} [opaque] * @property {boolean} [opaque]
* @property {import("../proj.js").ProjectionLike} [projection] * @property {import("../proj.js").ProjectionLike} [projection]

View File

@@ -8,7 +8,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible] Whether attributions should be collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to