fix: update JSDoc comments to improve TypeScript definitions (#269)

geops · Mar 5, 2024 · 769c1bc · 769c1bc
1 parent 4a551cd
commit 769c1bc
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 11 deletions.
diff --git a/src/control/buffer.js b/src/control/buffer.js
@@ -15,7 +15,7 @@ import bufferSVG from '../../img/buffer.svg';
 
 /**
  * Control for creating buffers.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.BufferControl
  */
 class BufferControl extends Control {

diff --git a/src/control/cad.js b/src/control/cad.js
@@ -26,7 +26,7 @@ import {
 
 /**
  * Control with snapping functionality for geometry alignment.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.CadControl
  */
 class CadControl extends Control {

diff --git a/src/control/difference.js b/src/control/difference.js
@@ -14,7 +14,7 @@ import diffSVG from '../../img/difference.svg';
 
 /**
  * Control for creating a difference of geometries.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.Difference
  */
 class Difference extends TopologyControl {

diff --git a/src/control/draw.js b/src/control/draw.js
@@ -6,7 +6,7 @@ import drawLineSVG from '../../img/draw_line.svg';
 
 /**
  * Control for drawing features.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.DrawControl
  */
 class DrawControl extends Control {
@@ -41,7 +41,6 @@ class DrawControl extends Control {
 
     /**
      * @type {ol.interaction.Draw}
-     * @private
      */
     this.drawInteraction = new Draw({
       type: options?.type || 'Point',

diff --git a/src/control/intersection.js b/src/control/intersection.js
@@ -14,7 +14,7 @@ import intersectionSVG from '../../img/intersection.svg';
 
 /**
  * Control for intersection geometries.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.Intersection
  */
 class Intersection extends TopologyControl {

diff --git a/src/control/modify.js b/src/control/modify.js
@@ -9,7 +9,7 @@ import Delete from '../interaction/delete';
 
 /**
  * Control for modifying geometries.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.ModifyControl
  */
 class ModifyControl extends Control {
@@ -126,7 +126,6 @@ class ModifyControl extends Control {
     /**
      * Select interaction to modify features.
      * @type {ol.interaction.Select}
-     * @private
      */
     this.selectModify = new SelectModify({
       filter: this.selectFilter,

diff --git a/src/control/rotate.js b/src/control/rotate.js
@@ -9,7 +9,7 @@ import rotateMapSVG from '../../img/rotate_map.svg';
 
 /**
  * Tool with for rotating geometries.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.RotateControl
  */
 class RotateControl extends Control {

diff --git a/src/control/topology.js b/src/control/topology.js
@@ -4,7 +4,7 @@ import delSVG from '../../img/buffer.svg';
 
 /**
  * Control for deleting geometries.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.TopologyControl
  */
 class TopologyControl extends Control {

diff --git a/src/control/union.js b/src/control/union.js
@@ -14,7 +14,7 @@ import unionSVG from '../../img/union.svg';
 
 /**
  * Control for creating a union of geometries.
- * @extends {ole.Control}
+ * @extends {Control}
  * @alias ole.Union
  */
 class Union extends TopologyControl {