JSDoc import dollar fixes (#6215)

* fixed dollars for mouse input and touch event * reverted touch changes * removed dollar for Node
playcanvas · Apr 2, 2024 · 44e4ad3 · 44e4ad3
1 parent 48f9551
commit 44e4ad3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/src/framework/input/element-input.js b/src/framework/input/element-input.js
@@ -116,18 +116,20 @@ class ElementInputEvent {
     /**
      * Create a new ElementInputEvent instance.
      *
-     * @param {MouseEvent|TouchEvent} event - The MouseEvent or TouchEvent that was originally
-     * raised.
+     * @param {import('../../platform/input/mouse-event.js').MouseEvent
+     * |import('../../platform/input/touch-event.js').TouchEvent} event - MouseEvent or TouchEvent
+     * that was originally raised.
      * @param {import('../components/element/component.js').ElementComponent} element - The
      * ElementComponent that this event was originally raised on.
      * @param {import('../components/camera/component.js').CameraComponent} camera - The
      * CameraComponent that this event was originally raised via.
      */
     constructor(event, element, camera) {
         /**
-         * The MouseEvent or TouchEvent that was originally raised.
+         * MouseEvent or TouchEvent that was originally raised.
          *
-         * @type {MouseEvent|TouchEvent}
+         * @type {import('../../platform/input/mouse-event.js').MouseEvent
+         * |import('../../platform/input/touch-event.js').TouchEvent}
          */
         this.event = event;
 
@@ -170,7 +172,8 @@ class ElementMouseEvent extends ElementInputEvent {
     /**
      * Create an instance of an ElementMouseEvent.
      *
-     * @param {MouseEvent} event - The MouseEvent that was originally raised.
+     * @param {import('../../platform/input/mouse-event.js').MouseEvent} event - The MouseEvent that
+     * was originally raised.
      * @param {import('../components/element/component.js').ElementComponent} element - The
      * ElementComponent that this event was originally raised on.
      * @param {import('../components/camera/component.js').CameraComponent} camera - The
@@ -264,14 +267,14 @@ class ElementTouchEvent extends ElementInputEvent {
     /**
      * Create an instance of an ElementTouchEvent.
      *
-     * @param {TouchEvent} event - The TouchEvent that was originally raised.
+     * @param {import('../../platform/input/touch-event.js').TouchEvent} event - The TouchEvent that was originally raised.
      * @param {import('../components/element/component.js').ElementComponent} element - The
      * ElementComponent that this event was originally raised on.
      * @param {import('../components/camera/component.js').CameraComponent} camera - The
      * CameraComponent that this event was originally raised via.
      * @param {number} x - The x coordinate of the touch that triggered the event.
      * @param {number} y - The y coordinate of the touch that triggered the event.
-     * @param {Touch} touch - The touch object that triggered the event.
+     * @param {import('../../platform/input/touch-event.js').Touch} touch - The touch object that triggered the event.
      */
     constructor(event, element, camera, x, y, touch) {
         super(event, element, camera);
@@ -280,22 +283,22 @@ class ElementTouchEvent extends ElementInputEvent {
          * The Touch objects representing all current points of contact with the surface,
          * regardless of target or changed status.
          *
-         * @type {Touch[]}
+         * @type {import('../../platform/input/touch-event.js').Touch[]}
          */
         this.touches = event.touches;
         /**
          * The Touch objects representing individual points of contact whose states changed between
          * the previous touch event and this one.
          *
-         * @type {Touch[]}
+         * @type {import('../../platform/input/touch-event.js').Touch[]}
          */
         this.changedTouches = event.changedTouches;
         this.x = x;
         this.y = y;
         /**
          * The touch object that triggered the event.
          *
-         * @type {Touch}
+         * @type {import('../../platform/input/touch-event.js').Touch}
          */
         this.touch = touch;
     }

diff --git a/src/platform/audio/channel.js b/src/platform/audio/channel.js
@@ -33,6 +33,7 @@ class Channel {
 
         this.manager = manager;
 
+        /** @type {globalThis.Node | null} */
         this.source = null;
 
         if (hasAudioContext()) {