Link to class instead of module pages

This commit is contained in:
Maximilian Krög
2022-02-14 21:53:07 +01:00
parent 924686ef71
commit b29ab8f104
33 changed files with 58 additions and 58 deletions

View File

@@ -38,7 +38,7 @@ class DoubleClickZoom extends Interaction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} (if it was a
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} (if it was a
* doubleclick) and eventually zooms the map.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.

View File

@@ -110,7 +110,7 @@ export class DragBoxEvent extends Event {
* it to when the shift or other key is held down. This is used, for example,
* for zooming to a specific area of the map
* (see {@link module:ol/interaction/DragZoom~DragZoom} and
* {@link module:ol/interaction/DragRotateAndZoom}).
* {@link module:ol/interaction/DragRotateAndZoom~DragRotateAndZoom}).
*
* @fires DragBoxEvent
* @api

View File

@@ -529,7 +529,7 @@ class Draw extends PointerInteraction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may actually draw or finish the drawing.
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may actually draw or finish the drawing.
* @param {import("../MapBrowserEvent.js").default} event Map browser event.
* @return {boolean} `false` to stop event propagation.
* @api

View File

@@ -93,7 +93,7 @@ class Interaction extends BaseObject {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event}.
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event}.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
* @api

View File

@@ -76,7 +76,7 @@ class KeyboardPan extends Interaction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} if it was a
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} if it was a
* `KeyEvent`, and decides the direction to pan to (if an arrow key was
* pressed).
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.

View File

@@ -57,7 +57,7 @@ class KeyboardZoom extends Interaction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} if it was a
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} if it was a
* `KeyEvent`, and decides whether to zoom in or out (depending on whether the
* key pressed was '+' or '-').
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.

View File

@@ -121,7 +121,7 @@ const ModifyEventType = {
* must be provided with the `features` option.
* @property {boolean|import("../layer/BaseVector").default} [hitDetection] When configured, point
* features will be considered for modification based on their visual appearance, instead of being within
* the `pixelTolerance` from the pointer location. When a {@link module:ol/layer/BaseVector} is
* the `pixelTolerance` from the pointer location. When a {@link module:ol/layer/BaseVector~BaseVectorLayer} is
* provided, only the rendered representation of the features on that layer will be considered.
* @property {Collection<Feature>} [features]
* The features the interaction works on. If a feature collection is not
@@ -143,7 +143,7 @@ export class ModifyEvent extends Event {
* @param {Collection<import("../Feature").FeatureLike>} features
* The features modified.
* @param {import("../MapBrowserEvent.js").default} MapBrowserEvent
* Associated {@link module:ol/MapBrowserEvent}.
* Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
*/
constructor(type, features, MapBrowserEvent) {
super(type);
@@ -156,7 +156,7 @@ export class ModifyEvent extends Event {
this.features = features;
/**
* Associated {@link module:ol/MapBrowserEvent}.
* Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
* @type {import("../MapBrowserEvent.js").default}
* @api
*/
@@ -834,7 +834,7 @@ class Modify extends PointerInteraction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may modify the geometry.
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may modify the geometry.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
*/

View File

@@ -164,7 +164,7 @@ class MouseWheelZoom extends Interaction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} (if it was a mousewheel-event) and eventually
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} (if it was a mousewheel-event) and eventually
* zooms the map.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.

View File

@@ -101,7 +101,7 @@ export class SelectEvent extends Event {
* @param {Array<import("../Feature.js").default>} selected Selected features.
* @param {Array<import("../Feature.js").default>} deselected Deselected features.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Associated
* {@link module:ol/MapBrowserEvent}.
* {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
*/
constructor(type, selected, deselected, mapBrowserEvent) {
super(type);
@@ -121,7 +121,7 @@ export class SelectEvent extends Event {
this.deselected = deselected;
/**
* Associated {@link module:ol/MapBrowserEvent}.
* Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
* @type {import("../MapBrowserEvent.js").default}
* @api
*/
@@ -460,7 +460,7 @@ class Select extends Interaction {
}
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may change the
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may change the
* selected state of features.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.

View File

@@ -73,7 +73,7 @@ const tempSegment = [];
/**
* @classdesc
* Handles snapping of vector features while modifying or drawing them. The
* features can come from a {@link module:ol/source/Vector} or {@link module:ol/Collection~Collection}
* features can come from a {@link module:ol/source/Vector~VectorSource} or {@link module:ol/Collection~Collection}
* Any interaction object that allows the user to interact
* with the features using the mouse can benefit from the snapping, as long
* as it is added before.

View File

@@ -102,7 +102,7 @@ export class TranslateEvent extends Event {
this.startCoordinate = startCoordinate;
/**
* Associated {@link module:ol/MapBrowserEvent}.
* Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
* @type {import("../MapBrowserEvent.js").default}
* @api
*/