Skip to content

JSDoc: More import sections. #30860

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

Merged
merged 1 commit into from
Apr 4, 2025
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions examples/jsm/animation/AnimationClipCreator.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
* A utility class with factory methods for creating basic animation clips.
*
* @hideconstructor
* @three_import import { AnimationClipCreator } from 'three/addons/animation/AnimationClipCreator.js';
*/
class AnimationClipCreator {

Expand Down
3 changes: 3 additions & 0 deletions examples/jsm/animation/CCDIKSolver.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ const _matrix = new Matrix4();
* This class solves the Inverse Kinematics Problem with a [CCD Algorithm]{@link https://web.archive.org/web/20221206080850/https://sites.google.com/site/auraliusproject/ccd-algorithm}.
*
* `CCDIKSolver` is designed to work with instances of {@link SkinnedMesh}.
*
* @three_import import { CCDIKSolver } from 'three/addons/animation/CCDIKSolver.js';
*/
class CCDIKSolver {

Expand Down Expand Up @@ -322,6 +324,7 @@ function setPositionOfBoneToAttributeArray( array, index, bone, matrixWorldInv )
* Helper for visualizing IK bones.
*
* @augments Object3D
* @three_import import { CCDIKHelper } from 'three/addons/animation/CCDIKSolver.js';
*/
class CCDIKHelper extends Object3D {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/capabilities/WebGL.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* A utility module with basic WebGL 2 capability testing.
*
* @hideconstructor
* @three_import import WebGL from 'three/addons/capabilities/WebGL.js';
*/
class WebGL {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/capabilities/WebGPU.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ if ( typeof window !== 'undefined' && isAvailable ) {
* A utility module with basic WebGPU capability testing.
*
* @hideconstructor
* @three_import import WebGPU from 'three/addons/capabilities/WebGPU.js';
*/
class WebGPU {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/ArcballControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ const _EPS = 0.000001;
* animation loop when animations are on.
*
* @augments Controls
* @three_import import { ArcballControls } from 'three/addons/controls/ArcballControls.js';
*/
class ArcballControls extends Controls {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/DragControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ const STATE = {
* ```
*
* @augments Controls
* @three_import import { DragControls } from 'three/addons/controls/DragControls.js';
*/
class DragControls extends Controls {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/FirstPersonControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const _targetPosition = new Vector3();
* This class is an alternative implementation of {@link FlyControls}.
*
* @augments Controls
* @three_import import { FirstPersonControls } from 'three/addons/controls/FirstPersonControls.js';
*/
class FirstPersonControls extends Controls {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/FlyControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const _tmpQuaternion = new Quaternion();
* (e.g. focus on a specific target).
*
* @augments Controls
* @three_import import { FlyControls } from 'three/addons/controls/FlyControls.js';
*/
class FlyControls extends Controls {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/MapControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { OrbitControls } from './OrbitControls.js';
* - Pan: Left mouse, or arrow keys / touch: one-finger move.
*
* @augments OrbitControls
* @three_import import { MapControls } from 'three/addons/controls/MapControls.js';
*/
class MapControls extends OrbitControls {

Expand Down
3 changes: 2 additions & 1 deletion examples/jsm/controls/PointerLockControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ const _PI_2 = Math.PI / 2;
* ```
*
* @augments Controls
* @three_import import { PointerLockControls } from 'three/addons/controls/PointerLockControls.js';
*/
class PointerLockControls extends Controls {

Expand Down Expand Up @@ -200,7 +201,7 @@ class PointerLockControls extends Controls {

/**
* Activates the pointer lock.
*
*
* @param {boolean} [unadjustedMovement=false] - Disables OS-level adjustment for mouse acceleration, and accesses raw mouse input instead.
* Setting it to true will disable mouse acceleration.
*/
Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/TrackballControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const _moveDirection = new Vector3();
* to stay "right side up".
*
* @augments Controls
* @three_import import { TrackballControls } from 'three/addons/controls/TrackballControls.js';
*/
class TrackballControls extends Controls {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/controls/TransformControls.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ const _objectChangeEvent = { type: 'objectChange' };
* `TransformControls` expects that its attached 3D object is part of the scene graph.
*
* @augments Controls
* @three_import import { TransformControls } from 'three/addons/controls/TransformControls.js';
*/
class TransformControls extends Controls {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/csm/CSM.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ const _up = new Vector3( 0, 1, 0 );
*
* This module can only be used with {@link WebGLRenderer}. When using {@link WebGPURenderer},
* use {@link CSMShadowNode} instead.
*
* @three_import import { CSM } from 'three/addons/csm/CSM.js';
*/
export class CSM {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/csm/CSMFrustum.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ const inverseProjectionMatrix = new Matrix4();

/**
* Represents the frustum of a CSM instance.
*
* @three_import import { CSMFrustum } from 'three/addons/csm/CSMFrustum.js';
*/
class CSMFrustum {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/csm/CSMHelper.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
* A helper for visualizing the cascades of a CSM instance.
*
* @augments Group
* @three_import import { CSMHelper } from 'three/addons/csm/CSMHelper.js';
*/
class CSMHelper extends Group {

Expand Down
5 changes: 4 additions & 1 deletion examples/jsm/csm/CSMShader.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { ShaderChunk } from 'three';

/** @module CSMShader */
/**
* @module CSMShader
* @three_import import { CSMShader } from 'three/addons/csm/CSMShader.js';
*/

/**
* The object that holds the GLSL enhancements to enable CSM. This
Expand Down
1 change: 1 addition & 0 deletions examples/jsm/csm/CSMShadowNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class LwLight extends Object3D {
* use {@link CSM} instead.
*
* @augments ShadowBaseNode
* @three_import import { CSMShadowNode } from 'three/addons/csm/CSMShadowNode.js';
*/
class CSMShadowNode extends ShadowBaseNode {

Expand Down
14 changes: 14 additions & 0 deletions examples/jsm/curves/CurveExtras.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
* A Granny Knot curve.
*
* @augments Curve
* @three_import import { GrannyKnot } from 'three/addons/curves/CurveExtras.js';
*/
class GrannyKnot extends Curve {

Expand Down Expand Up @@ -47,6 +48,7 @@ class GrannyKnot extends Curve {
* A heart curve.
*
* @augments Curve
* @three_import import { HeartCurve } from 'three/addons/curves/CurveExtras.js';
*/
class HeartCurve extends Curve {

Expand Down Expand Up @@ -96,6 +98,7 @@ class HeartCurve extends Curve {
* A Viviani curve.
*
* @augments Curve
* @three_import import { VivianiCurve } from 'three/addons/curves/CurveExtras.js';
*/
class VivianiCurve extends Curve {

Expand Down Expand Up @@ -146,6 +149,7 @@ class VivianiCurve extends Curve {
* A knot curve.
*
* @augments Curve
* @three_import import { KnotCurve } from 'three/addons/curves/CurveExtras.js';
*/
class KnotCurve extends Curve {

Expand Down Expand Up @@ -179,6 +183,7 @@ class KnotCurve extends Curve {
* A helix curve.
*
* @augments Curve
* @three_import import { HelixCurve } from 'three/addons/curves/CurveExtras.js';
*/
class HelixCurve extends Curve {

Expand Down Expand Up @@ -212,6 +217,7 @@ class HelixCurve extends Curve {
* A Trefoil Knot.
*
* @augments Curve
* @three_import import { TrefoilKnot } from 'three/addons/curves/CurveExtras.js';
*/
class TrefoilKnot extends Curve {

Expand Down Expand Up @@ -261,6 +267,7 @@ class TrefoilKnot extends Curve {
* A torus knot.
*
* @augments Curve
* @three_import import { TorusKnot } from 'three/addons/curves/CurveExtras.js';
*/
class TorusKnot extends Curve {

Expand Down Expand Up @@ -313,6 +320,7 @@ class TorusKnot extends Curve {
* A Cinquefoil Knot.
*
* @augments Curve
* @three_import import { CinquefoilKnot } from 'three/addons/curves/CurveExtras.js';
*/
class CinquefoilKnot extends Curve {

Expand Down Expand Up @@ -365,6 +373,7 @@ class CinquefoilKnot extends Curve {
* A Trefoil Polynomial Knot.
*
* @augments Curve
* @three_import import { TrefoilPolynomialKnot } from 'three/addons/curves/CurveExtras.js';
*/
class TrefoilPolynomialKnot extends Curve {

Expand Down Expand Up @@ -421,6 +430,7 @@ function scaleTo( x, y, t ) {
* A Figure Eight Polynomial Knot.
*
* @augments Curve
* @three_import import { FigureEightPolynomialKnot } from 'three/addons/curves/CurveExtras.js';
*/
class FigureEightPolynomialKnot extends Curve {

Expand Down Expand Up @@ -470,6 +480,7 @@ class FigureEightPolynomialKnot extends Curve {
* A Decorated Torus Knot 4a.
*
* @augments Curve
* @three_import import { DecoratedTorusKnot4a } from 'three/addons/curves/CurveExtras.js';
*/
class DecoratedTorusKnot4a extends Curve {

Expand Down Expand Up @@ -519,6 +530,7 @@ class DecoratedTorusKnot4a extends Curve {
* A Decorated Torus Knot 4b.
*
* @augments Curve
* @three_import import { DecoratedTorusKnot4b } from 'three/addons/curves/CurveExtras.js';
*/
class DecoratedTorusKnot4b extends Curve {

Expand Down Expand Up @@ -568,6 +580,7 @@ class DecoratedTorusKnot4b extends Curve {
* A Decorated Torus Knot 5a.
*
* @augments Curve
* @three_import import { DecoratedTorusKnot5a } from 'three/addons/curves/CurveExtras.js';
*/
class DecoratedTorusKnot5a extends Curve {

Expand Down Expand Up @@ -617,6 +630,7 @@ class DecoratedTorusKnot5a extends Curve {
* A Decorated Torus Knot 5c.
*
* @augments Curve
* @three_import import { DecoratedTorusKnot5c } from 'three/addons/curves/CurveExtras.js';
*/
class DecoratedTorusKnot5c extends Curve {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/curves/NURBSCurve.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import * as NURBSUtils from '../curves/NURBSUtils.js';
* Implementation is based on `(x, y [, z=0 [, w=1]])` control points with `w=weight`.
*
* @augments Curve
* @three_import import { NURBSCurve } from 'three/addons/curves/NURBSCurve.js';
*/
class NURBSCurve extends Curve {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/curves/NURBSSurface.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import * as NURBSUtils from '../curves/NURBSUtils.js';
* This class represents a NURBS surface.
*
* Implementation is based on `(x, y [, z=0 [, w=1]])` control points with `w=weight`.
*
* @three_import import { NURBSSurface } from 'three/addons/curves/NURBSSurface.js';
*/
class NURBSSurface {

Expand Down
5 changes: 4 additions & 1 deletion examples/jsm/curves/NURBSUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ import {
Vector4
} from 'three';

/** @module NURBSUtils */
/**
* @module NURBSUtils
* @three_import import * as NURBSUtils from 'three/addons/curves/NURBSUtils.js';
*/

/**
* Finds knot vector span.
Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/curves/NURBSVolume.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import * as NURBSUtils from '../curves/NURBSUtils.js';
* This class represents a NURBS volume.
*
* Implementation is based on `(x, y [, z=0 [, w=1]])` control points with `w=weight`.
*
* @three_import import { NURBSVolume } from 'three/addons/curves/NURBSVolume.js';
*/
class NURBSVolume {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/effects/AnaglyphEffect.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import { FullScreenQuad } from '../postprocessing/Pass.js';
*
* Note that this class can only be used with {@link WebGLRenderer}.
* When using {@link WebGPURenderer}, use {@link AnaglyphPassNode}.
*
* @three_import import { AnaglyphEffect } from 'three/addons/effects/AnaglyphEffect.js';
*/
class AnaglyphEffect {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/effects/AsciiEffect.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* A class that creates an ASCII effect.
*
* The ASCII generation is based on [jsascii]{@link https://github.com/hassadee/jsascii/blob/master/jsascii.js}.
*
* @three_import import { AsciiEffect } from 'three/addons/effects/AsciiEffect.js';
*/
class AsciiEffect {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/effects/OutlineEffect.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import {
*
* }
* ```
*
* @three_import import { OutlineEffect } from 'three/addons/effects/OutlineEffect.js';
*/
class OutlineEffect {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/effects/ParallaxBarrierEffect.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import { FullScreenQuad } from '../postprocessing/Pass.js';
*
* Note that this class can only be used with {@link WebGLRenderer}.
* When using {@link WebGPURenderer}, use {@link ParallaxBarrierPassNode}.
*
* @three_import import { ParallaxBarrierEffect } from 'three/addons/effects/ParallaxBarrierEffect.js';
*/
class ParallaxBarrierEffect {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/effects/PeppersGhostEffect.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import {
* A class that implements a peppers ghost effect.
*
* Reference: [Reflective Prism]{@link http://www.instructables.com/id/Reflective-Prism/?ALLSTEPS}
*
* @three_import import { PeppersGhostEffect } from 'three/addons/effects/PeppersGhostEffect.js';
*/
class PeppersGhostEffect {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/effects/StereoEffect.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import {
*
* Note that this class can only be used with {@link WebGLRenderer}.
* When using {@link WebGPURenderer}, use {@link StereoPassNode}.
*
* @three_import import { StereoEffect } from 'three/addons/effects/StereoEffect.js';
*/
class StereoEffect {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/environments/DebugEnvironment.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {
* ```
*
* @augments Scene
* @three_import import { DebugEnvironment } from 'three/addons/environments/DebugEnvironment.js';
*/
class DebugEnvironment extends Scene {

Expand Down
1 change: 1 addition & 0 deletions examples/jsm/environments/RoomEnvironment.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {
* ```
*
* @augments Scene
* @three_import import { RoomEnvironment } from 'three/addons/environments/RoomEnvironment.js';
*/
class RoomEnvironment extends Scene {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/exporters/DRACOExporter.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import { Color, ColorManagement, SRGBColorSpace } from 'three';
* const exporter = new DRACOExporter();
* const data = exporter.parse( mesh, options );
* ```
*
* @three_import import { DRACOExporter } from 'three/addons/exporters/DRACOExporter.js';
*/
class DRACOExporter {

Expand Down
2 changes: 2 additions & 0 deletions examples/jsm/exporters/EXRExporter.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ const ZIP_COMPRESSION = 3;
* const exporter = new EXRExporter();
* const result = await exporter.parse( renderer, options );
* ```
*
* @three_import import { EXRExporter } from 'three/addons/exporters/EXRExporter.js';
*/
class EXRExporter {

Expand Down
Loading