Explorar o código

Make documentation clearer and less redundant

Improving documentation for .set() methods in math classes. #17738
Neptilo %!s(int64=5) %!d(string=hai) anos
pai
achega
60592d2ea5
Modificáronse 3 ficheiros con 3 adicións e 7 borrados
  1. 1 2
      docs/api/en/math/Line3.html
  2. 1 2
      docs/api/en/math/Plane.html
  3. 1 3
      docs/api/en/math/Ray.html

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

@@ -113,8 +113,7 @@
 		[page:Vector3 start] - set the [page:.start start point] of the line.<br />
 		[page:Vector3 end] - set the [page:.end end point] of the line.<br /><br />
 
-		Sets the start and end values by copying the provided vectors.<br>
-		Please note that this method only copies the values from the given objects.
+		Sets the start and end values by copying the provided vectors.
 		</p>
 
 		<h2>Source</h2>

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

@@ -130,8 +130,7 @@
 			[page:Vector3 normal] - a unit length [page:Vector3] defining the normal of the plane.<br />
 			[page:Float constant] - the signed distance from the origin to the plane. Default is *0*.<br /><br />
 
-			Sets the plane's [page:.normal normal] and [page:.constant constant] properties.<br>
-			Please note that this method only copies the values from the given normal.
+			Sets this plane's [page:.normal normal] and [page:.constant constant] properties by copying the values from the given normal.
 		</p>
 
 		<h3>[method:Plane setComponents]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>

+ 1 - 3
docs/api/en/math/Ray.html

@@ -201,9 +201,7 @@
 		This must be normalized (with [page:Vector3.normalize]) for the methods to operate
 		properly.<br /><br />
 
-		Copy the parameters to the [page:.origin origin] and [page:.direction direction] properties
-		of this ray.<br>
-		Please note that this method only copies the values from the given objects.
+		Sets this ray's [page:.origin origin] and [page:.direction direction] properties by copying the values from the given objects.
 		</p>