Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use @ignore over @hideconstructor #6177

Merged
merged 1 commit into from
Mar 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/framework/anim/evaluator/anim-track.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class AnimTrack {
* @param {import('./anim-data.js').AnimData[]} outputs - List of curve value data.
* @param {import('./anim-curve.js').AnimCurve[]} curves - The list of curves.
* @param {AnimEvents} animEvents - A sequence of animation events.
* @hideconstructor
* @ignore
*/
constructor(name, duration, inputs, outputs, curves, animEvents = new AnimEvents([])) {
this._name = name;
Expand Down
2 changes: 1 addition & 1 deletion src/framework/anim/state-graph/anim-state-graph.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class AnimStateGraph {
* Create an AnimStateGraph instance from JSON data.
*
* @param {object} data - The JSON data to create the AnimStateGraph from.
* @hideconstructor
* @ignore
*/
constructor(data) {
this._layers = [];
Expand Down
2 changes: 0 additions & 2 deletions src/framework/app-base.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,6 @@ class AppBase extends EventHandler {
*
* // Start the application's main loop
* app.start();
*
* @hideconstructor
*/
constructor(canvas) {
super();
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/anim/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class AnimComponentSystem extends ComponentSystem {
* Create an AnimComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application managing this system.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/animation/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class AnimationComponentSystem extends ComponentSystem {
* Create an AnimationComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application managing this system.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/audio-listener/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class AudioListenerComponentSystem extends ComponentSystem {
* Create a new AudioListenerComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application managing this system.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/audio-source/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class AudioSourceComponentSystem extends ComponentSystem {
* Create a new AudioSourceComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application managing this system.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/button/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ButtonComponentSystem extends ComponentSystem {
* Create a new ButtonComponentSystem.
*
* @param {import('../../app-base.js').AppBase} app - The application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/camera/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class CameraComponentSystem extends ComponentSystem {
* Create a new CameraComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The Application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/collision/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ class CollisionComponentSystem extends ComponentSystem {
* Creates a new CollisionComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The running {@link AppBase}.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/element/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class ElementComponentSystem extends ComponentSystem {
* Create a new ElementComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/gsplat/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class GSplatComponentSystem extends ComponentSystem {
* Create a new GSplatComponentSystem.
*
* @param {import('../../app-base.js').AppBase} app - The Application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/joint/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class JointComponentSystem extends ComponentSystem {
* Create a new JointComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/layout-child/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class LayoutChildComponentSystem extends ComponentSystem {
* Create a new LayoutChildComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/layout-group/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class LayoutGroupComponentSystem extends ComponentSystem {
* Create a new LayoutGroupComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/light/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class LightComponentSystem extends ComponentSystem {
* Create a new LightComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/model/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class ModelComponentSystem extends ComponentSystem {
* Create a new ModelComponentSystem instance.
*
* @param {import('../../app-base.js').AppBase} app - The Application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/particle-system/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ class ParticleSystemComponentSystem extends ComponentSystem {
* Create a new ParticleSystemComponentSystem.
*
* @param {import('../../app-base.js').AppBase} app - The Application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
2 changes: 1 addition & 1 deletion src/framework/components/render/system.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class RenderComponentSystem extends ComponentSystem {
* Create a new RenderComponentSystem.
*
* @param {import('../../app-base.js').AppBase} app - The Application.
* @hideconstructor
* @ignore
*/
constructor(app) {
super(app);
Expand Down
Loading