Ver Fonte

Fix method link ReturnTypes for math object documenation (#9413)

* Fix method link 'ReturnType's of all math object documentation

* Misc Documentation fixes
Sean Zellmer há 9 anos atrás
pai
commit
688c2a1aa4

+ 1 - 1
docs/api/core/BufferGeometry.html

@@ -247,7 +247,7 @@
 		You need to call this when you want the bufferGeometry removed while the application is running.
 		</div>
 
-		<h3>[method:null fromGeometry]( [page:Geometry] )</h3>
+		<h3>[method:BufferGeometry fromGeometry]( [page:Geometry] )</h3>
 		<div>
 		Populates this BufferGeometry with data from a [page:Geometry] object.
 		</div>

+ 1 - 1
docs/api/math/Color.html

@@ -223,7 +223,7 @@
 		Linear interpolation of this colors rgb values and the rgb values of the first argument. The alpha argument can be thought of as the percent between the two colors, where 0 is this color and 1 is the first argument.
 		</div>
 
-		<h3>[method:Color equals]( [page:Color c] ) [page:Color this]</h3>
+		<h3>[method:Boolean equals]( [page:Color c] ) [page:Color this]</h3>
 		<div>
 		Compares this color and c and returns true if they are the same, false otherwise.
 		</div>

+ 1 - 1
docs/api/math/Frustum.html

@@ -52,7 +52,7 @@
 		Return a copy of this Frustum
 		</div>
 
-		<h3>[method:Boolean set]( [page:Plane p0], [page:Plane p1], [page:Plane p2], [page:Plane p3], [page:Plane p4], [page:Plane p5] )</h3>
+		<h3>[method:Frustum set]( [page:Plane p0], [page:Plane p1], [page:Plane p2], [page:Plane p3], [page:Plane p4], [page:Plane p5] )</h3>
 		<div>
 		p0 -- [page:Plane] <br />
 		p1 -- [page:Plane] <br />

+ 1 - 1
docs/api/math/Line3.html

@@ -86,7 +86,7 @@
 		Apply a matrix transform to the line segment.
 		</div>
 
-		<h3>[method:Vector at]( [page:Float t], [page:Vector3 optionalTarget] )</h3>
+		<h3>[method:Vector3 at]( [page:Float t], [page:Vector3 optionalTarget] )</h3>
 		<div>
 		t -- [page:Float] Use values 0-1 to return a result on the line segment. <br />
 		optionalTarget -- [page:Vector] Optional target to set the result.

+ 1 - 1
docs/api/math/Matrix4.html

@@ -172,7 +172,7 @@
 		Sets this matrix to the transformation composed of *translation*, *quaternion* and *scale*.
 		</div>
 
-		<h3>[method:Array decompose]( [page:Vector3 translation], [page:Quaternion quaternion], [page:Vector3 scale] ) [page:Matrix4 this]</h3>
+		<h3>[method:null decompose]( [page:Vector3 translation], [page:Quaternion quaternion], [page:Vector3 scale] ) [page:Matrix4 this]</h3>
 		<div>
 		Decomposes this matrix into the *translation*, *quaternion* and *scale* components.
 		</div>

+ 1 - 1
docs/api/math/Plane.html

@@ -95,7 +95,7 @@
 		Returns the intersection point of the passed line and the plane. Returns undefined if the line does not intersect. Returns the line's starting point if the line is coplanar with the plane.
 		</div>
 
-		<h3>[method:Vector3 setFromNormalAndCoplanarPoint]( [page:Vector3 normal], [page:Vector3 point] ) [page:Vector3 this]</h3>
+		<h3>[method:Plane setFromNormalAndCoplanarPoint]( [page:Vector3 normal], [page:Vector3 point] ) [page:Vector3 this]</h3>
 		<div>
 		normal -- [page:Vector3] <br />
 		point -- [page:Vector3]

+ 1 - 1
docs/api/math/Quaternion.html

@@ -202,7 +202,7 @@
 		THREE.Quaternion.slerp( startQuaternion, endQuaternion, mesh.quaternion, t );
 		</code>
 
-		<h3>[method:Quaternion slerpFlat]( [page:Array dst], [page:Integer dstOffset], [page:Array src0], [page:Integer srcOffset0], [page:Array src1], [page:Integer srcOffset1], [page:Float t] )</h3>
+		<h3>[method:null slerpFlat]( [page:Array dst], [page:Integer dstOffset], [page:Array src0], [page:Integer srcOffset0], [page:Array src1], [page:Integer srcOffset1], [page:Float t] )</h3>
 		<div>
 		dst -- The output array.<br />
 		dstOffset -- An offset into the output array.<br />

+ 1 - 1
docs/api/math/Sphere.html

@@ -99,7 +99,7 @@
 		Returns the closest distance from the boundary of the sphere to the point. If the sphere contains the point, the distance will be negative.
 		</div>
 
-		<h3>[method:Box getBoundingBox]( [page:Box optionalTarget] )</h3>
+		<h3>[method:Box3 getBoundingBox]( [page:Box optionalTarget] )</h3>
 		<div>
 		optionalTarget -- [page:Box]
 		</div>

+ 1 - 1
docs/api/math/Vector2.html

@@ -239,7 +239,7 @@
 		Sets this vector to be the vector linearly interpolated between *v1* and *v2* with *alpha* factor.
 		</div>
 
-		<h3>[method:undefined setComponent]( [page:Integer index], [page:Float value] ) [page:Vector2 this]</h3>
+		<h3>[method:null setComponent]( [page:Integer index], [page:Float value] ) [page:Vector2 this]</h3>
 		<div>
 		index -- 0 or 1 <br />
 		value -- [page:Float]

+ 1 - 1
docs/api/math/Vector3.html

@@ -303,7 +303,7 @@
 		If this vector's x, y, or z value is less than vector v's x, y, or z value, that value is replaced by the corresponding vector v value.
 		</div>
 
-		<h3>[method:Vector3 setComponent]( [page:Integer index], [page:Float value] ) [page:Vector3 this]</h3>
+		<h3>[method:null setComponent]( [page:Integer index], [page:Float value] ) [page:Vector3 this]</h3>
 		<div>
 		index -- 0, 1, or 2 <br />
 		value -- [page:Float]

+ 1 - 1
src/extras/core/Curve.js

@@ -4,7 +4,7 @@
  *
  * Some common of Curve methods
  * .getPoint(t), getTangent(t)
- * .getPointAt(u), getTagentAt(u)
+ * .getPointAt(u), getTangentAt(u)
  * .getPoints(), .getSpacedPoints()
  * .getLength()
  * .updateArcLengths()