Skip to content

Docs: update dispose return type #22237

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.

Sign up for GitHub

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 5 commits into from
Aug 3, 2021
Merged

Docs: update dispose return type #22237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e2ba255
feat: update doc for dispose return type
servinlp Aug 1, 2021
be971b1
Change return type to undefined
servinlp Aug 3, 2021
2232c63
Without prettier
servinlp Aug 3, 2021
4a110c2
Merge branch 'feature/dispose-docs' of github.com:servinlp/three.js i…
servinlp Aug 3, 2021
93afba0
Revert prettier changes
servinlp Aug 3, 2021
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
15 changes: 3 additions & 12 deletions docs/api/en/helpers/CameraHelper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,16 @@ <h2>Examples</h2>

<h2>Constructor</h2>


<h3>[name]( [param:Camera camera] )</h3>
<p>
[page:Camera camera] -- The camera to visualize.<br /><br />

This create a new [Name] for the specified camera.
</p>



<h2>Properties</h2>
<p>See the base [page:LineSegments] class for common properties.</p>



<h3>[property:Camera camera]</h3>
<p>The camera being visualized.</p>

Expand All @@ -57,20 +52,16 @@ <h3>[property:Object matrix]</h3>

<h3>[property:Object matrixAutoUpdate]</h3>
<p>
See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
camera's [page:Object3D.matrixWorld matrixWorld].
</p>





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

<h3>[method:CameraHelper dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>
Disposes of the internally-created [page:Line.material material] and [page:Line.geometry geometry] used by this helper.
Disposes of the internally-created [page:Line.material material] and [page:Line.geometry geometry] used by this helper.
</p>

<h3>[method:null update]()</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/lights/DirectionalLight.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h2>Methods</h2>

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

<h3>[method:DirectionalLight dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>
Override of base class's [page:Light.dispose dispose].
Disposes of this light's [page:DirectionalLightShadow shadow].
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/lights/Light.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ <h2>Methods</h2>
See the base [page:Object3D Object3D] class for common methods.
</p>

<h3>[method:Light dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>
Abstract dispose method for lights; implemented by subclasses that have disposable resources.
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/lights/PointLight.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h2>Methods</h2>
See the base [page:Light Light] class for common methods.
</p>

<h3>[method:PointLight dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>
Override of base class's [page:Light.dispose dispose].
Disposes of this light's [page:PointLightShadow shadow].
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/lights/SpotLight.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ <h2>Methods</h2>

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

<h3>[method:SpotLight dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>
Override of base class's [page:Light.dispose dispose].
Disposes of this light's [page:SpotLightShadow shadow].
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/lights/shadows/LightShadow.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h3>[method:number getViewportCount]()</h3>
Used internally by the renderer to get the number of viewports that need to be rendered for this shadow.
</p>

<h3>[method:LightShadow dispose]()</h3>
<h3>[method:undefined dispose]()</h3>
<p>
Disposes of this shadow's textures ([page:LightShadow.map map] and [page:LightShadow.mapPass mapPass]).
</p>
Expand Down