Add JSDoc typeof support via JSDoc plugin (#5882)

* Preparation * animation examples: remove ts-ignore * fix rest
playcanvas · Dec 6, 2023 · 201cbc0 · 201cbc0
1 parent a86bd8b
commit 201cbc0
Show file tree

Hide file tree

Showing 98 changed files with 30 additions and 410 deletions.
diff --git a/conf-api.json b/conf-api.json
@@ -1,7 +1,8 @@
 {
     "plugins": [
         "plugins/markdown",
-        "./node_modules/jsdoc-tsimport-plugin/index.js"
+        "./node_modules/jsdoc-tsimport-plugin/index.js",
+        "./node_modules/jsdoc-typeof-plugin"
     ],
     "recurseDepth": 10,
     "source": {
@@ -10,7 +11,7 @@
     "sourceType": "module",
     "tags": {
         "allowUnknownTags": true,
-        "dictionaries": ["jsdoc","closure"]
+        "dictionaries": ["jsdoc", "closure"]
     },
     "templates": {
         "cleverLinks": false,
@@ -22,4 +23,4 @@
         "recurse": true,
         "template": "./node_modules/@playcanvas/jsdoc-template"
     }
-}
+}
diff --git a/examples/src/examples/animation/blend-trees-1d.mjs b/examples/src/examples/animation/blend-trees-1d.mjs
@@ -46,15 +46,10 @@ async function example({ canvas, deviceType, assetPath, scriptsPath, data, glsla
     createOptions.graphicsDevice = device;
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/blend-trees-2d-cartesian.mjs b/examples/src/examples/animation/blend-trees-2d-cartesian.mjs
@@ -150,15 +150,10 @@ async function example({ canvas, deviceType, assetPath, scriptsPath, glslangPath
     createOptions.elementInput = new pc.ElementInput(canvas);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/blend-trees-2d-directional.mjs b/examples/src/examples/animation/blend-trees-2d-directional.mjs
@@ -107,15 +107,10 @@ async function example({ canvas, deviceType, assetPath, glslangPath, twgslPath,
     createOptions.elementInput = new pc.ElementInput(canvas);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/component-properties.mjs b/examples/src/examples/animation/component-properties.mjs
@@ -39,13 +39,9 @@ async function example({ canvas, deviceType, data, assetPath, glslangPath, twgsl
     createOptions.elementInput = new pc.ElementInput(canvas);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/events.mjs b/examples/src/examples/animation/events.mjs
@@ -26,15 +26,10 @@ async function example({ canvas, deviceType, assetPath, glslangPath, twgslPath,
     createOptions.elementInput = new pc.ElementInput(canvas);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/layer-masks.mjs b/examples/src/examples/animation/layer-masks.mjs
@@ -112,15 +112,10 @@ async function example({ canvas, deviceType, assetPath, scriptsPath, glslangPath
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/locomotion.mjs b/examples/src/examples/animation/locomotion.mjs
@@ -66,19 +66,12 @@ async function example({ canvas, deviceType, assetPath, ammoPath, glslangPath, t
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem,
-        // @ts-ignore
         pc.CollisionComponentSystem,
-        // @ts-ignore
         pc.RigidBodyComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/animation/tween.mjs b/examples/src/examples/animation/tween.mjs
@@ -24,15 +24,10 @@ async function example({ canvas, deviceType, assetPath, scriptsPath, glslangPath
     createOptions.graphicsDevice = device;
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.ElementComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/area-lights.mjs b/examples/src/examples/graphics/area-lights.mjs
@@ -28,11 +28,8 @@ async function example({ canvas, deviceType, assetPath, glslangPath, twgslPath }
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/area-picker.mjs b/examples/src/examples/graphics/area-picker.mjs
@@ -24,11 +24,8 @@ async function example({ canvas, deviceType, assetPath, glslangPath, twgslPath,
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/asset-viewer.mjs b/examples/src/examples/graphics/asset-viewer.mjs
@@ -23,7 +23,7 @@ function controls({ observer, ReactPCUI, React, jsx, fragment }) {
 /**
  * @param {import('../../options.mjs').ExampleOptions} options - The example options.
  * @returns {Promise<pc.AppBase>} The example application.
- */    
+ */
 async function example({ canvas, deviceType, data, assetPath, scriptsPath, glslangPath, twgslPath }) {
 
     const assets = {
@@ -51,15 +51,10 @@ async function example({ canvas, deviceType, data, assetPath, scriptsPath, glsla
     createOptions.keyboard = new pc.Keyboard(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.ElementComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/batching-dynamic.mjs b/examples/src/examples/graphics/batching-dynamic.mjs
@@ -20,11 +20,8 @@ async function example({ canvas, deviceType, glslangPath, twgslPath }) {
     createOptions.batchManager = pc.BatchManager;
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem
     ];
 

diff --git a/examples/src/examples/graphics/clustered-area-lights.mjs b/examples/src/examples/graphics/clustered-area-lights.mjs
@@ -66,13 +66,9 @@ async function example({ canvas, deviceType, assetPath, scriptsPath, glslangPath
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/clustered-lighting.mjs b/examples/src/examples/graphics/clustered-lighting.mjs
@@ -24,13 +24,9 @@ async function example({ canvas, deviceType, assetPath, glslangPath, twgslPath,
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/clustered-omni-shadows.mjs b/examples/src/examples/graphics/clustered-omni-shadows.mjs
@@ -47,7 +47,7 @@ function controls({ observer, ReactPCUI, React, jsx, fragment }) {
 /**
  * @param {import('../../options.mjs').ExampleOptions} options - The example options.
  * @returns {Promise<pc.AppBase>} The example application.
- */    
+ */
 async function example({ canvas, deviceType, data, assetPath, scriptsPath, glslangPath, twgslPath }) {
 
     const assets = {
@@ -74,13 +74,9 @@ async function example({ canvas, deviceType, data, assetPath, scriptsPath, glsla
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/clustered-spot-shadows.mjs b/examples/src/examples/graphics/clustered-spot-shadows.mjs
@@ -106,7 +106,7 @@ function controls({ observer, ReactPCUI, React, jsx, fragment }) {
 /**
  * @param {import('../../options.mjs').ExampleOptions} options - The example options.
  * @returns {Promise<pc.AppBase>} The example application.
- */    
+ */
 async function example({ canvas, deviceType, data, assetPath, scriptsPath, glslangPath, twgslPath }) {
     const observer = data;
     const assets = {
@@ -130,13 +130,9 @@ async function example({ canvas, deviceType, data, assetPath, scriptsPath, glsla
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/contact-hardening-shadows.mjs b/examples/src/examples/graphics/contact-hardening-shadows.mjs
@@ -120,7 +120,7 @@ function controls({ observer, ReactPCUI, React, jsx, fragment }) {
 /**
  * @param {import('../../options.mjs').ExampleOptions} options - The example options.
  * @returns {Promise<pc.AppBase>} The example application.
- */    
+ */
 async function example({ canvas, deviceType, data, assetPath, scriptsPath, glslangPath, twgslPath, dracoPath }) {
 
     pc.WasmModule.setConfig('DracoDecoderModule', {
@@ -153,15 +153,10 @@ async function example({ canvas, deviceType, data, assetPath, scriptsPath, glsla
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem,
-        // @ts-ignore
         pc.AnimComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/grab-pass.mjs b/examples/src/examples/graphics/grab-pass.mjs
@@ -27,9 +27,7 @@ async function example({ canvas, deviceType, files, assetPath, glslangPath, twgs
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/ground-fog.mjs b/examples/src/examples/graphics/ground-fog.mjs
@@ -46,13 +46,9 @@ async function example({ canvas, deviceType, files, assetPath, scriptsPath, glsl
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/hardware-instancing.mjs b/examples/src/examples/graphics/hardware-instancing.mjs
@@ -21,9 +21,7 @@ async function example({ canvas, deviceType, assetPath, glslangPath, twgslPath }
     createOptions.graphicsDevice = device;
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem
     ];
     createOptions.resourceHandlers = [

diff --git a/examples/src/examples/graphics/hierarchy.mjs b/examples/src/examples/graphics/hierarchy.mjs
@@ -17,11 +17,8 @@ async function example({ canvas, deviceType, glslangPath, twgslPath }) {
     createOptions.graphicsDevice = device;
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem
     ];
 

diff --git a/examples/src/examples/graphics/layers.mjs b/examples/src/examples/graphics/layers.mjs
@@ -17,11 +17,8 @@ async function example({ canvas, deviceType, glslangPath, twgslPath }) {
     createOptions.graphicsDevice = device;
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem
     ];
 

diff --git a/examples/src/examples/graphics/light-physical-units.mjs b/examples/src/examples/graphics/light-physical-units.mjs
@@ -109,7 +109,7 @@ function controls({ observer, ReactPCUI, React, jsx, fragment }) {
 /**
  * @param {import('../../options.mjs').ExampleOptions} options - The example options.
  * @returns {Promise<pc.AppBase>} The example application.
- */    
+ */
 async function example({ canvas, deviceType, data, assetPath, scriptsPath, glslangPath, twgslPath }) {
 
     const assets = {
@@ -137,13 +137,9 @@ async function example({ canvas, deviceType, data, assetPath, scriptsPath, glsla
     createOptions.touch = new pc.TouchDevice(document.body);
 
     createOptions.componentSystems = [
-        // @ts-ignore
         pc.RenderComponentSystem,
-        // @ts-ignore
         pc.CameraComponentSystem,
-        // @ts-ignore
         pc.LightComponentSystem,
-        // @ts-ignore
         pc.ScriptComponentSystem
     ];
     createOptions.resourceHandlers = [