Remove all inheritDoc tags from src/ol/layer

This commit is contained in:
Frederic Junod
2020-03-26 15:56:04 +01:00
parent 506aa7aae7
commit 15d36a22f0
6 changed files with 20 additions and 15 deletions

View File

@@ -322,7 +322,7 @@ class BaseLayer extends BaseObject {
}
/**
* @inheritDoc
* Clean up.
*/
disposeInternal() {
if (this.state_) {

View File

@@ -190,7 +190,8 @@ class LayerGroup extends BaseLayer {
}
/**
* @inheritDoc
* @param {Array<import("./Layer.js").default>=} opt_array Array of layers (to be modified in place).
* @return {Array<import("./Layer.js").default>} Array of layers.
*/
getLayersArray(opt_array) {
const array = opt_array !== undefined ? opt_array : [];
@@ -201,7 +202,8 @@ class LayerGroup extends BaseLayer {
}
/**
* @inheritDoc
* @param {Array<import("./Layer.js").State>=} opt_states Optional list of layer states (to be modified in place).
* @return {Array<import("./Layer.js").State>} List of layer states.
*/
getLayerStatesArray(opt_states) {
const states = opt_states !== undefined ? opt_states : [];
@@ -238,7 +240,7 @@ class LayerGroup extends BaseLayer {
}
/**
* @inheritDoc
* @return {import("../source/State.js").default} Source state.
*/
getSourceState() {
return SourceState.READY;

View File

@@ -178,7 +178,8 @@ class Heatmap extends VectorLayer {
}
/**
* @inheritDoc
* Create a renderer for this layer.
* @return {WebGLPointsLayerRenderer} A layer renderer.
*/
createRenderer() {
return new WebGLPointsLayerRenderer(this, {

View File

@@ -46,7 +46,7 @@ import {assert} from '../asserts.js';
/**
* @typedef {Object} State
* @property {import("./Base.js").default} layer
* @property {import("./Layer.js").default} layer
* @property {number} opacity Opacity, the value is rounded to two digits to appear after the decimal point.
* @property {SourceState} sourceState
* @property {boolean} visible
@@ -138,7 +138,8 @@ class Layer extends BaseLayer {
}
/**
* @inheritDoc
* @param {Array<import("./Layer.js").default>=} opt_array Array of layers (to be modified in place).
* @return {Array<import("./Layer.js").default>} Array of layers.
*/
getLayersArray(opt_array) {
const array = opt_array ? opt_array : [];
@@ -147,7 +148,8 @@ class Layer extends BaseLayer {
}
/**
* @inheritDoc
* @param {Array<import("./Layer.js").State>=} opt_states Optional list of layer states (to be modified in place).
* @return {Array<import("./Layer.js").State>} List of layer states.
*/
getLayerStatesArray(opt_states) {
const states = opt_states ? opt_states : [];
@@ -166,8 +168,8 @@ class Layer extends BaseLayer {
}
/**
* @inheritDoc
*/
* @return {import("../source/State.js").default} Source state.
*/
getSourceState() {
const source = this.getSource();
return !source ? SourceState.UNDEFINED : source.getState();
@@ -299,7 +301,7 @@ class Layer extends BaseLayer {
}
/**
* @inheritDoc
* Clean up.
*/
disposeInternal() {
this.setSource(null);

View File

@@ -93,7 +93,8 @@ class WebGLPointsLayer extends Layer {
}
/**
* @inheritDoc
* Create a renderer for this layer.
* @return {WebGLPointsLayerRenderer} A layer renderer.
*/
createRenderer() {
return new WebGLPointsLayerRenderer(this, {
@@ -109,8 +110,7 @@ class WebGLPointsLayer extends Layer {
}
/**
*
* @inheritDoc
* Clean up.
*/
disposeInternal() {
this.renderer_.dispose();

View File

@@ -23,7 +23,7 @@ class LayerRenderer extends Observable {
this.boundHandleImageChange_ = this.handleImageChange_.bind(this);
/**
* @private
* @protected
* @type {LayerType}
*/
this.layer_ = layer;