Replace google closure syntax = with brackets around name

This commit is contained in:
Simon Seyock
2021-02-03 14:06:02 +01:00
parent c15faa19fc
commit 8facb252f1
185 changed files with 569 additions and 569 deletions

View File

@@ -92,7 +92,7 @@ class Cluster extends VectorSource {
/**
* Remove all features from the source.
* @param {boolean=} opt_fast Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#removefeature} events.
* @param {boolean} [opt_fast] Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#removefeature} events.
* @api
*/
clear(opt_fast) {

View File

@@ -60,7 +60,7 @@ function formatPercentage(percentage) {
*/
class IIIF extends TileImage {
/**
* @param {Options=} opt_options Tile source options. Use {@link import("../format/IIIFInfo.js").IIIFInfo}
* @param {Options} [opt_options] Tile source options. Use {@link import("../format/IIIFInfo.js").IIIFInfo}
* to parse Image API service information responses into constructor options.
* @api
*/

View File

@@ -50,7 +50,7 @@ import {containsExtent, getHeight, getWidth} from '../extent.js';
*/
class ImageArcGISRest extends ImageSource {
/**
* @param {Options=} opt_options Image ArcGIS Rest Options.
* @param {Options} [opt_options] Image ArcGIS Rest Options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};

View File

@@ -52,7 +52,7 @@ import {
*/
class ImageCanvasSource extends ImageSource {
/**
* @param {Options=} opt_options ImageCanvas options.
* @param {Options} [opt_options] ImageCanvas options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};

View File

@@ -62,7 +62,7 @@ const GETFEATUREINFO_IMAGE_SIZE = [101, 101];
*/
class ImageWMS extends ImageSource {
/**
* @param {Options=} [opt_options] ImageWMS options.
* @param {Options} [opt_options] ImageWMS options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};

View File

@@ -48,7 +48,7 @@ export const ATTRIBUTION =
*/
class OSM extends XYZ {
/**
* @param {Options=} [opt_options] Open Street Map options.
* @param {Options} [opt_options] Open Street Map options.
*/
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -597,7 +597,7 @@ class RasterSource extends ImageSource {
/**
* Set the operation.
* @param {Operation} operation New operation.
* @param {Object=} opt_lib Functions that will be available to operations run
* @param {Object} [opt_lib] Functions that will be available to operations run
* in a worker.
* @api
*/

View File

@@ -291,7 +291,7 @@ class TileSource extends Source {
* is outside the resolution and extent range of the tile grid, `null` will be
* returned.
* @param {import("../tilecoord.js").TileCoord} tileCoord Tile coordinate.
* @param {import("../proj/Projection.js").default=} opt_projection Projection.
* @param {import("../proj/Projection.js").default} [opt_projection] Projection.
* @return {import("../tilecoord.js").TileCoord} Tile coordinate to be passed to the tileUrlFunction or
* null if no tile URL should be created for the passed `tileCoord`.
*/

View File

@@ -62,7 +62,7 @@ import {hash as tileCoordHash} from '../tilecoord.js';
*/
class TileArcGISRest extends TileImage {
/**
* @param {Options=} opt_options Tile ArcGIS Rest options.
* @param {Options} [opt_options] Tile ArcGIS Rest options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : {};

View File

@@ -101,7 +101,7 @@ class LabeledTile extends Tile {
*/
class TileDebug extends XYZ {
/**
* @param {Options=} opt_options Debug tile options.
* @param {Options} [opt_options] Debug tile options.
*/
constructor(opt_options) {
/**

View File

@@ -77,7 +77,7 @@ import {hash as tileCoordHash} from '../tilecoord.js';
*/
class TileWMS extends TileImage {
/**
* @param {Options=} [opt_options] Tile WMS options.
* @param {Options} [opt_options] Tile WMS options.
*/
constructor(opt_options) {
const options = opt_options ? opt_options : /** @type {Options} */ ({});

View File

@@ -132,7 +132,7 @@ export class CustomTile extends Tile {
* for given coordinate (or `null` if not yet loaded).
* @param {import("../coordinate.js").Coordinate} coordinate Coordinate.
* @param {function(*): void} callback Callback.
* @param {boolean=} opt_request If `true` the callback is always async.
* @param {boolean} [opt_request] If `true` the callback is always async.
* The tile data is requested if not yet loaded.
*/
forDataAtCoordinate(coordinate, callback, opt_request) {
@@ -378,7 +378,7 @@ class UTFGrid extends TileSource {
* @param {import("../coordinate.js").Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {function(*): void} callback Callback.
* @param {boolean=} opt_request If `true` the callback is always async.
* @param {boolean} [opt_request] If `true` the callback is always async.
* The tile data is requested if not yet loaded.
* @api
*/

View File

@@ -162,7 +162,7 @@ class UrlTile extends TileSource {
/**
* Set the tile URL function of the source.
* @param {import("../Tile.js").UrlFunction} tileUrlFunction Tile URL function.
* @param {string=} key Optional new tile key for the source.
* @param {string} [key] Optional new tile key for the source.
* @api
*/
setTileUrlFunction(tileUrlFunction, key) {

View File

@@ -39,8 +39,8 @@ import {xhr} from '../featureloader.js';
export class VectorSourceEvent extends Event {
/**
* @param {string} type Type.
* @param {import("../Feature.js").default<Geometry>=} opt_feature Feature.
* @param {Array<import("../Feature.js").default<Geometry>>=} opt_features Features.
* @param {import("../Feature.js").default<Geometry>} [opt_feature] Feature.
* @param {Array<import("../Feature.js").default<Geometry>>} [opt_features] Features.
*/
constructor(type, opt_feature, opt_features) {
super(type);
@@ -165,7 +165,7 @@ export class VectorSourceEvent extends Event {
*/
class VectorSource extends Source {
/**
* @param {Options=} opt_options Vector source options.
* @param {Options} [opt_options] Vector source options.
*/
constructor(opt_options) {
const options = opt_options || {};
@@ -500,7 +500,7 @@ class VectorSource extends Source {
/**
* Remove all features from the source.
* @param {boolean=} opt_fast Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#removefeature} events.
* @param {boolean} [opt_fast] Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#removefeature} events.
* @api
*/
clear(opt_fast) {
@@ -712,7 +712,7 @@ class VectorSource extends Source {
* This method is not available when the source is configured with
* `useSpatialIndex` set to `false`.
* @param {import("../coordinate.js").Coordinate} coordinate Coordinate.
* @param {function(import("../Feature.js").default<Geometry>):boolean=} opt_filter Feature filter function.
* @param {function(import("../Feature.js").default<Geometry>):boolean} [opt_filter] Feature filter function.
* The filter function will receive one argument, the {@link module:ol/Feature feature}
* and it should return a boolean value. By default, no filtering is made.
* @return {import("../Feature.js").default<Geometry>} Closest feature.
@@ -771,7 +771,7 @@ class VectorSource extends Source {
*
* This method is not available when the source is configured with
* `useSpatialIndex` set to `false`.
* @param {import("../extent.js").Extent=} opt_extent Destination extent. If provided, no new extent
* @param {import("../extent.js").Extent} [opt_extent] Destination extent. If provided, no new extent
* will be created. Instead, that extent's coordinates will be overwritten.
* @return {import("../extent.js").Extent} Extent.
* @api

View File

@@ -69,7 +69,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
*/
class XYZ extends TileImage {
/**
* @param {Options=} opt_options XYZ options.
* @param {Options} [opt_options] XYZ options.
*/
constructor(opt_options) {
const options = opt_options || {};

View File

@@ -29,7 +29,7 @@ export class CustomTile extends ImageTile {
* @param {string} src Image source URI.
* @param {?string} crossOrigin Cross origin.
* @param {import("../Tile.js").LoadFunction} tileLoadFunction Tile load function.
* @param {import("../Tile.js").Options=} opt_options Tile options.
* @param {import("../Tile.js").Options} [opt_options] Tile options.
*/
constructor(
tileSize,