Skip to content

Commit

Permalink
Typedoc hide exported classes (#6161)
Browse files Browse the repository at this point in the history
* Added ignore jsdoc to non-exported classes

* changed hidden to ignore in gamepad
  • Loading branch information
kpal81xd authored Mar 14, 2024
1 parent a35e74c commit 69cf798
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions extras/exporters/core-exporter.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const textureBlitFragmentShader = `
* The base class for the exporters, implementing shared functionality.
*
* @category Exporter
* @ignore
*/
class CoreExporter {
/**
Expand Down
2 changes: 2 additions & 0 deletions extras/gizmo/mesh-tri-data.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ const tmpV3 = new Vec3();

/**
* The class for holding mesh triangle data.
*
* @ignore
*/
class MeshTriData {
/**
Expand Down
1 change: 1 addition & 0 deletions src/framework/xr/xr-mesh.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { Quat } from "../../core/math/quat.js";
* change during its lifetime.
*
* @category XR
* @ignore
*/
class XrMesh extends EventHandler {
/**
Expand Down
2 changes: 2 additions & 0 deletions src/platform/graphics/gpu-profiler.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { Tracing } from "../../core/tracing.js";

/**
* Base class of a simple GPU profiler.
*
* @ignore
*/
class GpuProfiler {
/**
Expand Down
1 change: 1 addition & 0 deletions src/platform/graphics/vertex-iterator.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ function arrayGet4(offset, outputArray, outputIndex) {
* Helps with accessing a specific vertex attribute.
*
* @category Graphics
* @ignore
*/
class VertexIteratorAccessor {
/**
Expand Down
1 change: 1 addition & 0 deletions src/scene/skybox/sky.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { SkyMesh } from "./sky-mesh.js";
* Implementation of the sky.
*
* @category Graphics
* @ignore
*/
class Sky {
/**
Expand Down

0 comments on commit 69cf798

Please sign in to comment.