未验证 提交 dceadef7 编写于 作者: S Servin Nissen 提交者: GitHub

Docs: update dispose return type (#22237)

* feat: update doc for dispose return type

* Change return type to undefined

* Without prettier

* Revert prettier changes
上级 aa158032
......@@ -31,7 +31,6 @@ scene.add( helper );
<h2>Constructor</h2>
<h3>[name]( [param:Camera camera] )</h3>
<p>
[page:Camera camera] -- The camera to visualize.<br /><br />
......@@ -39,13 +38,9 @@ scene.add( helper );
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>
......@@ -57,20 +52,16 @@ scene.add( helper );
<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>
......
......@@ -117,7 +117,7 @@
<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].
......
......@@ -52,7 +52,7 @@
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>
......
......@@ -105,7 +105,7 @@ scene.add( light );
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].
......
......@@ -163,7 +163,7 @@ light.target = targetObject;
<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].
......
......@@ -122,7 +122,7 @@
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>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册