Skip to content

Commit

Permalink
Docs: Use undefined instead of null. (#22797)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Mugen87
Mugen87 authored Nov 7, 2021
1 parent 4317b0f commit ee45007
Show file tree
Hide file tree
Showing 73 changed files with 181 additions and 181 deletions.
22 changes: 11 additions & 11 deletions docs/examples/en/controls/ArcballControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,47 +199,47 @@ <h3>[property:Float radiusFactor]</h3>

<h2>Methods</h2>

<h3>[method:null activateGizmos] ( [param:Boolean isActive] )</h3>
<h3>[method:undefined activateGizmos] ( [param:Boolean isActive] )</h3>
<p>
Make gizmos more or less visible.
</p>

<h3>[method:null copyState] ()</h3>
<h3>[method:undefined copyState] ()</h3>
<p>
Copy the current state to clipboard (as a readable JSON text).
</p>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Remove all the event listeners, cancel any pending animation and clean the scene from gizmos and grid.
</p>

<h3>[method:null pasteState] ()</h3>
<h3>[method:undefined pasteState] ()</h3>
<p>
Set the controls state from the clipboard, assumes that the clipboard stores a JSON text as saved from [page:.copyState].
</p>

<h3>[method:null reset] ()</h3>
<h3>[method:undefined reset] ()</h3>
<p>
Reset the controls to their state from either the last time the [page:.saveState] was called, or the initial state.
</p>

<h3>[method:null saveState] ()</h3>
<h3>[method:undefined saveState] ()</h3>
<p>
Save the current state of the controls. This can later be recovered with [page:.reset].
</p>

<h3>[method:null setCamera] ( [param:Camera camera] )</h3>
<h3>[method:undefined setCamera] ( [param:Camera camera] )</h3>
<p>
Set the camera to be controlled. Must be called in order to set a new camera to be controlled.
</p>

<h3>[method:null setGizmosVisible] ( [param:Boolean value] )</h3>
<h3>[method:undefined setGizmosVisible] ( [param:Boolean value] )</h3>
<p>
Set the visible property of gizmos.
</p>

<h3>[method:null setTbRadius] ( [param:Float value] )</h3>
<h3>[method:undefined setTbRadius] ( [param:Float value] )</h3>
<p>
Update the `radiusFactor` value, redraw the gizmo and send a `changeEvent` to visualise the changes.
</p>
Expand All @@ -252,7 +252,7 @@ <h3>[method:Boolean setMouseAction] ( [param:String operation], mouse, key )</h3
Keyboard modifiers can be specified as 'CTRL', 'SHIFT' or null if not needed.
</p>

<h3>[method:null setTarget] ( [param:Float x], [param:Float y], [param:Float z] )</h3>
<h3>[method:undefined setTarget] ( [param:Float x], [param:Float y], [param:Float z] )</h3>
<p>
Set the trackball center point.
</p>
Expand All @@ -264,7 +264,7 @@ <h3>[method:Boolean unsetMouseAction] ( mouse, key )</h3>
Keyboard modifiers can be specified as 'CTRL', 'SHIFT' or null if not needed.
</p>

<h3>[method:null update] ()</h3>
<h3>[method:undefined update] ()</h3>
<p>
Update the controls. Must be called after any manual changes to the camera's transform.
</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/en/controls/DragControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,17 +101,17 @@ <h2>Methods</h2>

<p>See the base [page:EventDispatcher] class for common methods.</p>

<h3>[method:null activate] ()</h3>
<h3>[method:undefined activate] ()</h3>
<p>
Adds the event listeners of the controls.
</p>

<h3>[method:null deactivate] ()</h3>
<h3>[method:undefined deactivate] ()</h3>
<p>
Removes the event listeners of the controls.
</p>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Should be called if the controls is no longer required.
</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/en/controls/FirstPersonControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,12 @@ <h3>[property:Number verticalMin]</h3>

<h2>Methods</h2>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Should be called if the controls is no longer required.
</p>

<h3>[method:null handleResize] ()</h3>
<h3>[method:undefined handleResize] ()</h3>
<p>
Should be called if the application window is resized.
</p>
Expand All @@ -145,7 +145,7 @@ <h3>[method:FirstPersonControls lookAt]( [param:Vector3 vector] )<br />
</p>
</p>

<h3>[method:null update] ( [param:Number delta] )</h3>
<h3>[method:undefined update] ( [param:Number delta] )</h3>
<p>
<p>
[page:Number delta]: Time delta value.
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/en/controls/FlyControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ <h3>[property:Number rollSpeed]</h3>

<h2>Methods</h2>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Should be called if the controls is no longer required.
</p>

<h3>[method:null update] ( [param:Number delta] )</h3>
<h3>[method:undefined update] ( [param:Number delta] )</h3>
<p>
<p>
[page:Number delta]: Time delta value.
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/en/controls/OrbitControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h3>[property:Float zoomSpeed]</h3>

<h2>Methods</h2>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Remove all the event listeners.
</p>
Expand All @@ -292,12 +292,12 @@ <h3>[method:undefined listenToKeyEvents] ( [param:HTMLDOMElement domElement] )</
Adds key event listeners to the given DOM element. *window* is a recommended argument for using this method.
</p>

<h3>[method:null reset] ()</h3>
<h3>[method:undefined reset] ()</h3>
<p>
Reset the controls to their state from either the last time the [page:.saveState] was called, or the initial state.
</p>

<h3>[method:null saveState] ()</h3>
<h3>[method:undefined saveState] ()</h3>
<p>
Save the current state of the controls. This can later be recovered with [page:.reset].
</p>
Expand Down
12 changes: 6 additions & 6 deletions docs/examples/en/controls/PointerLockControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,12 @@ <h2>Methods</h2>

<p>See the base [page:EventDispatcher] class for common methods.</p>

<h3>[method:null connect] ()</h3>
<h3>[method:undefined connect] ()</h3>
<p>
Adds the event listeners of the controls.
</p>

<h3>[method:null disconnect] ()</h3>
<h3>[method:undefined disconnect] ()</h3>
<p>
Removes the event listeners of the controls.
</p>
Expand All @@ -120,12 +120,12 @@ <h3>[method:Vector3 getDirection] ( [param:Vector3 target] )</h3>
</p>
</p>

<h3>[method:null lock] ()</h3>
<h3>[method:undefined lock] ()</h3>
<p>
Activates the pointer lock.
</p>

<h3>[method:null moveForward] ( [param:Number distance] )</h3>
<h3>[method:undefined moveForward] ( [param:Number distance] )</h3>
<p>
<p>
[page:Number distance]: The signed distance.
Expand All @@ -135,7 +135,7 @@ <h3>[method:null moveForward] ( [param:Number distance] )</h3>
</p>
</p>

<h3>[method:null moveRight] ( [param:Number distance] )</h3>
<h3>[method:undefined moveRight] ( [param:Number distance] )</h3>
<p>
<p>
[page:Number distance]: The signed distance.
Expand All @@ -145,7 +145,7 @@ <h3>[method:null moveRight] ( [param:Number distance] )</h3>
</p>
</p>

<h3>[method:null unlock] ()</h3>
<h3>[method:undefined unlock] ()</h3>
<p>
Exits the pointer lock.
</p>
Expand Down
16 changes: 8 additions & 8 deletions docs/examples/en/controls/TrackballControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,42 +157,42 @@ <h3>[property:Number zoomSpeed]</h3>

<h2>Methods</h2>

<h3>[method:null checkDistances] ()</h3>
<h3>[method:undefined checkDistances] ()</h3>
<p>
Ensures the controls stay in the range [minDistance, maxDistance]. Called by [page:.update update]().
</p>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Should be called if the controls is no longer required.
</p>

<h3>[method:null handleResize] ()</h3>
<h3>[method:undefined handleResize] ()</h3>
<p>
Should be called if the application window is resized.
</p>

<h3>[method:null panCamera] ()</h3>
<h3>[method:undefined panCamera] ()</h3>
<p>
Performs panning if necessary. Called by [page:.update update]().
</p>

<h3>[method:null reset] ()</h3>
<h3>[method:undefined reset] ()</h3>
<p>
Resets the controls to its initial state.
</p>

<h3>[method:null rotateCamera] ()</h3>
<h3>[method:undefined rotateCamera] ()</h3>
<p>
Rotates the camera if necessary. Called by [page:.update update]().
</p>

<h3>[method:null update] ()</h3>
<h3>[method:undefined update] ()</h3>
<p>
Updates the controls. Usually called in the animation loop.
</p>

<h3>[method:null zoomCamera] ()</h3>
<h3>[method:undefined zoomCamera] ()</h3>
<p>
Performs zooming if necessary. Called by [page:.update update]().
</p>
Expand Down
12 changes: 6 additions & 6 deletions docs/examples/en/controls/TransformControls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h3>[method:TransformControls detach] ()</h3>
Removes the current 3D object from the controls and makes the helper UI is invisible.
</p>

<h3>[method:null dispose] ()</h3>
<h3>[method:undefined dispose] ()</h3>
<p>
Should be called if the controls is no longer required.
</p>
Expand All @@ -174,7 +174,7 @@ <h3>[method:String getMode] ()</h3>
Returns the transformation mode.
</p>

<h3>[method:null setMode] ( [param:String mode] )</h3>
<h3>[method:undefined setMode] ( [param:String mode] )</h3>
<p>
<p>
[page:String mode]: The transformation mode.
Expand All @@ -184,7 +184,7 @@ <h3>[method:null setMode] ( [param:String mode] )</h3>
</p>
</p>

<h3>[method:null setRotationSnap] ( [param:Number rotationSnap] )</h3>
<h3>[method:undefined setRotationSnap] ( [param:Number rotationSnap] )</h3>
<p>
<p>
[page:Number rotationSnap]: The rotation snap.
Expand All @@ -194,7 +194,7 @@ <h3>[method:null setRotationSnap] ( [param:Number rotationSnap] )</h3>
</p>
</p>

<h3>[method:null setSize] ( [param:Number size] )</h3>
<h3>[method:undefined setSize] ( [param:Number size] )</h3>
<p>
<p>
[page:Number size]: The size of the helper UI.
Expand All @@ -204,7 +204,7 @@ <h3>[method:null setSize] ( [param:Number size] )</h3>
</p>
</p>

<h3>[method:null setSpace] ( [param:String space] )</h3>
<h3>[method:undefined setSpace] ( [param:String space] )</h3>
<p>
<p>
[page:String space]: The coordinate space in which transformations are applied.
Expand All @@ -214,7 +214,7 @@ <h3>[method:null setSpace] ( [param:String space] )</h3>
</p>
</p>

<h3>[method:null setTranslationSnap] ( [param:Number translationSnap] )</h3>
<h3>[method:undefined setTranslationSnap] ( [param:Number translationSnap] )</h3>
<p>
<p>
[page:Number translationSnap]: The translation snap.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/exporters/ColladaExporter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h3>[name]()</h3>

<h2>Methods</h2>

<h3>[method:null parse]( [param:Object3D input], [param:Function onCompleted], [param:Object options] )</h3>
<h3>[method:Object parse]( [param:Object3D input], [param:Function onCompleted], [param:Object options] )</h3>
<p>
[page:Object input] — Object3D to be exported<br />
[page:Function onCompleted] — Will be called when the export completes. Optional. The same data is immediately returned from the function.<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/exporters/GLTFExporter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h3>[name]()</h3>

<h2>Methods</h2>

<h3>[method:null parse]( [param:Object3D input], [param:Function onCompleted], [param:Object options] )</h3>
<h3>[method:undefined parse]( [param:Object3D input], [param:Function onCompleted], [param:Object options] )</h3>
<p>
[page:Object input] — Scenes or objects to export. Valid options:<br />
<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/exporters/PLYExporter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h3>[name]()</h3>

<h2>Methods</h2>

<h3>[method:null parse]( [param:Object3D input], [param:Function onDone], [param:Object options] )</h3>
<h3>[method:Object parse]( [param:Object3D input], [param:Function onDone], [param:Object options] )</h3>
<p>
[page:Object input] — Object3D<br />
[page:Function onCompleted] — Will be called when the export completes. The argument will be the generated ply ascii or binary ArrayBuffer.<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/helpers/LightProbeHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h3>[property:Number size]</h3>
<h2>Methods</h2>
<p>See the base [page:Mesh] class for common methods.</p>

<h3>[method:null dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>Frees internal resources.</p>


Expand Down
4 changes: 2 additions & 2 deletions docs/examples/en/helpers/PositionalAudioHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ <h3>[property:Number divisionsOuterAngle]</h3>
<h2>Methods</h2>
<p>See the base [page:Object3D] class for common methods.</p>

<h3>[method:null dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>Disposes of the helper.</p>

<h3>[method:null update]()</h3>
<h3>[method:undefined update]()</h3>
<p>Updates the helper.</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/helpers/RectAreaLightHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ <h3>[property:hex color]</h3>
<h2>Methods</h2>
<p>See the base [page:Object3D] class for common methods.</p>

<h3>[method:null dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>Dispose of the rectAreaLightHelper.</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/helpers/VertexNormalsHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ <h2>Methods</h2>
<p>See the base [page:LineSegments] class for common methods.</p>


<h3>[method:null update]()</h3>
<h3>[method:undefined update]()</h3>
<p>Updates the vertex normal preview based on movement of the object.</p>


Expand Down
2 changes: 1 addition & 1 deletion docs/examples/en/helpers/VertexTangentsHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ <h2>Methods</h2>
<p>See the base [page:LineSegments] class for common methods.</p>


<h3>[method:null update]()</h3>
<h3>[method:undefined update]()</h3>
<p>Updates the vertex tangents preview based on the object's world transform.</p>


Expand Down
Loading

0 comments on commit ee45007

Please sign in to comment.