Assign some missing category JSDoc tags (#7528)

Author: willeastcott

src/extras/gizmo/constants.js

@@ -18,54 +18,62 @@ export const GIZMOSPACE_WORLD = 'world';
  * Gizmo axis for the line X.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_X = 'x';
 
 /**
  * Gizmo axis for the line Y.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_Y = 'y';
 
 /**
  * Gizmo axis for the line Z.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_Z = 'z';
 
 /**
  * Gizmo axis for the plane YZ.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_YZ = 'yz';
 
 /**
  * Gizmo axis for the plane XZ.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_XZ = 'xz';
 
 /**
  * Gizmo axis for the plane XY.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_XY = 'xy';
 
 /**
  * Gizmo axis for all directions XYZ.
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_XYZ = 'xyz';
 
 /**
  * Gizmo axis for facing the camera (facing the camera).
  *
  * @type {string}
+ * @category Gizmo
  */
 export const GIZMOAXIS_FACE = 'face';

src/extras/render-passes/constants.js

@@ -2,6 +2,7 @@
  * SSAO is disabled.
  *
  * @type {string}
+ * @category Graphics
  */
 export const SSAOTYPE_NONE = 'none';
 
@@ -11,6 +12,7 @@ export const SSAOTYPE_NONE = 'none';
  * obstructed, enhancing realism.
  *
  * @type {string}
+ * @category Graphics
  */
 export const SSAOTYPE_LIGHTING = 'lighting';
 
@@ -20,5 +22,6 @@ export const SSAOTYPE_LIGHTING = 'lighting';
  * this may sacrifice some realism, it can be advantageous for achieving specific artistic styles.
  *
  * @type {string}
+ * @category Graphics
  */
 export const SSAOTYPE_COMBINE = 'combine';

src/framework/anim/controller/anim-blend-tree-1d.js

@@ -9,6 +9,8 @@ import { AnimBlendTree } from './anim-blend-tree.js';
 /**
  * An AnimBlendTree that calculates its weights using a 1D algorithm based on the thesis
  * http://runevision.com/thesis/rune_skovbo_johansen_thesis.pdf Chapter 6.
+ *
+ * @category Animation
  */
 class AnimBlendTree1D extends AnimBlendTree {
     /**

src/framework/anim/controller/anim-blend-tree-2d-cartesian.js

@@ -6,6 +6,8 @@ import { AnimBlendTree } from './anim-blend-tree.js';
 /**
  * An AnimBlendTree that calculates its weights using a 2D Cartesian algorithm based on the thesis
  * http://runevision.com/thesis/rune_skovbo_johansen_thesis.pdf Chapter 6 Section 3.
+ *
+ * @category Animation
  */
 class AnimBlendTreeCartesian2D extends AnimBlendTree {
     static _p = new Vec2();

src/framework/anim/controller/anim-blend-tree-2d-directional.js

@@ -6,6 +6,8 @@ import { AnimBlendTree } from './anim-blend-tree.js';
 /**
  * An AnimBlendTree that calculates its weights using a 2D directional algorithm based on the thesis
  * http://runevision.com/thesis/rune_skovbo_johansen_thesis.pdf Chapter 6.
+ *
+ * @category Animation
  */
 class AnimBlendTreeDirectional2D extends AnimBlendTree {
     static _p = new Vec2();

src/framework/anim/controller/anim-blend-tree-direct.js

@@ -2,6 +2,8 @@ import { AnimBlendTree } from './anim-blend-tree.js';
 
 /**
  * An AnimBlendTree that calculates normalized weight values based on the total weight.
+ *
+ * @category Animation
  */
 class AnimBlendTreeDirect extends AnimBlendTree {
     calculateWeights() {

src/framework/anim/controller/anim-blend-tree.js

@@ -10,6 +10,8 @@ import { AnimNode } from './anim-node.js';
  * be the child of other AnimBlendTrees, in order to create a hierarchy of AnimNodes. It takes a
  * blend type as an argument which defines which function should be used to determine the weights
  * of each of its children, based on the current parameter value.
+ *
+ * @category Animation
  */
 class AnimBlendTree extends AnimNode {
     /**

src/framework/anim/controller/anim-node.js

@@ -9,6 +9,8 @@ import { Vec2 } from '../../../core/math/vec2.js';
  * AnimNodes are used to represent a single animation track in the current state. Each state can
  * contain multiple AnimNodes, in which case they are stored in a BlendTree hierarchy, which will
  * control the weight (contribution to the states final animation) of its child AnimNodes.
+ *
+ * @category Animation
  */
 class AnimNode {
     /**

src/framework/anim/controller/anim-state.js

@@ -19,6 +19,8 @@ import { AnimNode } from './anim-node.js';
  * to animate the {@link Entity} while the state is active. An AnimState will stay active and play
  * as long as there is no {@link AnimTransition} with its conditions met that has that AnimState
  * as its source state.
+ *
+ * @category Animation
  */
 class AnimState {
     /** @private */

src/framework/anim/controller/anim-transition.js

@@ -7,6 +7,8 @@ import {
  * each frame, the controller tests to see if any of the AnimTransitions have the current AnimState
  * as their source (from) state. If so and the AnimTransitions parameter based conditions are met,
  * the controller will transition to the destination state.
+ *
+ * @category Animation
  */
 class AnimTransition {
     /**

src/platform/graphics/constants.js

@@ -1599,6 +1599,7 @@ export const STENCILOP_INVERT = 7;
  * The texture is not in a locked state.
  *
  * @type {number}
+ * @category Graphics
  */
 export const TEXTURELOCK_NONE = 0;
 

src/platform/graphics/uniform-buffer-format.js

@@ -42,6 +42,8 @@ uniformTypeToNumComponents[UNIFORMTYPE_UVEC4] = 4;
 
 /**
  * A class storing description of an individual uniform, stored inside a uniform buffer.
+ *
+ * @category Graphics
  */
 class UniformFormat {
     /**
@@ -201,6 +203,8 @@ class UniformFormat {
 
 /**
  * A descriptor that defines the layout of of data inside the uniform buffer.
+ *
+ * @category Graphics
  */
 class UniformBufferFormat {
     /**

src/scene/constants.js

@@ -322,7 +322,10 @@ export const lightFalloffNames = {
  */
 export const SHADOW_PCF3_32F = 0;
 
-/** @deprecated */
+/**
+ * @deprecated
+ * @ignore
+ */
 export const SHADOW_PCF3 = 0; // alias for SHADOW_PCF3_32F for backwards compatibility
 
 /**
@@ -336,7 +339,10 @@ export const SHADOW_PCF3 = 0; // alias for SHADOW_PCF3_32F for backwards compati
  */
 export const SHADOW_VSM_16F = 2;
 
-/** @deprecated */
+/**
+ * @deprecated
+ * @ignore
+ */
 export const SHADOW_VSM16 = 2; // alias for SHADOW_VSM_16F for backwards compatibility
 
 /**
@@ -350,7 +356,10 @@ export const SHADOW_VSM16 = 2; // alias for SHADOW_VSM_16F for backwards compati
  */
 export const SHADOW_VSM_32F = 3;
 
-/** @deprecated */
+/**
+ * @deprecated
+ * @ignore
+ */
 export const SHADOW_VSM32 = 3; // alias for SHADOW_VSM_32F for backwards compatibility
 
 /**
@@ -362,7 +371,10 @@ export const SHADOW_VSM32 = 3; // alias for SHADOW_VSM_32F for backwards compati
  */
 export const SHADOW_PCF5_32F = 4;
 
-/** @deprecated */
+/**
+ * @deprecated
+ * @ignore
+ */
 export const SHADOW_PCF5 = 4;  // alias for SHADOW_PCF5_32F for backwards compatibility
 
 /**
@@ -374,7 +386,10 @@ export const SHADOW_PCF5 = 4;  // alias for SHADOW_PCF5_32F for backwards compat
  */
 export const SHADOW_PCF1_32F = 5;
 
-/** @deprecated */
+/**
+ * @deprecated
+ * @ignore
+ */
 export const SHADOW_PCF1 = 5;  // alias for SHADOW_PCF1_32F for backwards compatibility
 
 /**