Procházet zdrojové kódy

Docs: update dispose return type (#22237)

* feat: update doc for dispose return type

* Change return type to undefined

* Without prettier

* Revert prettier changes
Servin Nissen před 4 roky
rodič
revize
dceadef76d

+ 3 - 12
docs/api/en/helpers/CameraHelper.html

@@ -31,7 +31,6 @@ scene.add( helper );
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-
 		<h3>[name]( [param:Camera camera] )</h3>
 		<h3>[name]( [param:Camera camera] )</h3>
 		<p>
 		<p>
 		[page:Camera camera] -- The camera to visualize.<br /><br />
 		[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.
 		This create a new [Name] for the specified camera.
 		</p>
 		</p>
 
 
-
-
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 		<p>See the base [page:LineSegments] class for common properties.</p>
 		<p>See the base [page:LineSegments] class for common properties.</p>
 
 
-
-
 		<h3>[property:Camera camera]</h3>
 		<h3>[property:Camera camera]</h3>
 		<p>The camera being visualized.</p>
 		<p>The camera being visualized.</p>
 
 
@@ -57,20 +52,16 @@ scene.add( helper );
 
 
 		<h3>[property:Object matrixAutoUpdate]</h3>
 		<h3>[property:Object matrixAutoUpdate]</h3>
 		<p>
 		<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].
 			camera's [page:Object3D.matrixWorld matrixWorld].
 		</p>
 		</p>
 
 
-
-
-
-
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 		<p>See the base [page:LineSegments] class for common methods.</p>
 		<p>See the base [page:LineSegments] class for common methods.</p>
 
 
-		<h3>[method:CameraHelper dispose]()</h3>
+		<h3>[method:undefined dispose]()</h3>
 		<p>
 		<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>
 		</p>
 
 
 		<h3>[method:null update]()</h3>
 		<h3>[method:null update]()</h3>

+ 1 - 1
docs/api/en/lights/DirectionalLight.html

@@ -117,7 +117,7 @@
 
 
 		<p>See the base [page:Light Light] class for common methods.</p>
 		<p>See the base [page:Light Light] class for common methods.</p>
 
 
-		<h3>[method:DirectionalLight dispose]()</h3>
+		<h3>[method:undefined dispose]()</h3>
 		<p>
 		<p>
 		Override of base class's [page:Light.dispose dispose].
 		Override of base class's [page:Light.dispose dispose].
 		Disposes of this light's [page:DirectionalLightShadow shadow].
 		Disposes of this light's [page:DirectionalLightShadow shadow].

+ 1 - 1
docs/api/en/lights/Light.html

@@ -52,7 +52,7 @@
 			See the base [page:Object3D Object3D] class for common methods.
 			See the base [page:Object3D Object3D] class for common methods.
 		</p>
 		</p>
 
 
-		<h3>[method:Light dispose]()</h3>
+		<h3>[method:undefined dispose]()</h3>
 		<p>
 		<p>
 		Abstract dispose method for lights; implemented by subclasses that have disposable resources.
 		Abstract dispose method for lights; implemented by subclasses that have disposable resources.
 		</p>
 		</p>

+ 1 - 1
docs/api/en/lights/PointLight.html

@@ -105,7 +105,7 @@ scene.add( light );
 			See the base [page:Light Light] class for common methods.
 			See the base [page:Light Light] class for common methods.
 		</p>
 		</p>
 
 
-		<h3>[method:PointLight dispose]()</h3>
+		<h3>[method:undefined dispose]()</h3>
 		<p>
 		<p>
 		Override of base class's [page:Light.dispose dispose].
 		Override of base class's [page:Light.dispose dispose].
 		Disposes of this light's [page:PointLightShadow shadow].
 		Disposes of this light's [page:PointLightShadow shadow].

+ 1 - 1
docs/api/en/lights/SpotLight.html

@@ -163,7 +163,7 @@ light.target = targetObject;
 
 
 		<p>See the base [page:Light Light] class for common methods.</p>
 		<p>See the base [page:Light Light] class for common methods.</p>
 
 
-		<h3>[method:SpotLight dispose]()</h3>
+		<h3>[method:undefined dispose]()</h3>
 		<p>
 		<p>
 		Override of base class's [page:Light.dispose dispose].
 		Override of base class's [page:Light.dispose dispose].
 		Disposes of this light's [page:SpotLightShadow shadow].
 		Disposes of this light's [page:SpotLightShadow shadow].

+ 1 - 1
docs/api/en/lights/shadows/LightShadow.html

@@ -122,7 +122,7 @@
 		Used internally by the renderer to get the number of viewports that need to be rendered for this shadow.
 		Used internally by the renderer to get the number of viewports that need to be rendered for this shadow.
 		</p>
 		</p>
 
 
-		<h3>[method:LightShadow dispose]()</h3>
+		<h3>[method:undefined dispose]()</h3>
 		<p>
 		<p>
 		Disposes of this shadow's textures ([page:LightShadow.map map] and [page:LightShadow.mapPass mapPass]).
 		Disposes of this shadow's textures ([page:LightShadow.map map] and [page:LightShadow.mapPass mapPass]).
 		</p>
 		</p>