diff --git a/src/ol/Object.js b/src/ol/Object.js index 3343b6521f..da5b8dc294 100644 --- a/src/ol/Object.js +++ b/src/ol/Object.js @@ -87,7 +87,7 @@ class BaseObject extends Observable { constructor(opt_values) { super(); - // Call {@link module:ol/util~getUid} to ensure that the order of objects' ids is + // Call {@link module:ol/util.getUid} to ensure that the order of objects' ids is // the same as the order in which they were created. This also helps to // ensure that object properties are always added in the same order, which // helps many JavaScript engines generate faster code. diff --git a/src/ol/Overlay.js b/src/ol/Overlay.js index 869eac4614..7141e75335 100644 --- a/src/ol/Overlay.js +++ b/src/ol/Overlay.js @@ -61,7 +61,7 @@ import {outerHeight, outerWidth, removeChildren, removeNode} from './dom.js'; * milliseconds. * @property {function(number):number} [easing] The easing function to use. Can * be one from {@link module:ol/easing} or a custom function. - * Default is {@link module:ol/easing~inAndOut}. + * Default is {@link module:ol/easing.inAndOut}. */ /** diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index f21179a16a..58cf9aacee 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -91,12 +91,12 @@ import {removeNode} from './dom.js'; * @typedef {Object} MapOptions * @property {Collection|Array} [controls] * Controls initially added to the map. If not specified, - * {@link module:ol/control~defaults} is used. + * {@link module:ol/control.defaults} is used. * @property {number} [pixelRatio=window.devicePixelRatio] The ratio between * physical pixels and device-independent pixels (dips) on the device. * @property {Collection|Array} [interactions] * Interactions that are initially added to the map. If not specified, - * {@link module:ol/interaction~defaults} is used. + * {@link module:ol/interaction.defaults} is used. * @property {HTMLElement|Document|string} [keyboardEventTarget] The element to * listen to keyboard events on. This determines when the `KeyboardPan` and * `KeyboardZoom` interactions trigger. For example, if this option is set to diff --git a/src/ol/View.js b/src/ol/View.js index 02f04e3c4a..1e3b45a92c 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -91,7 +91,7 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js'; * @property {number} [duration] The duration of the animation in milliseconds. * By default, there is no animation to the target extent. * @property {function(number):number} [easing] The easing function used during - * the animation (defaults to {@link module:ol/easing~inAndOut}). + * the animation (defaults to {@link module:ol/easing.inAndOut}). * The function will be called for each frame with a number representing a * fraction of the animation's duration. The function should return a number * between 0 and 1 representing the progress toward the destination state. @@ -197,7 +197,7 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js'; * during a rotation or resolution animation. * @property {number} [duration=1000] The duration of the animation in milliseconds. * @property {function(number):number} [easing] The easing function used - * during the animation (defaults to {@link module:ol/easing~inAndOut}). + * during the animation (defaults to {@link module:ol/easing.inAndOut}). * The function will be called for each frame with a number representing a * fraction of the animation's duration. The function should return a number * between 0 and 1 representing the progress toward the destination state. diff --git a/src/ol/easing.js b/src/ol/easing.js index b6a6c51f51..368ed6fc6a 100644 --- a/src/ol/easing.js +++ b/src/ol/easing.js @@ -44,7 +44,7 @@ export function linear(t) { /** * Start slow, speed up, and at the very end slow down again. This has the - * same general behavior as {@link module:ol/easing~inAndOut}, but the final + * same general behavior as {@link module:ol/easing.inAndOut}, but the final * slowdown is delayed. * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. diff --git a/src/ol/events.js b/src/ol/events.js index c7b3e8db0d..937ca5c6d6 100644 --- a/src/ol/events.js +++ b/src/ol/events.js @@ -34,7 +34,7 @@ import {clear} from './obj.js'; * https://google.github.io/closure-library/api/source/closure/goog/events/events.js.src.html * * This function efficiently binds a `listener` to a `this` object, and returns - * a key for use with {@link module:ol/events~unlistenByKey}. + * a key for use with {@link module:ol/events.unlistenByKey}. * * @param {import("./events/Target.js").EventTargetLike} target Event target. * @param {string} type Event type. @@ -70,10 +70,10 @@ export function listen(target, type, listener, opt_this, opt_once) { * * This function efficiently binds a `listener` as self-unregistering listener * to a `this` object, and returns a key for use with - * {@link module:ol/events~unlistenByKey} in case the listener needs to be + * {@link module:ol/events.unlistenByKey} in case the listener needs to be * unregistered before it is called. * - * When {@link module:ol/events~listen} is called with the same arguments after this + * When {@link module:ol/events.listen} is called with the same arguments after this * function, the self-unregistering listener will be turned into a permanent * listener. * @@ -93,7 +93,7 @@ export function listenOnce(target, type, listener, opt_this) { * https://google.github.io/closure-library/api/source/closure/goog/events/events.js.src.html * * The argument passed to this function is the key returned from - * {@link module:ol/events~listen} or {@link module:ol/events~listenOnce}. + * {@link module:ol/events.listen} or {@link module:ol/events.listenOnce}. * * @param {EventsKey} key The key. */ diff --git a/src/ol/interaction/DragPan.js b/src/ol/interaction/DragPan.js index f13a932751..074e72f4c4 100644 --- a/src/ol/interaction/DragPan.js +++ b/src/ol/interaction/DragPan.js @@ -21,7 +21,7 @@ import { * @typedef {Object} Options * @property {import("../events/condition.js").Condition} [condition] A function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean * to indicate whether that event should be handled. - * Default is {@link module:ol/events/condition~noModifierKeys} and {@link module:ol/events/condition~primaryAction}. + * Default is {@link module:ol/events/condition.noModifierKeys} and {@link module:ol/events/condition.primaryAction}. * @property {boolean} [onFocusOnly=false] When the map's target has a `tabindex` attribute set, * the interaction will only handle events when the map has the focus. * @property {import("../Kinetic.js").default} [kinetic] Kinetic inertia to apply to the pan. diff --git a/src/ol/interaction/DragRotate.js b/src/ol/interaction/DragRotate.js index cb04464fb5..fea884c2ca 100644 --- a/src/ol/interaction/DragRotate.js +++ b/src/ol/interaction/DragRotate.js @@ -15,7 +15,7 @@ import {disable} from '../rotationconstraint.js'; * @property {import("../events/condition.js").Condition} [condition] A function that takes an * {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a boolean * to indicate whether that event should be handled. - * Default is {@link module:ol/events/condition~altShiftKeysOnly}. + * Default is {@link module:ol/events/condition.altShiftKeysOnly}. * @property {number} [duration=250] Animation duration in milliseconds. */ diff --git a/src/ol/interaction/DragRotateAndZoom.js b/src/ol/interaction/DragRotateAndZoom.js index 99bbb5d5e9..c6637cebb6 100644 --- a/src/ol/interaction/DragRotateAndZoom.js +++ b/src/ol/interaction/DragRotateAndZoom.js @@ -9,7 +9,7 @@ import {mouseOnly, shiftKeyOnly} from '../events/condition.js'; * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. - * Default is {@link module:ol/events/condition~shiftKeyOnly}. + * Default is {@link module:ol/events/condition.shiftKeyOnly}. * @property {number} [duration=400] Animation duration in milliseconds. */ diff --git a/src/ol/interaction/DragZoom.js b/src/ol/interaction/DragZoom.js index 46b6d10b27..5cb6ce30b6 100644 --- a/src/ol/interaction/DragZoom.js +++ b/src/ol/interaction/DragZoom.js @@ -12,7 +12,7 @@ import {shiftKeyOnly} from '../events/condition.js'; * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. - * Default is {@link module:ol/events/condition~shiftKeyOnly}. + * Default is {@link module:ol/events/condition.shiftKeyOnly}. * @property {number} [duration=200] Animation duration in milliseconds. * @property {boolean} [out=false] Use interaction for zooming out. * @property {number} [minArea=64] The minimum area of the box in pixel, this value is used by the parent default diff --git a/src/ol/interaction/Draw.js b/src/ol/interaction/Draw.js index 960945320f..bbbd068fa2 100644 --- a/src/ol/interaction/Draw.js +++ b/src/ol/interaction/Draw.js @@ -70,7 +70,7 @@ import {squaredDistance as squaredCoordinateDistance} from '../coordinate.js'; * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. - * By default {@link module:ol/events/condition~noModifierKeys}, i.e. a click, + * By default {@link module:ol/events/condition.noModifierKeys}, i.e. a click, * adds a vertex or deactivates freehand drawing. * @property {boolean} [freehand=false] Operate in freehand mode for lines, * polygons, and circles. This makes the interaction always operate in freehand @@ -79,7 +79,7 @@ import {squaredDistance as squaredCoordinateDistance} from '../coordinate.js'; * Condition that activates freehand drawing for lines and polygons. This * function takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and * returns a boolean to indicate whether that event should be handled. The - * default is {@link module:ol/events/condition~shiftKeyOnly}, meaning that the + * default is {@link module:ol/events/condition.shiftKeyOnly}, meaning that the * Shift key activates freehand drawing. * @property {boolean} [wrapX=false] Wrap the world horizontally on the sketch * overlay. diff --git a/src/ol/interaction/Extent.js b/src/ol/interaction/Extent.js index 9dc85b21c4..786605c259 100644 --- a/src/ol/interaction/Extent.js +++ b/src/ol/interaction/Extent.js @@ -26,7 +26,7 @@ import {toUserExtent} from '../proj.js'; * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. - * Default is {@link module:ol/events/condition~always}. + * Default is {@link module:ol/events/condition.always}. * @property {import("../extent.js").Extent} [extent] Initial extent. Defaults to no * initial extent. * @property {import("../style/Style.js").StyleLike} [boxStyle] diff --git a/src/ol/interaction/KeyboardPan.js b/src/ol/interaction/KeyboardPan.js index c7b49917db..6ed2168cbe 100644 --- a/src/ol/interaction/KeyboardPan.js +++ b/src/ol/interaction/KeyboardPan.js @@ -12,8 +12,8 @@ import {rotate as rotateCoordinate} from '../coordinate.js'; * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. Default is - * {@link module:ol/events/condition~noModifierKeys} and - * {@link module:ol/events/condition~targetNotEditable}. + * {@link module:ol/events/condition.noModifierKeys} and + * {@link module:ol/events/condition.targetNotEditable}. * @property {number} [duration=100] Animation duration in milliseconds. * @property {number} [pixelDelta=128] The amount of pixels to pan on each key * press. diff --git a/src/ol/interaction/KeyboardZoom.js b/src/ol/interaction/KeyboardZoom.js index 9dc139170d..f31cd51f87 100644 --- a/src/ol/interaction/KeyboardZoom.js +++ b/src/ol/interaction/KeyboardZoom.js @@ -11,7 +11,7 @@ import {targetNotEditable} from '../events/condition.js'; * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. Default is - * {@link module:ol/events/condition~targetNotEditable}. + * {@link module:ol/events/condition.targetNotEditable}. * @property {number} [delta=1] The zoom level delta on each key press. */ diff --git a/src/ol/interaction/Modify.js b/src/ol/interaction/Modify.js index 82df1c7604..d827c5f38d 100644 --- a/src/ol/interaction/Modify.js +++ b/src/ol/interaction/Modify.js @@ -95,16 +95,16 @@ const ModifyEventType = { * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event will be considered to add or move a * vertex to the sketch. Default is - * {@link module:ol/events/condition~primaryAction}. + * {@link module:ol/events/condition.primaryAction}. * @property {import("../events/condition.js").Condition} [deleteCondition] A function * that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. By default, - * {@link module:ol/events/condition~singleClick} with - * {@link module:ol/events/condition~altKeyOnly} results in a vertex deletion. + * {@link module:ol/events/condition.singleClick} with + * {@link module:ol/events/condition.altKeyOnly} results in a vertex deletion. * @property {import("../events/condition.js").Condition} [insertVertexCondition] A * function that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and * returns a boolean to indicate whether a new vertex should be added to the sketch - * features. Default is {@link module:ol/events/condition~always}. + * features. Default is {@link module:ol/events/condition.always}. * @property {number} [pixelTolerance=10] Pixel tolerance for considering the * pointer close enough to a segment or vertex for editing. * @property {import("../style/Style.js").StyleLike} [style] diff --git a/src/ol/interaction/MouseWheelZoom.js b/src/ol/interaction/MouseWheelZoom.js index 2b0d1b912f..2b6bbb3cd5 100644 --- a/src/ol/interaction/MouseWheelZoom.js +++ b/src/ol/interaction/MouseWheelZoom.js @@ -20,7 +20,7 @@ export const Mode = { * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. Default is - * {@link module:ol/events/condition~always}. + * {@link module:ol/events/condition.always}. * @property {boolean} [onFocusOnly=false] When the map's target has a `tabindex` attribute set, * the interaction will only handle events when the map has the focus. * @property {number} [maxDelta=1] Maximum mouse wheel delta. diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index 14fc85e485..cfebd186b4 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -38,13 +38,13 @@ const SelectEventType = { * @property {import("../events/condition.js").Condition} [addCondition] A function * that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. - * By default, this is {@link module:ol/events/condition~never}. Use this if you + * By default, this is {@link module:ol/events/condition.never}. Use this if you * want to use different events for add and remove instead of `toggle`. * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. This is the event * for the selected features as a whole. By default, this is - * {@link module:ol/events/condition~singleClick}. Clicking on a feature selects that + * {@link module:ol/events/condition.singleClick}. Clicking on a feature selects that * feature and removes any that were in the selection. Clicking outside any * feature removes all from the selection. * See `toggle`, `add`, `remove` options for adding/removing extra features to/ @@ -63,13 +63,13 @@ const SelectEventType = { * @property {import("../events/condition.js").Condition} [removeCondition] A function * that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. - * By default, this is {@link module:ol/events/condition~never}. Use this if you + * By default, this is {@link module:ol/events/condition.never}. Use this if you * want to use different events for add and remove instead of `toggle`. * @property {import("../events/condition.js").Condition} [toggleCondition] A function * that takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. This is in addition * to the `condition` event. By default, - * {@link module:ol/events/condition~shiftKeyOnly}, i.e. pressing `shift` as + * {@link module:ol/events/condition.shiftKeyOnly}, i.e. pressing `shift` as * well as the `condition` event, adds that feature to the current selection if * it is not currently selected, and removes it if it is. See `add` and `remove` * if you want to use different events instead of a toggle. diff --git a/src/ol/proj.js b/src/ol/proj.js index 27acfd46ec..2b39fc9103 100644 --- a/src/ol/proj.js +++ b/src/ol/proj.js @@ -42,15 +42,15 @@ * `get('EPSG:1234').setExtent(extent)`. * * In addition to Proj4js support, any transform functions can be added with - * {@link module:ol/proj~addCoordinateTransforms}. To use this, you must first create + * {@link module:ol/proj.addCoordinateTransforms}. To use this, you must first create * a {@link module:ol/proj/Projection} object for the new projection and add it with - * {@link module:ol/proj~addProjection}. You can then add the forward and inverse - * functions with {@link module:ol/proj~addCoordinateTransforms}. See + * {@link module:ol/proj.addProjection}. You can then add the forward and inverse + * functions with {@link module:ol/proj.addCoordinateTransforms}. See * examples/wms-custom-proj for an example of this. * * Note that if no transforms are needed and you only need to define the * projection, just add a {@link module:ol/proj/Projection} with - * {@link module:ol/proj~addProjection}. See examples/wms-no-proj for an example of + * {@link module:ol/proj.addProjection}. See examples/wms-no-proj for an example of * this. */ import Projection from './proj/Projection.js'; @@ -480,7 +480,7 @@ export function getTransform(source, destination) { * Transforms a coordinate from source projection to destination projection. * This returns a new coordinate (and does not modify the original). * - * See {@link module:ol/proj~transformExtent} for extent transformation. + * See {@link module:ol/proj.transformExtent} for extent transformation. * See the transform method of {@link module:ol/geom/Geometry~Geometry} and its * subclasses for geometry transforms. * diff --git a/src/ol/proj/Projection.js b/src/ol/proj/Projection.js index 5736327628..e426298eb3 100644 --- a/src/ol/proj/Projection.js +++ b/src/ol/proj/Projection.js @@ -30,7 +30,7 @@ import {METERS_PER_UNIT} from './Units.js'; * and options use {@link module:ol/proj~ProjectionLike} which means the simple string * code will suffice. * - * You can use {@link module:ol/proj~get} to retrieve the object for a particular + * You can use {@link module:ol/proj.get} to retrieve the object for a particular * projection. * * The library includes definitions for `EPSG:4326` and `EPSG:3857`, together @@ -45,7 +45,7 @@ import {METERS_PER_UNIT} from './Units.js'; * * If you use [proj4js](https://github.com/proj4js/proj4js), aliases can * be added using `proj4.defs()`. After all required projection definitions are - * added, call the {@link module:ol/proj/proj4~register} function. + * added, call the {@link module:ol/proj/proj4.register} function. * * @api */ @@ -249,7 +249,7 @@ class Projection { } /** - * Set the getPointResolution function (see {@link module:ol/proj~getPointResolution} + * Set the getPointResolution function (see {@link module:ol/proj.getPointResolution} * for this projection. * @param {function(number, import("../coordinate.js").Coordinate):number} func Function * @api diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 43b0a70c8a..7377025e89 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -116,12 +116,12 @@ export class VectorSourceEvent extends Event { * boundaries or TopoJSON sources) allows the renderer to optimise fill and * stroke operations. * @property {LoadingStrategy} [strategy] The loading strategy to use. - * By default an {@link module:ol/loadingstrategy~all} + * By default an {@link module:ol/loadingstrategy.all} * strategy is used, a one-off strategy which loads all features at once. * @property {string|import("../featureloader.js").FeatureUrlFunction} [url] * Setting this option instructs the source to load features using an XHR loader - * (see {@link module:ol/featureloader~xhr}). Use a `string` and an - * {@link module:ol/loadingstrategy~all} for a one-off download of all features from + * (see {@link module:ol/featureloader.xhr}). Use a `string` and an + * {@link module:ol/loadingstrategy.all} for a one-off download of all features from * the given URL. Use a {@link module:ol/featureloader~FeatureUrlFunction} to generate the url with * other loading strategies. * Requires `format` to be set as well. diff --git a/src/ol/xml.js b/src/ol/xml.js index c9650bac64..e9d3db3571 100644 --- a/src/ol/xml.js +++ b/src/ol/xml.js @@ -4,8 +4,8 @@ import {extend} from './array.js'; /** - * When using {@link module:ol/xml~makeChildAppender} or - * {@link module:ol/xml~makeSimpleNodeFactory}, the top `objectStack` item needs + * When using {@link module:ol/xml.makeChildAppender} or + * {@link module:ol/xml.makeSimpleNodeFactory}, the top `objectStack` item needs * to have this structure. * @typedef {Object} NodeStackItem * @property {Node} node Node. @@ -288,7 +288,7 @@ export function makeChildAppender(nodeWriter, opt_this) { /** * Create a serializer that calls the provided `nodeWriter` from - * {@link module:ol/xml~serialize}. This can be used by the parent writer to have the + * {@link module:ol/xml.serialize}. This can be used by the parent writer to have the * 'nodeWriter' called with an array of values when the `nodeWriter` was * designed to serialize a single item. An example would be a LineString * geometry writer, which could be reused for writing MultiLineString @@ -314,7 +314,7 @@ export function makeArraySerializer(nodeWriter, opt_this) { /** * Create a node factory which can use the `opt_keys` passed to - * {@link module:ol/xml~serialize} or {@link module:ol/xml~pushSerializeAndPop} as node names, + * {@link module:ol/xml.serialize} or {@link module:ol/xml.pushSerializeAndPop} as node names, * or a fixed node name. The namespace of the created nodes can either be fixed, * or the parent namespace will be used. * @param {string} [opt_nodeName] Fixed node name which will be used for all @@ -353,16 +353,16 @@ export function makeSimpleNodeFactory(opt_nodeName, opt_namespaceURI) { /** * A node factory that creates a node using the parent's `namespaceURI` and the - * `nodeName` passed by {@link module:ol/xml~serialize} or - * {@link module:ol/xml~pushSerializeAndPop} to the node factory. + * `nodeName` passed by {@link module:ol/xml.serialize} or + * {@link module:ol/xml.pushSerializeAndPop} to the node factory. * @const * @type {function(*, Array<*>, string=): (Node|undefined)} */ export const OBJECT_PROPERTY_NODE_FACTORY = makeSimpleNodeFactory(); /** - * Create an array of `values` to be used with {@link module:ol/xml~serialize} or - * {@link module:ol/xml~pushSerializeAndPop}, where `orderedKeys` has to be provided as + * Create an array of `values` to be used with {@link module:ol/xml.serialize} or + * {@link module:ol/xml.pushSerializeAndPop}, where `orderedKeys` has to be provided as * `opt_key` argument. * @param {Object} object Key-value pairs for the sequence. Keys can * be a subset of the `orderedKeys`.