diff --git a/src/ol/ImageTile.js b/src/ol/ImageTile.js index 70d953fb37..02eb67d475 100644 --- a/src/ol/ImageTile.js +++ b/src/ol/ImageTile.js @@ -10,7 +10,7 @@ import EventType from './events/EventType.js'; /** * @typedef {function(new: module:ol/ImageTile~ImageTile, module:ol/tilecoord~TileCoord, - * module:ol/TileState, string, ?string, ol.TileLoadFunctionType)} TileClass + * module:ol/TileState, string, ?string, module:ol/Tile~LoadFunction)} TileClass * @api */ diff --git a/src/ol/VectorTile.js b/src/ol/VectorTile.js index 56eddac1b7..187c1a9b48 100644 --- a/src/ol/VectorTile.js +++ b/src/ol/VectorTile.js @@ -6,8 +6,8 @@ import Tile from './Tile.js'; import TileState from './TileState.js'; /** - * @typedef {function(new: ol.VectorTile, module:ol/tilecoord~TileCoord, - * module:ol/TileState, string, ?string, ol.TileLoadFunctionType)} TileClass + * @typedef {function(new: module:ol/VectorTile~VectorTile, module:ol/tilecoord~TileCoord, + * module:ol/TileState, string, ?string, module:ol/Tile~LoadFunction)} TileClass * @api */ diff --git a/src/ol/format/WFS.js b/src/ol/format/WFS.js index c804c06532..0f754701bc 100644 --- a/src/ol/format/WFS.js +++ b/src/ol/format/WFS.js @@ -44,7 +44,7 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender, * WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some * Web Feature Services have repurposed `maxfeatures` instead. * @property {module:ol/extent~Extent} [bbox] Extent to use for the BBOX filter. - * @property {ol.format.filter.Filter} [filter] Filter condition. See + * @property {module:ol/format/filter/Filter~Filter} [filter] Filter condition. See * {@link ol.format.filter} for more information. * @property {string} [resultType] Indicates what response should be returned, * E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features. @@ -680,7 +680,7 @@ function writeQuery(node, featureType, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.Filter} filter Filter. + * @param {module:ol/format/filter/Filter~Filter} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeFilterCondition(node, filter, objectStack) { @@ -695,7 +695,7 @@ function writeFilterCondition(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.Bbox} filter Filter. + * @param {module:ol/format/filter/Bbox~Bbox} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeBboxFilter(node, filter, objectStack) { @@ -709,7 +709,7 @@ function writeBboxFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.Contains} filter Filter. + * @param {module:ol/format/filter/Contains~Contains} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeContainsFilter(node, filter, objectStack) { @@ -723,7 +723,7 @@ function writeContainsFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.Intersects} filter Filter. + * @param {module:ol/format/filter/Intersects~Intersects} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeIntersectsFilter(node, filter, objectStack) { @@ -737,7 +737,7 @@ function writeIntersectsFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.Within} filter Filter. + * @param {module:ol/format/filter/Within~Within} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeWithinFilter(node, filter, objectStack) { @@ -751,7 +751,7 @@ function writeWithinFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.During} filter Filter. + * @param {module:ol/format/filter/During~During} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeDuringFilter(node, filter, objectStack) { @@ -776,7 +776,7 @@ function writeDuringFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.LogicalNary} filter Filter. + * @param {module:ol/format/filter/LogicalNary~LogicalNary} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeLogicalFilter(node, filter, objectStack) { @@ -795,7 +795,7 @@ function writeLogicalFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.Not} filter Filter. + * @param {module:ol/format/filter/Not~Not} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeNotFilter(node, filter, objectStack) { @@ -811,7 +811,7 @@ function writeNotFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.ComparisonBinary} filter Filter. + * @param {module:ol/format/filter/ComparisonBinary~ComparisonBinary} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeComparisonFilter(node, filter, objectStack) { @@ -825,7 +825,7 @@ function writeComparisonFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.IsNull} filter Filter. + * @param {module:ol/format/filter/IsNull~IsNull} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeIsNullFilter(node, filter, objectStack) { @@ -835,7 +835,7 @@ function writeIsNullFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.IsBetween} filter Filter. + * @param {module:ol/format/filter/IsBetween~IsBetween} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeIsBetweenFilter(node, filter, objectStack) { @@ -853,7 +853,7 @@ function writeIsBetweenFilter(node, filter, objectStack) { /** * @param {Node} node Node. - * @param {ol.format.filter.IsLike} filter Filter. + * @param {module:ol/format/filter/IsLike~IsLike} filter Filter. * @param {Array.<*>} objectStack Node stack. */ function writeIsLikeFilter(node, filter, objectStack) { @@ -915,7 +915,7 @@ function writeTimeInstant(node, time) { /** * Encode filter as WFS `Filter` and return the Node. * - * @param {ol.format.filter.Filter} filter Filter. + * @param {module:ol/format/filter/Filter~Filter} filter Filter. * @return {Node} Result. * @api */ diff --git a/src/ol/format/WMSGetFeatureInfo.js b/src/ol/format/WMSGetFeatureInfo.js index 6f0b74f11c..8fea0794d8 100644 --- a/src/ol/format/WMSGetFeatureInfo.js +++ b/src/ol/format/WMSGetFeatureInfo.js @@ -18,7 +18,7 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js'; /** * @classdesc * Format for reading WMSGetFeatureInfo format. It uses - * {@link ol.format.GML2} to read features. + * {@link module:ol/format/GML2~GML2} to read features. * * @constructor * @extends {module:ol/format/XMLFeature~XMLFeature} @@ -38,7 +38,7 @@ const WMSGetFeatureInfo = function(opt_options) { /** * @private - * @type {ol.format.GML2} + * @type {module:ol/format/GML2~GML2} */ this.gmlFormat_ = new GML2(); diff --git a/src/ol/format/WMTSCapabilities.js b/src/ol/format/WMTSCapabilities.js index 91b9e0e848..3fa9b740c9 100644 --- a/src/ol/format/WMTSCapabilities.js +++ b/src/ol/format/WMTSCapabilities.js @@ -22,7 +22,7 @@ const WMTSCapabilities = function() { XML.call(this); /** - * @type {ol.format.OWS} + * @type {module:ol/format/OWS~OWS} * @private */ this.owsParser_ = new OWS(); diff --git a/src/ol/format/filter.js b/src/ol/format/filter.js index 18b4fade84..631acd5fc0 100644 --- a/src/ol/format/filter.js +++ b/src/ol/format/filter.js @@ -23,8 +23,8 @@ import Within from '../format/filter/Within.js'; /** * Create a logical `` operator between two or more filter conditions. * - * @param {...ol.format.filter.Filter} conditions Filter conditions. - * @returns {!ol.format.filter.And} `` operator. + * @param {...module:ol/format/filter/Filter~Filter} conditions Filter conditions. + * @returns {!module:ol/format/filter/And~And} `` operator. * @api */ export function and(conditions) { @@ -36,8 +36,8 @@ export function and(conditions) { /** * Create a logical `` operator between two or more filter conditions. * - * @param {...ol.format.filter.Filter} conditions Filter conditions. - * @returns {!ol.format.filter.Or} `` operator. + * @param {...module:ol/format/filter/Filter~Filter} conditions Filter conditions. + * @returns {!module:ol/format/filter/Or~Or} `` operator. * @api */ export function or(conditions) { @@ -49,8 +49,8 @@ export function or(conditions) { /** * Represents a logical `` operator for a filter condition. * - * @param {!ol.format.filter.Filter} condition Filter condition. - * @returns {!ol.format.filter.Not} `` operator. + * @param {!module:ol/format/filter/Filter~Filter} condition Filter condition. + * @returns {!module:ol/format/filter/Not~Not} `` operator. * @api */ export function not(condition) { @@ -66,7 +66,7 @@ export function not(condition) { * @param {!module:ol/extent~Extent} extent Extent. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @returns {!ol.format.filter.Bbox} `` operator. + * @returns {!module:ol/format/filter/Bbox~Bbox} `` operator. * @api */ export function bbox(geometryName, extent, opt_srsName) { @@ -81,7 +81,7 @@ export function bbox(geometryName, extent, opt_srsName) { * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @returns {!ol.format.filter.Contains} `` operator. + * @returns {!module:ol/format/filter/Contains~Contains} `` operator. * @api */ export function contains(geometryName, geometry, opt_srsName) { @@ -96,7 +96,7 @@ export function contains(geometryName, geometry, opt_srsName) { * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @returns {!ol.format.filter.Intersects} `` operator. + * @returns {!module:ol/format/filter/Intersects~Intersects} `` operator. * @api */ export function intersects(geometryName, geometry, opt_srsName) { @@ -111,7 +111,7 @@ export function intersects(geometryName, geometry, opt_srsName) { * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @returns {!ol.format.filter.Within} `` operator. + * @returns {!module:ol/format/filter/Within~Within} `` operator. * @api */ export function within(geometryName, geometry, opt_srsName) { @@ -125,7 +125,7 @@ export function within(geometryName, geometry, opt_srsName) { * @param {!string} propertyName Name of the context property to compare. * @param {!(string|number)} expression The value to compare. * @param {boolean=} opt_matchCase Case-sensitive? - * @returns {!ol.format.filter.EqualTo} `` operator. + * @returns {!module:ol/format/filter/EqualTo~EqualTo} `` operator. * @api */ export function equalTo(propertyName, expression, opt_matchCase) { @@ -139,7 +139,7 @@ export function equalTo(propertyName, expression, opt_matchCase) { * @param {!string} propertyName Name of the context property to compare. * @param {!(string|number)} expression The value to compare. * @param {boolean=} opt_matchCase Case-sensitive? - * @returns {!ol.format.filter.NotEqualTo} `` operator. + * @returns {!module:ol/format/filter/NotEqualTo~NotEqualTo} `` operator. * @api */ export function notEqualTo(propertyName, expression, opt_matchCase) { @@ -152,7 +152,7 @@ export function notEqualTo(propertyName, expression, opt_matchCase) { * * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @returns {!ol.format.filter.LessThan} `` operator. + * @returns {!module:ol/format/filter/LessThan~LessThan} `` operator. * @api */ export function lessThan(propertyName, expression) { @@ -165,7 +165,7 @@ export function lessThan(propertyName, expression) { * * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @returns {!ol.format.filter.LessThanOrEqualTo} `` operator. + * @returns {!module:ol/format/filter/LessThanOrEqualTo~LessThanOrEqualTo} `` operator. * @api */ export function lessThanOrEqualTo(propertyName, expression) { @@ -178,7 +178,7 @@ export function lessThanOrEqualTo(propertyName, expression) { * * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @returns {!ol.format.filter.GreaterThan} `` operator. + * @returns {!module:ol/format/filter/GreaterThan~GreaterThan} `` operator. * @api */ export function greaterThan(propertyName, expression) { @@ -191,7 +191,7 @@ export function greaterThan(propertyName, expression) { * * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @returns {!ol.format.filter.GreaterThanOrEqualTo} `` operator. + * @returns {!module:ol/format/filter/GreaterThanOrEqualTo~GreaterThanOrEqualTo} `` operator. * @api */ export function greaterThanOrEqualTo(propertyName, expression) { @@ -204,7 +204,7 @@ export function greaterThanOrEqualTo(propertyName, expression) { * is null. * * @param {!string} propertyName Name of the context property to compare. - * @returns {!ol.format.filter.IsNull} `` operator. + * @returns {!module:ol/format/filter/IsNull~IsNull} `` operator. * @api */ export function isNull(propertyName) { @@ -219,7 +219,7 @@ export function isNull(propertyName) { * @param {!string} propertyName Name of the context property to compare. * @param {!number} lowerBoundary The lower bound of the range. * @param {!number} upperBoundary The upper bound of the range. - * @returns {!ol.format.filter.IsBetween} `` operator. + * @returns {!module:ol/format/filter/IsBetween~IsBetween} `` operator. * @api */ export function between(propertyName, lowerBoundary, upperBoundary) { @@ -240,7 +240,7 @@ export function between(propertyName, lowerBoundary, upperBoundary) { * @param {string=} opt_escapeChar Escape character which can be used to escape * the pattern characters. Default is '!'. * @param {boolean=} opt_matchCase Case-sensitive? - * @returns {!ol.format.filter.IsLike} `` operator. + * @returns {!module:ol/format/filter/IsLike~IsLike} `` operator. * @api */ export function like(propertyName, pattern, @@ -256,7 +256,7 @@ export function like(propertyName, pattern, * @param {!string} propertyName Name of the context property to compare. * @param {!string} begin The begin date in ISO-8601 format. * @param {!string} end The end date in ISO-8601 format. - * @returns {!ol.format.filter.During} `` operator. + * @returns {!module:ol/format/filter/During~During} `` operator. * @api */ export function during(propertyName, begin, end) { diff --git a/src/ol/format/filter/And.js b/src/ol/format/filter/And.js index d24bcf9f73..693ef6e2e8 100644 --- a/src/ol/format/filter/And.js +++ b/src/ol/format/filter/And.js @@ -10,8 +10,8 @@ import LogicalNary from '../filter/LogicalNary.js'; * * @constructor * @abstract - * @param {...ol.format.filter.Filter} conditions Conditions. - * @extends {ol.format.filter.LogicalNary} + * @param {...module:ol/format/filter/Filter~Filter} conditions Conditions. + * @extends {module:ol/format/filter/LogicalNary~LogicalNary} */ const And = function(conditions) { const params = ['And'].concat(Array.prototype.slice.call(arguments)); diff --git a/src/ol/format/filter/Bbox.js b/src/ol/format/filter/Bbox.js index 32743495f7..52e63d40b0 100644 --- a/src/ol/format/filter/Bbox.js +++ b/src/ol/format/filter/Bbox.js @@ -14,7 +14,7 @@ import Filter from '../filter/Filter.js'; * @param {!module:ol/extent~Extent} extent Extent. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @extends {ol.format.filter.Filter} + * @extends {module:ol/format/filter/Filter~Filter} * @api */ const Bbox = function(geometryName, extent, opt_srsName) { diff --git a/src/ol/format/filter/Comparison.js b/src/ol/format/filter/Comparison.js index df8d968268..32a080b3b2 100644 --- a/src/ol/format/filter/Comparison.js +++ b/src/ol/format/filter/Comparison.js @@ -13,7 +13,7 @@ import Filter from '../filter/Filter.js'; * @abstract * @param {!string} tagName The XML tag name for this filter. * @param {!string} propertyName Name of the context property to compare. - * @extends {ol.format.filter.Filter} + * @extends {module:ol/format/filter/Filter~Filter} */ const Comparison = function(tagName, propertyName) { diff --git a/src/ol/format/filter/ComparisonBinary.js b/src/ol/format/filter/ComparisonBinary.js index 3b4ee26dee..26f7225083 100644 --- a/src/ol/format/filter/ComparisonBinary.js +++ b/src/ol/format/filter/ComparisonBinary.js @@ -15,7 +15,7 @@ import Comparison from '../filter/Comparison.js'; * @param {!string} propertyName Name of the context property to compare. * @param {!(string|number)} expression The value to compare. * @param {boolean=} opt_matchCase Case-sensitive? - * @extends {ol.format.filter.Comparison} + * @extends {module:ol/format/filter/Comparison~Comparison} */ const ComparisonBinary = function(tagName, propertyName, expression, opt_matchCase) { diff --git a/src/ol/format/filter/Contains.js b/src/ol/format/filter/Contains.js index 7648c2b593..387dce8ffb 100644 --- a/src/ol/format/filter/Contains.js +++ b/src/ol/format/filter/Contains.js @@ -14,7 +14,7 @@ import Spatial from '../filter/Spatial.js'; * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @extends {ol.format.filter.Spatial} + * @extends {module:ol/format/filter/Spatial~Spatial} * @api */ const Contains = function(geometryName, geometry, opt_srsName) { diff --git a/src/ol/format/filter/During.js b/src/ol/format/filter/During.js index 8233044fc0..036de02836 100644 --- a/src/ol/format/filter/During.js +++ b/src/ol/format/filter/During.js @@ -12,7 +12,7 @@ import Comparison from '../filter/Comparison.js'; * @param {!string} propertyName Name of the context property to compare. * @param {!string} begin The begin date in ISO-8601 format. * @param {!string} end The end date in ISO-8601 format. - * @extends {ol.format.filter.Comparison} + * @extends {module:ol/format/filter/Comparison~Comparison} * @api */ const During = function(propertyName, begin, end) { diff --git a/src/ol/format/filter/EqualTo.js b/src/ol/format/filter/EqualTo.js index e122dcf090..fd0de080a8 100644 --- a/src/ol/format/filter/EqualTo.js +++ b/src/ol/format/filter/EqualTo.js @@ -12,7 +12,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js'; * @param {!string} propertyName Name of the context property to compare. * @param {!(string|number)} expression The value to compare. * @param {boolean=} opt_matchCase Case-sensitive? - * @extends {ol.format.filter.ComparisonBinary} + * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary} * @api */ const EqualTo = function(propertyName, expression, opt_matchCase) { diff --git a/src/ol/format/filter/GreaterThan.js b/src/ol/format/filter/GreaterThan.js index 38d42537fa..318d69723c 100644 --- a/src/ol/format/filter/GreaterThan.js +++ b/src/ol/format/filter/GreaterThan.js @@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js'; * @constructor * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @extends {ol.format.filter.ComparisonBinary} + * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary} * @api */ const GreaterThan = function(propertyName, expression) { diff --git a/src/ol/format/filter/GreaterThanOrEqualTo.js b/src/ol/format/filter/GreaterThanOrEqualTo.js index 668243621e..0f5c45f773 100644 --- a/src/ol/format/filter/GreaterThanOrEqualTo.js +++ b/src/ol/format/filter/GreaterThanOrEqualTo.js @@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js'; * @constructor * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @extends {ol.format.filter.ComparisonBinary} + * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary} * @api */ const GreaterThanOrEqualTo = function(propertyName, expression) { diff --git a/src/ol/format/filter/Intersects.js b/src/ol/format/filter/Intersects.js index 2d611da405..a35adc3c32 100644 --- a/src/ol/format/filter/Intersects.js +++ b/src/ol/format/filter/Intersects.js @@ -14,7 +14,7 @@ import Spatial from '../filter/Spatial.js'; * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @extends {ol.format.filter.Spatial} + * @extends {module:ol/format/filter/Spatial~Spatial} * @api */ const Intersects = function(geometryName, geometry, opt_srsName) { diff --git a/src/ol/format/filter/IsBetween.js b/src/ol/format/filter/IsBetween.js index 1742cd3262..a2e67a8dfb 100644 --- a/src/ol/format/filter/IsBetween.js +++ b/src/ol/format/filter/IsBetween.js @@ -12,7 +12,7 @@ import Comparison from '../filter/Comparison.js'; * @param {!string} propertyName Name of the context property to compare. * @param {!number} lowerBoundary The lower bound of the range. * @param {!number} upperBoundary The upper bound of the range. - * @extends {ol.format.filter.Comparison} + * @extends {module:ol/format/filter/Comparison~Comparison} * @api */ const IsBetween = function(propertyName, lowerBoundary, upperBoundary) { diff --git a/src/ol/format/filter/IsLike.js b/src/ol/format/filter/IsLike.js index fca5d6cc46..20c2d5f80e 100644 --- a/src/ol/format/filter/IsLike.js +++ b/src/ol/format/filter/IsLike.js @@ -18,7 +18,7 @@ import Comparison from '../filter/Comparison.js'; * @param {string=} opt_escapeChar Escape character which can be used to escape * the pattern characters. Default is '!'. * @param {boolean=} opt_matchCase Case-sensitive? - * @extends {ol.format.filter.Comparison} + * @extends {module:ol/format/filter/Comparison~Comparison} * @api */ const IsLike = function(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) { diff --git a/src/ol/format/filter/IsNull.js b/src/ol/format/filter/IsNull.js index 05d141e302..46b47f3918 100644 --- a/src/ol/format/filter/IsNull.js +++ b/src/ol/format/filter/IsNull.js @@ -10,7 +10,7 @@ import Comparison from '../filter/Comparison.js'; * * @constructor * @param {!string} propertyName Name of the context property to compare. - * @extends {ol.format.filter.Comparison} + * @extends {module:ol/format/filter/Comparison~Comparison} * @api */ const IsNull = function(propertyName) { diff --git a/src/ol/format/filter/LessThan.js b/src/ol/format/filter/LessThan.js index 89344e4a47..96b80529a8 100644 --- a/src/ol/format/filter/LessThan.js +++ b/src/ol/format/filter/LessThan.js @@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js'; * @constructor * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @extends {ol.format.filter.ComparisonBinary} + * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary} * @api */ const LessThan = function(propertyName, expression) { diff --git a/src/ol/format/filter/LessThanOrEqualTo.js b/src/ol/format/filter/LessThanOrEqualTo.js index 7a78d8874d..baad5b11f5 100644 --- a/src/ol/format/filter/LessThanOrEqualTo.js +++ b/src/ol/format/filter/LessThanOrEqualTo.js @@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js'; * @constructor * @param {!string} propertyName Name of the context property to compare. * @param {!number} expression The value to compare. - * @extends {ol.format.filter.ComparisonBinary} + * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary} * @api */ const LessThanOrEqualTo = function(propertyName, expression) { diff --git a/src/ol/format/filter/LogicalNary.js b/src/ol/format/filter/LogicalNary.js index dabc12968f..184dcac228 100644 --- a/src/ol/format/filter/LogicalNary.js +++ b/src/ol/format/filter/LogicalNary.js @@ -13,15 +13,15 @@ import Filter from '../filter/Filter.js'; * @constructor * @abstract * @param {!string} tagName The XML tag name for this filter. - * @param {...ol.format.filter.Filter} conditions Conditions. - * @extends {ol.format.filter.Filter} + * @param {...module:ol/format/filter/Filter~Filter} conditions Conditions. + * @extends {module:ol/format/filter/Filter~Filter} */ const LogicalNary = function(tagName, conditions) { Filter.call(this, tagName); /** - * @type {Array.} + * @type {Array.} */ this.conditions = Array.prototype.slice.call(arguments, 1); assert(this.conditions.length >= 2, 57); // At least 2 conditions are required. diff --git a/src/ol/format/filter/Not.js b/src/ol/format/filter/Not.js index f927705f5b..4eec64139d 100644 --- a/src/ol/format/filter/Not.js +++ b/src/ol/format/filter/Not.js @@ -9,8 +9,8 @@ import Filter from '../filter/Filter.js'; * Represents a logical `` operator for a filter condition. * * @constructor - * @param {!ol.format.filter.Filter} condition Filter condition. - * @extends {ol.format.filter.Filter} + * @param {!module:ol/format/filter/Filter~Filter} condition Filter condition. + * @extends {module:ol/format/filter/Filter~Filter} * @api */ const Not = function(condition) { @@ -18,7 +18,7 @@ const Not = function(condition) { Filter.call(this, 'Not'); /** - * @type {!ol.format.filter.Filter} + * @type {!module:ol/format/filter/Filter~Filter} */ this.condition = condition; }; diff --git a/src/ol/format/filter/NotEqualTo.js b/src/ol/format/filter/NotEqualTo.js index 5c651f5a3d..3b027228e8 100644 --- a/src/ol/format/filter/NotEqualTo.js +++ b/src/ol/format/filter/NotEqualTo.js @@ -12,7 +12,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js'; * @param {!string} propertyName Name of the context property to compare. * @param {!(string|number)} expression The value to compare. * @param {boolean=} opt_matchCase Case-sensitive? - * @extends {ol.format.filter.ComparisonBinary} + * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary} * @api */ const NotEqualTo = function(propertyName, expression, opt_matchCase) { diff --git a/src/ol/format/filter/Or.js b/src/ol/format/filter/Or.js index da75224d48..71e011a7b6 100644 --- a/src/ol/format/filter/Or.js +++ b/src/ol/format/filter/Or.js @@ -9,8 +9,8 @@ import LogicalNary from '../filter/LogicalNary.js'; * Represents a logical `` operator between two ore more filter conditions. * * @constructor - * @param {...ol.format.filter.Filter} conditions Conditions. - * @extends {ol.format.filter.LogicalNary} + * @param {...module:ol/format/filter/Filter~Filter} conditions Conditions. + * @extends {module:ol/format/filter/LogicalNary~LogicalNary} * @api */ const Or = function(conditions) { diff --git a/src/ol/format/filter/Spatial.js b/src/ol/format/filter/Spatial.js index 8d2d01ba6b..9165799756 100644 --- a/src/ol/format/filter/Spatial.js +++ b/src/ol/format/filter/Spatial.js @@ -17,7 +17,7 @@ import Filter from '../filter/Filter.js'; * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @extends {ol.format.filter.Filter} + * @extends {module:ol/format/filter/Filter~Filter} */ const Spatial = function(tagName, geometryName, geometry, opt_srsName) { diff --git a/src/ol/format/filter/Within.js b/src/ol/format/filter/Within.js index c1cc50db7d..34be64a35c 100644 --- a/src/ol/format/filter/Within.js +++ b/src/ol/format/filter/Within.js @@ -14,7 +14,7 @@ import Spatial from '../filter/Spatial.js'; * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {string=} opt_srsName SRS name. No srsName attribute will be * set on geometries when this is not provided. - * @extends {ol.format.filter.Spatial} + * @extends {module:ol/format/filter/Spatial~Spatial} * @api */ const Within = function(geometryName, geometry, opt_srsName) { diff --git a/src/ol/source/BingMaps.js b/src/ol/source/BingMaps.js index 0832c11c47..8887c73ca2 100644 --- a/src/ol/source/BingMaps.js +++ b/src/ol/source/BingMaps.js @@ -21,7 +21,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js'; * @property {number} [maxZoom=21] Max zoom. Default is what's advertized by the BingMaps service. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * Higher values can increase reprojection performance, but decrease precision. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src; diff --git a/src/ol/source/OSM.js b/src/ol/source/OSM.js index 785c802332..2194eb19f2 100644 --- a/src/ol/source/OSM.js +++ b/src/ol/source/OSM.js @@ -29,7 +29,7 @@ export const ATTRIBUTION = '© ' + * @property {boolean} [opaque=true] Whether the layer is opaque. * @property {number} [reprojectionErrorThreshold=1.5] Maximum allowed reprojection error (in pixels). * Higher values can increase reprojection performance, but decrease precision. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src; diff --git a/src/ol/source/Stamen.js b/src/ol/source/Stamen.js index b2fd22d682..80277d2311 100644 --- a/src/ol/source/Stamen.js +++ b/src/ol/source/Stamen.js @@ -97,7 +97,7 @@ const ProviderConfig = { * @property {boolean} [opaque] Whether the layer is opaque. * @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * Higher values can increase reprojection performance, but decrease precision. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] * Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { diff --git a/src/ol/source/TileArcGISRest.js b/src/ol/source/TileArcGISRest.js index 47bcb582df..e690f38dcc 100644 --- a/src/ol/source/TileArcGISRest.js +++ b/src/ol/source/TileArcGISRest.js @@ -34,7 +34,7 @@ import {appendParams} from '../uri.js'; * @property {ol.ProjectionLike} projection Projection. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * Higher values can increase reprojection performance, but decrease precision. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. * The default is * ```js * function(imageTile, src) { diff --git a/src/ol/source/TileImage.js b/src/ol/source/TileImage.js index 300b2c75b1..bdb71a374d 100644 --- a/src/ol/source/TileImage.js +++ b/src/ol/source/TileImage.js @@ -30,7 +30,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js'; * @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. * Default is {@link module:ol/ImageTile~ImageTile}. * @property {module:ol/tilegrid/TileGrid~TileGrid} [tileGrid] Tile grid. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src; diff --git a/src/ol/source/TileJSON.js b/src/ol/source/TileJSON.js index 1b179b8f58..a3a97f3c35 100644 --- a/src/ol/source/TileJSON.js +++ b/src/ol/source/TileJSON.js @@ -31,7 +31,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js'; * Higher values can increase reprojection performance, but decrease precision. * @property {tileJSON} [tileJSON] TileJSON configuration for this source. * If not provided, `url` must be configured. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src; diff --git a/src/ol/source/TileWMS.js b/src/ol/source/TileWMS.js index e55f92bbda..b44e96e897 100644 --- a/src/ol/source/TileWMS.js +++ b/src/ol/source/TileWMS.js @@ -53,7 +53,7 @@ import {appendParams} from '../uri.js'; * @property {ol.source.WMSServerType|string} [serverType] * The type of the remote WMS server. Currently only used when `hidpi` is * `true`. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src; diff --git a/src/ol/source/VectorTile.js b/src/ol/source/VectorTile.js index 41f1f0f1e3..8b0a62f3d4 100644 --- a/src/ol/source/VectorTile.js +++ b/src/ol/source/VectorTile.js @@ -24,7 +24,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid. * @property {module:ol/VectorTile~TileClass} [tileClass] Class used to instantiate image tiles. * Default is {@link ol.VectorTile}. * @property {module:ol/tilegrid/TileGrid~TileGrid} [tileGrid] Tile grid. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] * Optional function to load a tile given a URL. Could look like this: * ```js * function(tile, url) { diff --git a/src/ol/source/WMTS.js b/src/ol/source/WMTS.js index aac4e2e068..2169671495 100644 --- a/src/ol/source/WMTS.js +++ b/src/ol/source/WMTS.js @@ -42,7 +42,7 @@ import {appendParams} from '../uri.js'; * template. For KVP encoding, it is normal URL. A `{?-?}` template pattern, * for example `subdomain{a-f}.domain.com`, may be used instead of defining * each one separately in the `urls` option. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src; diff --git a/src/ol/source/XYZ.js b/src/ol/source/XYZ.js index c6c2f252f0..5c9e8ce616 100644 --- a/src/ol/source/XYZ.js +++ b/src/ol/source/XYZ.js @@ -20,7 +20,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js'; * @property {number} [maxZoom=18] Optional max zoom level. * @property {number} [maxZoom=0] Optional min zoom level. * @property {module:ol/tilegrid/TileGrid~TileGrid} [tileGrid] Tile grid. - * @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is + * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * ```js * function(imageTile, src) { * imageTile.getImage().src = src;