From 15d36a22f0c8513c83d036935086ba697f7e3d35 Mon Sep 17 00:00:00 2001
From: Frederic Junod <frederic.junod@camptocamp.com>
Date: Thu, 26 Mar 2020 15:56:04 +0100
Subject: [PATCH] Remove all inheritDoc tags from src/ol/layer

---
 src/ol/layer/Base.js        |  2 +-
 src/ol/layer/Group.js       |  8 +++++---
 src/ol/layer/Heatmap.js     |  3 ++-
 src/ol/layer/Layer.js       | 14 ++++++++------
 src/ol/layer/WebGLPoints.js |  6 +++---
 src/ol/renderer/Layer.js    |  2 +-
 6 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/src/ol/layer/Base.js b/src/ol/layer/Base.js
index 21a44fdc36..7f39118e4b 100644
--- a/src/ol/layer/Base.js
+++ b/src/ol/layer/Base.js
@@ -322,7 +322,7 @@ class BaseLayer extends BaseObject {
   }
 
   /**
-   * @inheritDoc
+   * Clean up.
    */
   disposeInternal() {
     if (this.state_) {
diff --git a/src/ol/layer/Group.js b/src/ol/layer/Group.js
index 12dff00af2..c7dd443100 100644
--- a/src/ol/layer/Group.js
+++ b/src/ol/layer/Group.js
@@ -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;
diff --git a/src/ol/layer/Heatmap.js b/src/ol/layer/Heatmap.js
index 0d015bf985..961c144418 100644
--- a/src/ol/layer/Heatmap.js
+++ b/src/ol/layer/Heatmap.js
@@ -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, {
diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js
index 2f6b2fb0b7..a96ee841c5 100644
--- a/src/ol/layer/Layer.js
+++ b/src/ol/layer/Layer.js
@@ -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);
diff --git a/src/ol/layer/WebGLPoints.js b/src/ol/layer/WebGLPoints.js
index cdcea572b4..fb9428a7ff 100644
--- a/src/ol/layer/WebGLPoints.js
+++ b/src/ol/layer/WebGLPoints.js
@@ -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();
diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js
index 072e043906..4c0058a512 100644
--- a/src/ol/renderer/Layer.js
+++ b/src/ol/renderer/Layer.js
@@ -23,7 +23,7 @@ class LayerRenderer extends Observable {
     this.boundHandleImageChange_ = this.handleImageChange_.bind(this);
 
     /**
-     * @private
+     * @protected
      * @type {LayerType}
      */
     this.layer_ = layer;