Remove all inheritDoc tags from src/ol/interaction

This commit is contained in:
Frederic Junod
2020-03-26 11:03:08 +01:00
parent 706dd3c87c
commit da8ef43db7
15 changed files with 131 additions and 51 deletions

View File

@@ -404,7 +404,10 @@ class Modify extends PointerInteraction {
}
/**
* @inheritDoc
* Activate or deactivate the interaction.
* @param {boolean} active Active.
* @observable
* @api
*/
setActive(active) {
if (this.vertexFeature_ && !active) {
@@ -415,7 +418,10 @@ class Modify extends PointerInteraction {
}
/**
* @inheritDoc
* Remove the interaction from its current map and attach it to the new map.
* Subclasses may set up event handlers to get notified about changes to
* the map here.
* @param {import("../PluggableMap.js").default} map Map.
*/
setMap(map) {
this.overlay_.setMap(map);
@@ -702,10 +708,11 @@ class Modify extends PointerInteraction {
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may modify the geometry.
* @override
* @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
*/
handleEvent(mapBrowserEvent) {
if (!(/** @type {import("../MapBrowserPointerEvent.js").default} */ (mapBrowserEvent).pointerEvent)) {
if (!mapBrowserEvent.pointerEvent) {
return true;
}
this.lastPointerEvent_ = mapBrowserEvent;
@@ -732,7 +739,8 @@ class Modify extends PointerInteraction {
}
/**
* @inheritDoc
* Handle pointer drag events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
*/
handleDragEvent(evt) {
this.ignoreNextSingleClick_ = false;
@@ -818,7 +826,9 @@ class Modify extends PointerInteraction {
}
/**
* @inheritDoc
* Handle pointer down events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
*/
handleDownEvent(evt) {
if (!this.condition_(evt)) {
@@ -899,7 +909,9 @@ class Modify extends PointerInteraction {
}
/**
* @inheritDoc
* Handle pointer up events.
* @param {import("../MapBrowserPointerEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
*/
handleUpEvent(evt) {
for (let i = this.dragSegments_.length - 1; i >= 0; --i) {