From: Ben McCann <322311+benmccann@users.noreply.github.com>
Date: Wed, 12 Feb 2020 13:03:23 +0000 (-0800)
Subject: Cleanup some Typescript comments (#7088)
X-Git-Tag: v3.0.0-alpha~56
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7609385544a5836cb03b9394545cb02c9745fc95;p=thirdparty%2FChart.js.git

Cleanup some Typescript comments (#7088)
---

diff --git a/src/core/core.interaction.js b/src/core/core.interaction.js
index 12adbb62f..2213dc26b 100644
--- a/src/core/core.interaction.js
+++ b/src/core/core.interaction.js
@@ -6,10 +6,8 @@ import {_lookupByKey, _rlookupByKey} from '../helpers/helpers.collection';
 
 /**
  * @typedef { import("./core.controller").default } Chart
- */
-
-/**
  * @typedef { import("../platform/platform.base").IEvent } IEvent
+ * @typedef {{axis?:'x'|'y'|'xy', intersect:boolean}} IInteractionOptions
  */
 
 /**
@@ -181,16 +179,6 @@ function getNearestItems(chart, position, axis, intersect) {
 	return items;
 }
 
-/**
- * @interface IInteractionOptions
- * @typedef {object} IInteractionOptions
- */
-/**
- * If true, only consider items that intersect the point
- * @name IInterfaceOptions#boolean
- * @type Boolean
- */
-
 /**
  * Contains interaction related functions
  * @namespace Chart.Interaction
diff --git a/src/core/core.plugins.js b/src/core/core.plugins.js
index 040739676..900528013 100644
--- a/src/core/core.plugins.js
+++ b/src/core/core.plugins.js
@@ -5,13 +5,7 @@ import {clone} from '../helpers/helpers.core';
 
 /**
  * @typedef { import("./core.controller").default } Chart
- */
-
-/**
  * @typedef { import("../platform/platform.base").IEvent } IEvent
- */
-
-/**
  * @typedef { import("../plugins/plugin.tooltip").default } Tooltip
  */
 
diff --git a/src/helpers/helpers.segment.js b/src/helpers/helpers.segment.js
index b514d89f8..1a4f5fec0 100644
--- a/src/helpers/helpers.segment.js
+++ b/src/helpers/helpers.segment.js
@@ -4,9 +4,6 @@ import {_angleBetween, _angleDiff, _normalizeAngle} from './helpers.math';
 
 /**
  * @typedef { import("../elements/element.line").default } Line
- */
-
-/**
  * @typedef { import("../elements/element.point").default } Point
  */
 
diff --git a/src/scales/scale.time.js b/src/scales/scale.time.js
index 455dd99a8..bff10658e 100644
--- a/src/scales/scale.time.js
+++ b/src/scales/scale.time.js
@@ -15,7 +15,7 @@ import {_lookup, _lookupByKey} from '../helpers/helpers.collection';
 const MAX_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991;
 
 /**
- * @type {Map<Unit, {common: boolean, size: number, steps: number|undefined}>}
+ * @type {Map<Unit, {common: boolean, size: number, steps?: number}>}
  */
 const INTERVALS = new Map();
 INTERVALS.set('millisecond', {common: true, size: 1, steps: 1000});
@@ -26,7 +26,7 @@ INTERVALS.set('day', {common: true, size: 86400000, steps: 30});
 INTERVALS.set('week', {common: false, size: 604800000, steps: 4});
 INTERVALS.set('month', {common: true, size: 2.628e9, steps: 12});
 INTERVALS.set('quarter', {common: false, size: 7.884e9, steps: 4});
-INTERVALS.set('year', {common: true, size: 3.154e10, steps: undefined});
+INTERVALS.set('year', {common: true, size: 3.154e10});
 
 /**
  * @type {Unit[]}