Leverage @import tag to simplify JSDoc (#6786)

* Leverage @import tag to simplify JSDoc

* Use 100 columns

* Import ordering

* Use 100 columns

* Use 100 columns

* Import ordering

* Use 100 columns

* Use 100 columns

* Update TypeScript to 5.5

* Font fix

* Light fix

* Use 100 columns

* Use 100 columns

* Tweak Plane#normalize

* Gizmo tweaks

* Ensure correct spacing of braces

package.json

@@ -77,8 +77,9 @@
         "error",
         {
           "definedTags": [
+            "attribute",
             "category",
-            "attribute"
+            "import"
           ]
         }
       ]
@@ -132,9 +133,9 @@
     "rollup-plugin-visualizer": "^5.12.0",
     "serve": "^14.2.2",
     "sinon": "^17.0.1",
-    "typedoc": "^0.25.13",
-    "typedoc-plugin-mdn-links": "^3.1.22",
-    "typescript": "^5.4.5",
+    "typedoc": "^0.26.3",
+    "typedoc-plugin-mdn-links": "^3.2.2",
+    "typescript": "^5.5.3",
     "xhr2": "^0.2.1"
   },
   "scripts": {

src/core/event-handle.js

@@ -1,5 +1,10 @@
 import { Debug } from '../core/debug.js';
 
+/**
+ * @import { EventHandler } from './event-handler.js'
+ * @import { HandleEventCallback } from './event-handler.js'
+ */
+
 /**
  * Event Handle that is created by {@link EventHandler} and can be used for easier event removal
  * and management.
@@ -27,7 +32,7 @@ import { Debug } from '../core/debug.js';
  */
 class EventHandle {
     /**
-     * @type {import('./event-handler.js').EventHandler}
+     * @type {EventHandler}
      * @private
      */
     handler;
@@ -39,7 +44,7 @@ class EventHandle {
     name;
 
     /**
-     * @type {import('./event-handler.js').HandleEventCallback}
+     * @type {HandleEventCallback}
      * @ignore
      */
     callback;
@@ -64,9 +69,9 @@ class EventHandle {
     _removed = false;
 
     /**
-     * @param {import('./event-handler.js').EventHandler} handler - source object of the event.
+     * @param {EventHandler} handler - source object of the event.
      * @param {string} name - Name of the event.
-     * @param {import('./event-handler.js').HandleEventCallback} callback - Function that is called when event is fired.
+     * @param {HandleEventCallback} callback - Function that is called when event is fired.
      * @param {object} scope - Object that is used as `this` when event is fired.
      * @param {boolean} [once] - If this is a single event and will be removed after event is fired.
      */

src/core/math/curve-evaluator.js

@@ -1,6 +1,10 @@
 import { CURVE_LINEAR, CURVE_SMOOTHSTEP, CURVE_SPLINE, CURVE_STEP } from './constants.js';
 import { math } from './math.js';
 
+/**
+ * @import { Curve } from './curve.js'
+ */
+
 /**
  * A class for evaluating a curve at a specific time.
  */
@@ -32,7 +36,7 @@ class CurveEvaluator {
     /**
      * Create a new CurveEvaluator instance.
      *
-     * @param {import('./curve.js').Curve} curve - The curve to evaluate.
+     * @param {Curve} curve - The curve to evaluate.
      * @param {number} time - The initial time to evaluate the curve at. Defaults to 0.
      */
     constructor(curve, time = 0) {

src/core/math/mat3.js

@@ -1,5 +1,10 @@
 import { Vec3 } from './vec3.js';
 
+/**
+ * @import { Mat4 } from './mat4.js'
+ * @import { Quat } from './quat.js'
+ */
+
 /**
  * A 3x3 matrix.
  *
@@ -242,7 +247,7 @@ class Mat3 {
     /**
      * Converts the specified 4x4 matrix to a Mat3.
      *
-     * @param {import('./mat4.js').Mat4} m - The 4x4 matrix to convert.
+     * @param {Mat4} m - The 4x4 matrix to convert.
      * @returns {Mat3} Self for chaining.
      */
     setFromMat4(m) {
@@ -267,7 +272,7 @@ class Mat3 {
     /**
      * Sets this matrix to the given quaternion rotation.
      *
-     * @param {import('./quat.js').Quat} r - A quaternion rotation.
+     * @param {Quat} r - A quaternion rotation.
      * @returns {Mat3} Self for chaining.
      * @example
      * const r = new pc.Quat(1, 2, 3, 4).normalize();
@@ -314,7 +319,7 @@ class Mat3 {
     /**
      * Set the matrix to the inverse of the specified 4x4 matrix.
      *
-     * @param {import('./mat4.js').Mat4} src - The 4x4 matrix to invert.
+     * @param {Mat4} src - The 4x4 matrix to invert.
      * @returns {Mat3} Self for chaining.
      *
      * @ignore