Browse Source

Specify return value of Transform3D.scaled() and more

Add more `[code]` (Transform3D)

Co-authored-by: kleonc <[email protected]>

Add more `[code]` (Transform2D)

Co-authored-by: kleonc <[email protected]>
Micky 3 years ago
parent
commit
87599054d2
2 changed files with 6 additions and 6 deletions
  1. 3 3
      doc/classes/Transform2D.xml
  2. 3 3
      doc/classes/Transform3D.xml

+ 3 - 3
doc/classes/Transform2D.xml

@@ -141,14 +141,14 @@
 			<return type="Transform2D" />
 			<argument index="0" name="phi" type="float" />
 			<description>
-				Rotates the transform by the given angle (in radians), using matrix multiplication.
+				Returns a copy of the transform rotated by the given [code]phi[/code] angle (in radians), using matrix multiplication.
 			</description>
 		</method>
 		<method name="scaled" qualifiers="const">
 			<return type="Transform2D" />
 			<argument index="0" name="scale" type="Vector2" />
 			<description>
-				Scales the transform by the given scale factor, using matrix multiplication.
+				Returns a copy of the transform scaled by the given [code]scale[/code] factor, using matrix multiplication.
 			</description>
 		</method>
 		<method name="set_rotation">
@@ -176,7 +176,7 @@
 			<return type="Transform2D" />
 			<argument index="0" name="offset" type="Vector2" />
 			<description>
-				Translates the transform by the given offset, relative to the transform's basis vectors.
+				Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
 				Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
 			</description>
 		</method>

+ 3 - 3
doc/classes/Transform3D.xml

@@ -96,14 +96,14 @@
 			<argument index="0" name="axis" type="Vector3" />
 			<argument index="1" name="phi" type="float" />
 			<description>
-				Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
+				Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]phi[/code] angle (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector.
 			</description>
 		</method>
 		<method name="scaled" qualifiers="const">
 			<return type="Transform3D" />
 			<argument index="0" name="scale" type="Vector3" />
 			<description>
-				Scales basis and origin of the transform by the given scale factor, using matrix multiplication.
+				Returns a copy of the transform with its basis and origin scaled by the given [code]scale[/code] factor, using matrix multiplication.
 			</description>
 		</method>
 		<method name="sphere_interpolate_with" qualifiers="const">
@@ -118,7 +118,7 @@
 			<return type="Transform3D" />
 			<argument index="0" name="offset" type="Vector3" />
 			<description>
-				Translates the transform by the given offset, relative to the transform's basis vectors.
+				Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
 				Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
 			</description>
 		</method>