From 69cf79842d1856756bb3c85e1f97cc93d43c2283 Mon Sep 17 00:00:00 2001 From: KPal <48248865+kpal81xd@users.noreply.github.com> Date: Thu, 14 Mar 2024 15:01:06 +0000 Subject: [PATCH] Typedoc hide exported classes (#6161) * Added ignore jsdoc to non-exported classes * changed hidden to ignore in gamepad --- extras/exporters/core-exporter.js | 1 + extras/gizmo/mesh-tri-data.js | 2 ++ src/framework/xr/xr-mesh.js | 1 + src/platform/graphics/gpu-profiler.js | 2 ++ src/platform/graphics/vertex-iterator.js | 1 + src/scene/skybox/sky.js | 1 + 6 files changed, 8 insertions(+) diff --git a/extras/exporters/core-exporter.js b/extras/exporters/core-exporter.js index b9706cb615b..6af8eacd14e 100644 --- a/extras/exporters/core-exporter.js +++ b/extras/exporters/core-exporter.js @@ -22,6 +22,7 @@ const textureBlitFragmentShader = ` * The base class for the exporters, implementing shared functionality. * * @category Exporter + * @ignore */ class CoreExporter { /** diff --git a/extras/gizmo/mesh-tri-data.js b/extras/gizmo/mesh-tri-data.js index 1989c07af6e..b0db2f39c8f 100644 --- a/extras/gizmo/mesh-tri-data.js +++ b/extras/gizmo/mesh-tri-data.js @@ -14,6 +14,8 @@ const tmpV3 = new Vec3(); /** * The class for holding mesh triangle data. + * + * @ignore */ class MeshTriData { /** diff --git a/src/framework/xr/xr-mesh.js b/src/framework/xr/xr-mesh.js index c8d760353dc..fd345c2e3f1 100644 --- a/src/framework/xr/xr-mesh.js +++ b/src/framework/xr/xr-mesh.js @@ -8,6 +8,7 @@ import { Quat } from "../../core/math/quat.js"; * change during its lifetime. * * @category XR + * @ignore */ class XrMesh extends EventHandler { /** diff --git a/src/platform/graphics/gpu-profiler.js b/src/platform/graphics/gpu-profiler.js index 152eccbf565..79818e15d4a 100644 --- a/src/platform/graphics/gpu-profiler.js +++ b/src/platform/graphics/gpu-profiler.js @@ -4,6 +4,8 @@ import { Tracing } from "../../core/tracing.js"; /** * Base class of a simple GPU profiler. + * + * @ignore */ class GpuProfiler { /** diff --git a/src/platform/graphics/vertex-iterator.js b/src/platform/graphics/vertex-iterator.js index ba9c904001a..341d391c9c1 100644 --- a/src/platform/graphics/vertex-iterator.js +++ b/src/platform/graphics/vertex-iterator.js @@ -71,6 +71,7 @@ function arrayGet4(offset, outputArray, outputIndex) { * Helps with accessing a specific vertex attribute. * * @category Graphics + * @ignore */ class VertexIteratorAccessor { /** diff --git a/src/scene/skybox/sky.js b/src/scene/skybox/sky.js index 0f5b84deef2..d10bc763885 100644 --- a/src/scene/skybox/sky.js +++ b/src/scene/skybox/sky.js @@ -7,6 +7,7 @@ import { SkyMesh } from "./sky-mesh.js"; * Implementation of the sky. * * @category Graphics + * @ignore */ class Sky { /**