From a4784d5b3d0212db3bbc487afc06c88ff34bd1df Mon Sep 17 00:00:00 2001 From: kpal Date: Tue, 12 Mar 2024 15:15:26 +0000 Subject: [PATCH 1/6] added missing exports package to include typedefs and callbacks --- package-lock.json | 10 ++++++++++ package.json | 1 + typedoc.json | 9 +++++++-- 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index fede089..7847ef8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17,6 +17,7 @@ "typedoc": "^0.25.12", "typedoc-plugin-extras": "^3.0.0", "typedoc-plugin-mdn-links": "^3.1.18", + "typedoc-plugin-missing-exports": "^2.2.0", "typedoc-plugin-rename-defaults": "^0.7.0" } }, @@ -1086,6 +1087,15 @@ "typedoc": ">= 0.23.14 || 0.24.x || 0.25.x" } }, + "node_modules/typedoc-plugin-missing-exports": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-2.2.0.tgz", + "integrity": "sha512-2+XR1IcyQ5UwXZVJe9NE6HrLmNufT9i5OwoIuuj79VxuA3eYq+Y6itS9rnNV1D7UeQnUSH8kISYD73gHE5zw+w==", + "dev": true, + "peerDependencies": { + "typedoc": "0.24.x || 0.25.x" + } + }, "node_modules/typedoc-plugin-rename-defaults": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/typedoc-plugin-rename-defaults/-/typedoc-plugin-rename-defaults-0.7.0.tgz", diff --git a/package.json b/package.json index 17434f4..f03a9b8 100644 --- a/package.json +++ b/package.json @@ -28,6 +28,7 @@ "typedoc": "^0.25.12", "typedoc-plugin-extras": "^3.0.0", "typedoc-plugin-mdn-links": "^3.1.18", + "typedoc-plugin-missing-exports": "^2.2.0", "typedoc-plugin-rename-defaults": "^0.7.0" }, "scripts": { diff --git a/typedoc.json b/typedoc.json index bcfeba9..f40f8af 100644 --- a/typedoc.json +++ b/typedoc.json @@ -44,7 +44,8 @@ "./typedoc-plugin-property.mjs", "typedoc-plugin-extras", "typedoc-plugin-mdn-links", - "typedoc-plugin-rename-defaults" + "typedoc-plugin-rename-defaults", + "typedoc-plugin-missing-exports", ], "readme": "INDEX.md", "searchGroupBoosts": { @@ -58,5 +59,9 @@ "customDescription": "Combined API reference manual for PlayCanvas", "favicon": "favicon.ico", "footerLastModified": false, // enabling this activates the page's scroll bar - "footerTypedocVersion": true + "footerTypedocVersion": true, + + + // Options for typedoc-plugin-missing-exports + "placeInternalsInOwningModule": true } From a2d1a2b20c0057f58f90f2093ec5ad8763ea573f Mon Sep 17 00:00:00 2001 From: kpal Date: Thu, 14 Mar 2024 13:51:00 +0000 Subject: [PATCH 2/6] changed hidden to ignore --- submodules/observer | 2 +- submodules/pcui-graph | 2 +- typedoc.json | 6 ++++++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/submodules/observer b/submodules/observer index 2fbd61b..fdd410a 160000 --- a/submodules/observer +++ b/submodules/observer @@ -1 +1 @@ -Subproject commit 2fbd61b4e0a01aeec10753e0a769f8472d90b161 +Subproject commit fdd410abaa21c004183fdb2d6f055c0fecd56262 diff --git a/submodules/pcui-graph b/submodules/pcui-graph index a8ad158..a5155e2 160000 --- a/submodules/pcui-graph +++ b/submodules/pcui-graph @@ -1 +1 @@ -Subproject commit a8ad158b42d74ad248f972982f8b782d139fc02c +Subproject commit a5155e218fa076543630ecdc505a51cba92b262c diff --git a/typedoc.json b/typedoc.json index f40f8af..5f2ae72 100644 --- a/typedoc.json +++ b/typedoc.json @@ -31,6 +31,12 @@ "TypeAlias", "Reference" ], + "exclude": [ + "**/node_modules/**", + // Contains interfaces we also do not want to export so ignore entire files + "**/engine/src/scene/gsplat/gsplat-data.js", + "**/engine/src/scene/gsplat/gsplat-material.js", + ], "gaID": "UA-23605814-1", "githubPages": true, "name": "PlayCanvas API Reference", From 94d27a6fc74ff817322f07f8e8d295d715ba4acd Mon Sep 17 00:00:00 2001 From: kpal Date: Thu, 14 Mar 2024 15:03:13 +0000 Subject: [PATCH 3/6] excluded node_modules and gsplat internal interfaces from being exposed; added commits for latest submodules --- submodules/engine | 2 +- submodules/observer | 2 +- submodules/pcui-graph | 2 +- typedoc.json | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/submodules/engine b/submodules/engine index 45cc4df..69cf798 160000 --- a/submodules/engine +++ b/submodules/engine @@ -1 +1 @@ -Subproject commit 45cc4df0bf64dd2f2fdea2e7f6550bbf6d533746 +Subproject commit 69cf79842d1856756bb3c85e1f97cc93d43c2283 diff --git a/submodules/observer b/submodules/observer index fdd410a..a20c117 160000 --- a/submodules/observer +++ b/submodules/observer @@ -1 +1 @@ -Subproject commit fdd410abaa21c004183fdb2d6f055c0fecd56262 +Subproject commit a20c117846887f74f83320bf4c556880a91936bb diff --git a/submodules/pcui-graph b/submodules/pcui-graph index a5155e2..3600a3e 160000 --- a/submodules/pcui-graph +++ b/submodules/pcui-graph @@ -1 +1 @@ -Subproject commit a5155e218fa076543630ecdc505a51cba92b262c +Subproject commit 3600a3e7c2d2f344afce505ddab8f17e21990baa diff --git a/typedoc.json b/typedoc.json index 5f2ae72..06f573a 100644 --- a/typedoc.json +++ b/typedoc.json @@ -34,8 +34,8 @@ "exclude": [ "**/node_modules/**", // Contains interfaces we also do not want to export so ignore entire files - "**/engine/src/scene/gsplat/gsplat-data.js", - "**/engine/src/scene/gsplat/gsplat-material.js", + "submodules/engine/src/scene/gsplat/gsplat-data.js", + "submodules/engine/src/scene/gsplat/gsplat-material.js", ], "gaID": "UA-23605814-1", "githubPages": true, From 337ed9a940c245b13b68c28f628c638037773bd3 Mon Sep 17 00:00:00 2001 From: KPal <48248865+kpal81xd@users.noreply.github.com> Date: Thu, 14 Mar 2024 15:03:39 +0000 Subject: [PATCH 4/6] Update typedoc.json Co-authored-by: Will Eastcott --- typedoc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedoc.json b/typedoc.json index 06f573a..da53f04 100644 --- a/typedoc.json +++ b/typedoc.json @@ -51,7 +51,7 @@ "typedoc-plugin-extras", "typedoc-plugin-mdn-links", "typedoc-plugin-rename-defaults", - "typedoc-plugin-missing-exports", + "typedoc-plugin-missing-exports" ], "readme": "INDEX.md", "searchGroupBoosts": { From 05dd3093f0224d8ac146e909f893c1075943e3da Mon Sep 17 00:00:00 2001 From: KPal <48248865+kpal81xd@users.noreply.github.com> Date: Fri, 15 Mar 2024 13:02:21 +0000 Subject: [PATCH 5/6] Update typedoc.json Co-authored-by: Will Eastcott --- typedoc.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/typedoc.json b/typedoc.json index da53f04..329f644 100644 --- a/typedoc.json +++ b/typedoc.json @@ -66,8 +66,6 @@ "favicon": "favicon.ico", "footerLastModified": false, // enabling this activates the page's scroll bar "footerTypedocVersion": true, - - // Options for typedoc-plugin-missing-exports "placeInternalsInOwningModule": true } From 85eaae074e98afdeb3e21c56d28e216252ea2d51 Mon Sep 17 00:00:00 2001 From: KPal <48248865+kpal81xd@users.noreply.github.com> Date: Fri, 15 Mar 2024 13:02:30 +0000 Subject: [PATCH 6/6] Update typedoc.json Co-authored-by: Will Eastcott --- typedoc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedoc.json b/typedoc.json index 329f644..a231b54 100644 --- a/typedoc.json +++ b/typedoc.json @@ -35,7 +35,7 @@ "**/node_modules/**", // Contains interfaces we also do not want to export so ignore entire files "submodules/engine/src/scene/gsplat/gsplat-data.js", - "submodules/engine/src/scene/gsplat/gsplat-material.js", + "submodules/engine/src/scene/gsplat/gsplat-material.js" ], "gaID": "UA-23605814-1", "githubPages": true,