Merge pull request #8121 from fredj/jsdoc_module

More Jsdoc module fixes
This commit is contained in:
Frédéric Junod
2018-04-25 09:14:09 +02:00
committed by GitHub
37 changed files with 77 additions and 77 deletions
+1 -1
View File
@@ -10,7 +10,7 @@ import EventType from './events/EventType.js';
/** /**
* @typedef {function(new: module:ol/ImageTile~ImageTile, module:ol/tilecoord~TileCoord, * @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 * @api
*/ */
+2 -2
View File
@@ -6,8 +6,8 @@ import Tile from './Tile.js';
import TileState from './TileState.js'; import TileState from './TileState.js';
/** /**
* @typedef {function(new: ol.VectorTile, module:ol/tilecoord~TileCoord, * @typedef {function(new: module:ol/VectorTile~VectorTile, module:ol/tilecoord~TileCoord,
* module:ol/TileState, string, ?string, ol.TileLoadFunctionType)} TileClass * module:ol/TileState, string, ?string, module:ol/Tile~LoadFunction)} TileClass
* @api * @api
*/ */
+14 -14
View File
@@ -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 * 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. * Web Feature Services have repurposed `maxfeatures` instead.
* @property {module:ol/extent~Extent} [bbox] Extent to use for the BBOX filter. * @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. * {@link ol.format.filter} for more information.
* @property {string} [resultType] Indicates what response should be returned, * @property {string} [resultType] Indicates what response should be returned,
* E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features. * 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 {Node} node Node.
* @param {ol.format.filter.Filter} filter Filter. * @param {module:ol/format/filter/Filter~Filter} filter Filter.
* @param {Array.<*>} objectStack Node stack. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeFilterCondition(node, filter, objectStack) { function writeFilterCondition(node, filter, objectStack) {
@@ -695,7 +695,7 @@ function writeFilterCondition(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeBboxFilter(node, filter, objectStack) { function writeBboxFilter(node, filter, objectStack) {
@@ -709,7 +709,7 @@ function writeBboxFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeContainsFilter(node, filter, objectStack) { function writeContainsFilter(node, filter, objectStack) {
@@ -723,7 +723,7 @@ function writeContainsFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeIntersectsFilter(node, filter, objectStack) { function writeIntersectsFilter(node, filter, objectStack) {
@@ -737,7 +737,7 @@ function writeIntersectsFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeWithinFilter(node, filter, objectStack) { function writeWithinFilter(node, filter, objectStack) {
@@ -751,7 +751,7 @@ function writeWithinFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeDuringFilter(node, filter, objectStack) { function writeDuringFilter(node, filter, objectStack) {
@@ -776,7 +776,7 @@ function writeDuringFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeLogicalFilter(node, filter, objectStack) { function writeLogicalFilter(node, filter, objectStack) {
@@ -795,7 +795,7 @@ function writeLogicalFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeNotFilter(node, filter, objectStack) { function writeNotFilter(node, filter, objectStack) {
@@ -811,7 +811,7 @@ function writeNotFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeComparisonFilter(node, filter, objectStack) { function writeComparisonFilter(node, filter, objectStack) {
@@ -825,7 +825,7 @@ function writeComparisonFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeIsNullFilter(node, filter, objectStack) { function writeIsNullFilter(node, filter, objectStack) {
@@ -835,7 +835,7 @@ function writeIsNullFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeIsBetweenFilter(node, filter, objectStack) { function writeIsBetweenFilter(node, filter, objectStack) {
@@ -853,7 +853,7 @@ function writeIsBetweenFilter(node, filter, objectStack) {
/** /**
* @param {Node} node Node. * @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. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeIsLikeFilter(node, filter, objectStack) { function writeIsLikeFilter(node, filter, objectStack) {
@@ -915,7 +915,7 @@ function writeTimeInstant(node, time) {
/** /**
* Encode filter as WFS `Filter` and return the Node. * 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. * @return {Node} Result.
* @api * @api
*/ */
+2 -2
View File
@@ -18,7 +18,7 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js';
/** /**
* @classdesc * @classdesc
* Format for reading WMSGetFeatureInfo format. It uses * Format for reading WMSGetFeatureInfo format. It uses
* {@link ol.format.GML2} to read features. * {@link module:ol/format/GML2~GML2} to read features.
* *
* @constructor * @constructor
* @extends {module:ol/format/XMLFeature~XMLFeature} * @extends {module:ol/format/XMLFeature~XMLFeature}
@@ -38,7 +38,7 @@ const WMSGetFeatureInfo = function(opt_options) {
/** /**
* @private * @private
* @type {ol.format.GML2} * @type {module:ol/format/GML2~GML2}
*/ */
this.gmlFormat_ = new GML2(); this.gmlFormat_ = new GML2();
+1 -1
View File
@@ -22,7 +22,7 @@ const WMTSCapabilities = function() {
XML.call(this); XML.call(this);
/** /**
* @type {ol.format.OWS} * @type {module:ol/format/OWS~OWS}
* @private * @private
*/ */
this.owsParser_ = new OWS(); this.owsParser_ = new OWS();
+20 -20
View File
@@ -23,8 +23,8 @@ import Within from '../format/filter/Within.js';
/** /**
* Create a logical `<And>` operator between two or more filter conditions. * Create a logical `<And>` operator between two or more filter conditions.
* *
* @param {...ol.format.filter.Filter} conditions Filter conditions. * @param {...module:ol/format/filter/Filter~Filter} conditions Filter conditions.
* @returns {!ol.format.filter.And} `<And>` operator. * @returns {!module:ol/format/filter/And~And} `<And>` operator.
* @api * @api
*/ */
export function and(conditions) { export function and(conditions) {
@@ -36,8 +36,8 @@ export function and(conditions) {
/** /**
* Create a logical `<Or>` operator between two or more filter conditions. * Create a logical `<Or>` operator between two or more filter conditions.
* *
* @param {...ol.format.filter.Filter} conditions Filter conditions. * @param {...module:ol/format/filter/Filter~Filter} conditions Filter conditions.
* @returns {!ol.format.filter.Or} `<Or>` operator. * @returns {!module:ol/format/filter/Or~Or} `<Or>` operator.
* @api * @api
*/ */
export function or(conditions) { export function or(conditions) {
@@ -49,8 +49,8 @@ export function or(conditions) {
/** /**
* Represents a logical `<Not>` operator for a filter condition. * Represents a logical `<Not>` operator for a filter condition.
* *
* @param {!ol.format.filter.Filter} condition Filter condition. * @param {!module:ol/format/filter/Filter~Filter} condition Filter condition.
* @returns {!ol.format.filter.Not} `<Not>` operator. * @returns {!module:ol/format/filter/Not~Not} `<Not>` operator.
* @api * @api
*/ */
export function not(condition) { export function not(condition) {
@@ -66,7 +66,7 @@ export function not(condition) {
* @param {!module:ol/extent~Extent} extent Extent. * @param {!module:ol/extent~Extent} extent Extent.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @returns {!ol.format.filter.Bbox} `<BBOX>` operator. * @returns {!module:ol/format/filter/Bbox~Bbox} `<BBOX>` operator.
* @api * @api
*/ */
export function bbox(geometryName, extent, opt_srsName) { 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 {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @returns {!ol.format.filter.Contains} `<Contains>` operator. * @returns {!module:ol/format/filter/Contains~Contains} `<Contains>` operator.
* @api * @api
*/ */
export function contains(geometryName, geometry, opt_srsName) { 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 {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @returns {!ol.format.filter.Intersects} `<Intersects>` operator. * @returns {!module:ol/format/filter/Intersects~Intersects} `<Intersects>` operator.
* @api * @api
*/ */
export function intersects(geometryName, geometry, opt_srsName) { 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 {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @returns {!ol.format.filter.Within} `<Within>` operator. * @returns {!module:ol/format/filter/Within~Within} `<Within>` operator.
* @api * @api
*/ */
export function within(geometryName, geometry, opt_srsName) { 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} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @returns {!ol.format.filter.EqualTo} `<PropertyIsEqualTo>` operator. * @returns {!module:ol/format/filter/EqualTo~EqualTo} `<PropertyIsEqualTo>` operator.
* @api * @api
*/ */
export function equalTo(propertyName, expression, opt_matchCase) { 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} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @returns {!ol.format.filter.NotEqualTo} `<PropertyIsNotEqualTo>` operator. * @returns {!module:ol/format/filter/NotEqualTo~NotEqualTo} `<PropertyIsNotEqualTo>` operator.
* @api * @api
*/ */
export function notEqualTo(propertyName, expression, opt_matchCase) { 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 {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @returns {!ol.format.filter.LessThan} `<PropertyIsLessThan>` operator. * @returns {!module:ol/format/filter/LessThan~LessThan} `<PropertyIsLessThan>` operator.
* @api * @api
*/ */
export function lessThan(propertyName, expression) { 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 {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @returns {!ol.format.filter.LessThanOrEqualTo} `<PropertyIsLessThanOrEqualTo>` operator. * @returns {!module:ol/format/filter/LessThanOrEqualTo~LessThanOrEqualTo} `<PropertyIsLessThanOrEqualTo>` operator.
* @api * @api
*/ */
export function lessThanOrEqualTo(propertyName, expression) { 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 {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @returns {!ol.format.filter.GreaterThan} `<PropertyIsGreaterThan>` operator. * @returns {!module:ol/format/filter/GreaterThan~GreaterThan} `<PropertyIsGreaterThan>` operator.
* @api * @api
*/ */
export function greaterThan(propertyName, expression) { 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 {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @returns {!ol.format.filter.GreaterThanOrEqualTo} `<PropertyIsGreaterThanOrEqualTo>` operator. * @returns {!module:ol/format/filter/GreaterThanOrEqualTo~GreaterThanOrEqualTo} `<PropertyIsGreaterThanOrEqualTo>` operator.
* @api * @api
*/ */
export function greaterThanOrEqualTo(propertyName, expression) { export function greaterThanOrEqualTo(propertyName, expression) {
@@ -204,7 +204,7 @@ export function greaterThanOrEqualTo(propertyName, expression) {
* is null. * is null.
* *
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @returns {!ol.format.filter.IsNull} `<PropertyIsNull>` operator. * @returns {!module:ol/format/filter/IsNull~IsNull} `<PropertyIsNull>` operator.
* @api * @api
*/ */
export function isNull(propertyName) { export function isNull(propertyName) {
@@ -219,7 +219,7 @@ export function isNull(propertyName) {
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} lowerBoundary The lower bound of the range. * @param {!number} lowerBoundary The lower bound of the range.
* @param {!number} upperBoundary The upper bound of the range. * @param {!number} upperBoundary The upper bound of the range.
* @returns {!ol.format.filter.IsBetween} `<PropertyIsBetween>` operator. * @returns {!module:ol/format/filter/IsBetween~IsBetween} `<PropertyIsBetween>` operator.
* @api * @api
*/ */
export function between(propertyName, lowerBoundary, upperBoundary) { 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 * @param {string=} opt_escapeChar Escape character which can be used to escape
* the pattern characters. Default is '!'. * the pattern characters. Default is '!'.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @returns {!ol.format.filter.IsLike} `<PropertyIsLike>` operator. * @returns {!module:ol/format/filter/IsLike~IsLike} `<PropertyIsLike>` operator.
* @api * @api
*/ */
export function like(propertyName, pattern, 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} propertyName Name of the context property to compare.
* @param {!string} begin The begin date in ISO-8601 format. * @param {!string} begin The begin date in ISO-8601 format.
* @param {!string} end The end date in ISO-8601 format. * @param {!string} end The end date in ISO-8601 format.
* @returns {!ol.format.filter.During} `<During>` operator. * @returns {!module:ol/format/filter/During~During} `<During>` operator.
* @api * @api
*/ */
export function during(propertyName, begin, end) { export function during(propertyName, begin, end) {
+2 -2
View File
@@ -10,8 +10,8 @@ import LogicalNary from '../filter/LogicalNary.js';
* *
* @constructor * @constructor
* @abstract * @abstract
* @param {...ol.format.filter.Filter} conditions Conditions. * @param {...module:ol/format/filter/Filter~Filter} conditions Conditions.
* @extends {ol.format.filter.LogicalNary} * @extends {module:ol/format/filter/LogicalNary~LogicalNary}
*/ */
const And = function(conditions) { const And = function(conditions) {
const params = ['And'].concat(Array.prototype.slice.call(arguments)); const params = ['And'].concat(Array.prototype.slice.call(arguments));
+1 -1
View File
@@ -14,7 +14,7 @@ import Filter from '../filter/Filter.js';
* @param {!module:ol/extent~Extent} extent Extent. * @param {!module:ol/extent~Extent} extent Extent.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @extends {ol.format.filter.Filter} * @extends {module:ol/format/filter/Filter~Filter}
* @api * @api
*/ */
const Bbox = function(geometryName, extent, opt_srsName) { const Bbox = function(geometryName, extent, opt_srsName) {
+1 -1
View File
@@ -13,7 +13,7 @@ import Filter from '../filter/Filter.js';
* @abstract * @abstract
* @param {!string} tagName The XML tag name for this filter. * @param {!string} tagName The XML tag name for this filter.
* @param {!string} propertyName Name of the context property to compare. * @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) { const Comparison = function(tagName, propertyName) {
+1 -1
View File
@@ -15,7 +15,7 @@ import Comparison from '../filter/Comparison.js';
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @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) { const ComparisonBinary = function(tagName, propertyName, expression, opt_matchCase) {
+1 -1
View File
@@ -14,7 +14,7 @@ import Spatial from '../filter/Spatial.js';
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @extends {ol.format.filter.Spatial} * @extends {module:ol/format/filter/Spatial~Spatial}
* @api * @api
*/ */
const Contains = function(geometryName, geometry, opt_srsName) { const Contains = function(geometryName, geometry, opt_srsName) {
+1 -1
View File
@@ -12,7 +12,7 @@ import Comparison from '../filter/Comparison.js';
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!string} begin The begin date in ISO-8601 format. * @param {!string} begin The begin date in ISO-8601 format.
* @param {!string} end The end 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 * @api
*/ */
const During = function(propertyName, begin, end) { const During = function(propertyName, begin, end) {
+1 -1
View File
@@ -12,7 +12,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @extends {ol.format.filter.ComparisonBinary} * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @api * @api
*/ */
const EqualTo = function(propertyName, expression, opt_matchCase) { const EqualTo = function(propertyName, expression, opt_matchCase) {
+1 -1
View File
@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor * @constructor
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @extends {ol.format.filter.ComparisonBinary} * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @api * @api
*/ */
const GreaterThan = function(propertyName, expression) { const GreaterThan = function(propertyName, expression) {
+1 -1
View File
@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor * @constructor
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @extends {ol.format.filter.ComparisonBinary} * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @api * @api
*/ */
const GreaterThanOrEqualTo = function(propertyName, expression) { const GreaterThanOrEqualTo = function(propertyName, expression) {
+1 -1
View File
@@ -14,7 +14,7 @@ import Spatial from '../filter/Spatial.js';
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @extends {ol.format.filter.Spatial} * @extends {module:ol/format/filter/Spatial~Spatial}
* @api * @api
*/ */
const Intersects = function(geometryName, geometry, opt_srsName) { const Intersects = function(geometryName, geometry, opt_srsName) {
+1 -1
View File
@@ -12,7 +12,7 @@ import Comparison from '../filter/Comparison.js';
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} lowerBoundary The lower bound of the range. * @param {!number} lowerBoundary The lower bound of the range.
* @param {!number} upperBoundary The upper 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 * @api
*/ */
const IsBetween = function(propertyName, lowerBoundary, upperBoundary) { const IsBetween = function(propertyName, lowerBoundary, upperBoundary) {
+1 -1
View File
@@ -18,7 +18,7 @@ import Comparison from '../filter/Comparison.js';
* @param {string=} opt_escapeChar Escape character which can be used to escape * @param {string=} opt_escapeChar Escape character which can be used to escape
* the pattern characters. Default is '!'. * the pattern characters. Default is '!'.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @extends {ol.format.filter.Comparison} * @extends {module:ol/format/filter/Comparison~Comparison}
* @api * @api
*/ */
const IsLike = function(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) { const IsLike = function(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) {
+1 -1
View File
@@ -10,7 +10,7 @@ import Comparison from '../filter/Comparison.js';
* *
* @constructor * @constructor
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @extends {ol.format.filter.Comparison} * @extends {module:ol/format/filter/Comparison~Comparison}
* @api * @api
*/ */
const IsNull = function(propertyName) { const IsNull = function(propertyName) {
+1 -1
View File
@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor * @constructor
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @extends {ol.format.filter.ComparisonBinary} * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @api * @api
*/ */
const LessThan = function(propertyName, expression) { const LessThan = function(propertyName, expression) {
+1 -1
View File
@@ -11,7 +11,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @constructor * @constructor
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @extends {ol.format.filter.ComparisonBinary} * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @api * @api
*/ */
const LessThanOrEqualTo = function(propertyName, expression) { const LessThanOrEqualTo = function(propertyName, expression) {
+3 -3
View File
@@ -13,15 +13,15 @@ import Filter from '../filter/Filter.js';
* @constructor * @constructor
* @abstract * @abstract
* @param {!string} tagName The XML tag name for this filter. * @param {!string} tagName The XML tag name for this filter.
* @param {...ol.format.filter.Filter} conditions Conditions. * @param {...module:ol/format/filter/Filter~Filter} conditions Conditions.
* @extends {ol.format.filter.Filter} * @extends {module:ol/format/filter/Filter~Filter}
*/ */
const LogicalNary = function(tagName, conditions) { const LogicalNary = function(tagName, conditions) {
Filter.call(this, tagName); Filter.call(this, tagName);
/** /**
* @type {Array.<ol.format.filter.Filter>} * @type {Array.<module:ol/format/filter/Filter~Filter>}
*/ */
this.conditions = Array.prototype.slice.call(arguments, 1); this.conditions = Array.prototype.slice.call(arguments, 1);
assert(this.conditions.length >= 2, 57); // At least 2 conditions are required. assert(this.conditions.length >= 2, 57); // At least 2 conditions are required.
+3 -3
View File
@@ -9,8 +9,8 @@ import Filter from '../filter/Filter.js';
* Represents a logical `<Not>` operator for a filter condition. * Represents a logical `<Not>` operator for a filter condition.
* *
* @constructor * @constructor
* @param {!ol.format.filter.Filter} condition Filter condition. * @param {!module:ol/format/filter/Filter~Filter} condition Filter condition.
* @extends {ol.format.filter.Filter} * @extends {module:ol/format/filter/Filter~Filter}
* @api * @api
*/ */
const Not = function(condition) { const Not = function(condition) {
@@ -18,7 +18,7 @@ const Not = function(condition) {
Filter.call(this, 'Not'); Filter.call(this, 'Not');
/** /**
* @type {!ol.format.filter.Filter} * @type {!module:ol/format/filter/Filter~Filter}
*/ */
this.condition = condition; this.condition = condition;
}; };
+1 -1
View File
@@ -12,7 +12,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @extends {ol.format.filter.ComparisonBinary} * @extends {module:ol/format/filter/ComparisonBinary~ComparisonBinary}
* @api * @api
*/ */
const NotEqualTo = function(propertyName, expression, opt_matchCase) { const NotEqualTo = function(propertyName, expression, opt_matchCase) {
+2 -2
View File
@@ -9,8 +9,8 @@ import LogicalNary from '../filter/LogicalNary.js';
* Represents a logical `<Or>` operator between two ore more filter conditions. * Represents a logical `<Or>` operator between two ore more filter conditions.
* *
* @constructor * @constructor
* @param {...ol.format.filter.Filter} conditions Conditions. * @param {...module:ol/format/filter/Filter~Filter} conditions Conditions.
* @extends {ol.format.filter.LogicalNary} * @extends {module:ol/format/filter/LogicalNary~LogicalNary}
* @api * @api
*/ */
const Or = function(conditions) { const Or = function(conditions) {
+1 -1
View File
@@ -17,7 +17,7 @@ import Filter from '../filter/Filter.js';
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * 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) { const Spatial = function(tagName, geometryName, geometry, opt_srsName) {
+1 -1
View File
@@ -14,7 +14,7 @@ import Spatial from '../filter/Spatial.js';
* @param {!module:ol/geom/Geometry~Geometry} geometry Geometry. * @param {!module:ol/geom/Geometry~Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @extends {ol.format.filter.Spatial} * @extends {module:ol/format/filter/Spatial~Spatial}
* @api * @api
*/ */
const Within = function(geometryName, geometry, opt_srsName) { const Within = function(geometryName, geometry, opt_srsName) {
+1 -1
View File
@@ -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} [maxZoom=21] Max zoom. Default is what's advertized by the BingMaps service.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision. * 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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;
+1 -1
View File
@@ -29,7 +29,7 @@ export const ATTRIBUTION = '&copy; ' +
* @property {boolean} [opaque=true] Whether the layer is opaque. * @property {boolean} [opaque=true] Whether the layer is opaque.
* @property {number} [reprojectionErrorThreshold=1.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=1.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision. * 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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;
+1 -1
View File
@@ -97,7 +97,7 @@ const ProviderConfig = {
* @property {boolean} [opaque] Whether the layer is opaque. * @property {boolean} [opaque] Whether the layer is opaque.
* @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision. * 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 * Optional function to load a tile given a URL. The default is
* ```js * ```js
* function(imageTile, src) { * function(imageTile, src) {
+1 -1
View File
@@ -34,7 +34,7 @@ import {appendParams} from '../uri.js';
* @property {ol.ProjectionLike} projection Projection. * @property {ol.ProjectionLike} projection Projection.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision. * 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 * The default is
* ```js * ```js
* function(imageTile, src) { * function(imageTile, src) {
+1 -1
View File
@@ -30,7 +30,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js';
* @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. * @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles.
* Default is {@link module:ol/ImageTile~ImageTile}. * Default is {@link module:ol/ImageTile~ImageTile}.
* @property {module:ol/tilegrid/TileGrid~TileGrid} [tileGrid] Tile grid. * @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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;
+1 -1
View File
@@ -31,7 +31,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* Higher values can increase reprojection performance, but decrease precision. * Higher values can increase reprojection performance, but decrease precision.
* @property {tileJSON} [tileJSON] TileJSON configuration for this source. * @property {tileJSON} [tileJSON] TileJSON configuration for this source.
* If not provided, `url` must be configured. * 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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;
+1 -1
View File
@@ -53,7 +53,7 @@ import {appendParams} from '../uri.js';
* @property {ol.source.WMSServerType|string} [serverType] * @property {ol.source.WMSServerType|string} [serverType]
* The type of the remote WMS server. Currently only used when `hidpi` is * The type of the remote WMS server. Currently only used when `hidpi` is
* `true`. * `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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;
+1 -1
View File
@@ -24,7 +24,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid.
* @property {module:ol/VectorTile~TileClass} [tileClass] Class used to instantiate image tiles. * @property {module:ol/VectorTile~TileClass} [tileClass] Class used to instantiate image tiles.
* Default is {@link ol.VectorTile}. * Default is {@link ol.VectorTile}.
* @property {module:ol/tilegrid/TileGrid~TileGrid} [tileGrid] Tile grid. * @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: * Optional function to load a tile given a URL. Could look like this:
* ```js * ```js
* function(tile, url) { * function(tile, url) {
+1 -1
View File
@@ -42,7 +42,7 @@ import {appendParams} from '../uri.js';
* template. For KVP encoding, it is normal URL. A `{?-?}` template pattern, * template. For KVP encoding, it is normal URL. A `{?-?}` template pattern,
* for example `subdomain{a-f}.domain.com`, may be used instead of defining * for example `subdomain{a-f}.domain.com`, may be used instead of defining
* each one separately in the `urls` option. * 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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;
+1 -1
View File
@@ -20,7 +20,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* @property {number} [maxZoom=18] Optional max zoom level. * @property {number} [maxZoom=18] Optional max zoom level.
* @property {number} [maxZoom=0] Optional min zoom level. * @property {number} [maxZoom=0] Optional min zoom level.
* @property {module:ol/tilegrid/TileGrid~TileGrid} [tileGrid] Tile grid. * @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 * ```js
* function(imageTile, src) { * function(imageTile, src) {
* imageTile.getImage().src = src; * imageTile.getImage().src = src;