Improve type doc

ivmartel · Sep 5, 2023 · 9592c8a · 9592c8a
1 parent a4fd372
commit 9592c8a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 9 deletions.
diff --git a/src/math/circle.js b/src/math/circle.js
@@ -145,9 +145,8 @@ export class Circle {
   /**
    * Quantify an circle according to view information.
    *
-   * @param {ViewController} viewController The associated view
-   *   controller.
-   * @param {Array} flags A list of stat values to calculate.
+   * @param {ViewController} viewController The associated view controller.
+   * @param {string[]} flags A list of stat values to calculate.
    * @returns {object} A quantification object.
    */
   quantify(viewController, flags) {

diff --git a/src/math/ellipse.js b/src/math/ellipse.js
@@ -166,9 +166,8 @@ export class Ellipse {
   /**
    * Quantify an ellipse according to view information.
    *
-   * @param {ViewController} viewController The associated view
-   *   controller.
-   * @param {Array} flags A list of stat values to calculate.
+   * @param {ViewController} viewController The associated view controller.
+   * @param {string[]} flags A list of stat values to calculate.
    * @returns {object} A quantification object.
    */
   quantify(viewController, flags) {

diff --git a/src/math/line.js b/src/math/line.js
@@ -1,6 +1,11 @@
 import {Point2D} from './point';
 import {i18n} from '../utils/i18n';
 
+// doc imports
+/* eslint-disable no-unused-vars */
+import {ViewController} from '../app/viewController';
+/* eslint-enable no-unused-vars */
+
 /**
  * Line shape.
  */
@@ -157,7 +162,7 @@ export class Line {
   /**
    * Quantify a line according to view information.
    *
-   * @param {object} viewController The associated view controller.
+   * @param {ViewController} viewController The associated view controller.
    * @returns {object} A quantification object.
    */
   quantify(viewController) {

diff --git a/src/math/rectangle.js b/src/math/rectangle.js
@@ -2,6 +2,11 @@ import {Point2D} from './point';
 import {getStats} from './stats';
 import {i18n} from '../utils/i18n';
 
+// doc imports
+/* eslint-disable no-unused-vars */
+import {ViewController} from '../app/viewController';
+/* eslint-enable no-unused-vars */
+
 /**
  * Mulitply the three inputs if the last two are not null.
  *
@@ -160,8 +165,8 @@ export class Rectangle {
   /**
    * Quantify a rectangle according to view information.
    *
-   * @param {object} viewController The associated view controller.
-   * @param {Array} flags A list of stat values to calculate.
+   * @param {ViewController} viewController The associated view controller.
+   * @param {string[]} flags A list of stat values to calculate.
    * @returns {object} A quantification object.
    */
   quantify(viewController, flags) {