Fix comments for JSDoc
This commit is contained in:
@@ -56,6 +56,8 @@ export class CollectionEvent extends Event {
|
|||||||
* Collection; they trigger events on the appropriate object, not on the
|
* Collection; they trigger events on the appropriate object, not on the
|
||||||
* Collection as a whole.
|
* Collection as a whole.
|
||||||
*
|
*
|
||||||
|
* @fires CollectionEvent
|
||||||
|
*
|
||||||
* @template T
|
* @template T
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -88,7 +88,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js
|
|||||||
* @typedef {Object} MapOptions
|
* @typedef {Object} MapOptions
|
||||||
* @property {Collection<import("./control/Control.js").default>|Array<import("./control/Control.js").default>} [controls]
|
* @property {Collection<import("./control/Control.js").default>|Array<import("./control/Control.js").default>} [controls]
|
||||||
* Controls initially added to the map. If not specified,
|
* Controls initially added to the map. If not specified,
|
||||||
* {@link module:ol/control/util~defaults} is used.
|
* {@link module:ol/control~defaults} is used.
|
||||||
* @property {number} [pixelRatio=window.devicePixelRatio] The ratio between
|
* @property {number} [pixelRatio=window.devicePixelRatio] The ratio between
|
||||||
* physical pixels and device-independent pixels (dips) on the device.
|
* physical pixels and device-independent pixels (dips) on the device.
|
||||||
* @property {Collection<import("./interaction/Interaction.js").default>|Array<import("./interaction/Interaction.js").default>} [interactions]
|
* @property {Collection<import("./interaction/Interaction.js").default>|Array<import("./interaction/Interaction.js").default>} [interactions]
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ export default {
|
|||||||
/**
|
/**
|
||||||
* Indicates that tile loading failed
|
* Indicates that tile loading failed
|
||||||
* @type {number}
|
* @type {number}
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
ERROR: 3,
|
ERROR: 3,
|
||||||
EMPTY: 4,
|
EMPTY: 4,
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ import {clear} from './obj.js';
|
|||||||
* Listener function. This function is called with an event object as argument.
|
* Listener function. This function is called with an event object as argument.
|
||||||
* When the function returns `false`, event propagation will stop.
|
* When the function returns `false`, event propagation will stop.
|
||||||
*
|
*
|
||||||
* @typedef {function(Event|import("./events/Event.js").default): (void|boolean)} ListenerFunction
|
* @typedef {function((Event|import("./events/Event.js").default)): (void|boolean)} ListenerFunction
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ import Polygon from '../geom/Polygon.js';
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Geometry constructors
|
||||||
* @enum {function (new:import("../geom/Geometry.js").default, Array, GeometryLayout)}
|
* @enum {function (new:import("../geom/Geometry.js").default, Array, GeometryLayout)}
|
||||||
*/
|
*/
|
||||||
const GeometryConstructor = {
|
const GeometryConstructor = {
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ class SimpleGeometry extends Geometry {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
|
* Return the {@link module:ol/geom/GeometryLayout layout} of the geometry.
|
||||||
* @return {GeometryLayout} Layout.
|
* @return {GeometryLayout} Layout.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,3 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* @module ol/pixel
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An array with two elements, representing a pixel. The first element is the
|
* An array with two elements, representing a pixel. The first element is the
|
||||||
* x-coordinate, the second the y-coordinate of the pixel.
|
* x-coordinate, the second the y-coordinate of the pixel.
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ import {getKeyZXY} from '../tilecoord.js';
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Base class for sources providing tiles divided into a tile grid over http.
|
* Base class for sources providing tiles divided into a tile grid over http.
|
||||||
*
|
*
|
||||||
* @fires import("./TileEvent.js").default
|
* @fires import("./Tile.js").TileSourceEvent
|
||||||
*/
|
*/
|
||||||
class UrlTile extends TileSource {
|
class UrlTile extends TileSource {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -44,6 +44,7 @@ let uidCounter_ = 0;
|
|||||||
*
|
*
|
||||||
* @param {Object} obj The object to get the unique ID for.
|
* @param {Object} obj The object to get the unique ID for.
|
||||||
* @return {string} The unique ID for the object.
|
* @return {string} The unique ID for the object.
|
||||||
|
* @function module:ol.getUid
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
export function getUid(obj) {
|
export function getUid(obj) {
|
||||||
|
|||||||
Reference in New Issue
Block a user