noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

[doc] Use "param" instead of "code" to refer to parameters

Browse Source
This commit is contained in:
Andy Maloney
2022-08-09 11:19:47 -04:00
committed by Yuri Sizov
parent e9e9e92e48
commit 2d54c36c3c
27 changed files with 373 additions and 373 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/classes/Transform2D.xml
View File

@@ -107,7 +107,7 @@
<param index="0" name="xform" type="Transform2D" />
<param index="1" name="weight" type="float" />
<description>
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
Returns a transform interpolated between this transform and another by a given [param weight] (on the range of 0.0 to 1.0).
</description>
</method>
<method name="inverse" qualifiers="const">
@@ -127,7 +127,7 @@
<return type="Transform2D" />
<param index="0" name="target" type="Vector2" default="Vector2(0, 0)" />
<description>
Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [code]target[/code] position.
Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [param target] position.
Operations take place in global space.
</description>
</method>
@@ -141,7 +141,7 @@
<return type="Transform2D" />
<param index="0" name="angle" type="float" />
<description>
Returns a copy of the transform rotated by the given [code]angle[/code] (in radians).
Returns a copy of the transform rotated by the given [param angle] (in radians).
This method is an optimized version of multiplying the given transform [code]X[/code]
with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code].
This can be seen as transforming with respect to the global/parent frame.
@@ -151,7 +151,7 @@
<return type="Transform2D" />
<param index="0" name="angle" type="float" />
<description>
Returns a copy of the transform rotated by the given [code]angle[/code] (in radians).
Returns a copy of the transform rotated by the given [param angle] (in radians).
This method is an optimized version of multiplying the given transform [code]X[/code]
with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code].
This can be seen as transforming with respect to the local frame.
@@ -161,7 +161,7 @@
<return type="Transform2D" />
<param index="0" name="scale" type="Vector2" />
<description>
Returns a copy of the transform scaled by the given [code]scale[/code] factor.
Returns a copy of the transform scaled by the given [param scale] factor.
This method is an optimized version of multiplying the given transform [code]X[/code]
with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code].
This can be seen as transforming with respect to the global/parent frame.
@@ -171,7 +171,7 @@
<return type="Transform2D" />
<param index="0" name="scale" type="Vector2" />
<description>
Returns a copy of the transform scaled by the given [code]scale[/code] factor.
Returns a copy of the transform scaled by the given [param scale] factor.
This method is an optimized version of multiplying the given transform [code]X[/code]
with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code].
This can be seen as transforming with respect to the local frame.
@@ -203,7 +203,7 @@
<return type="Transform2D" />
<param index="0" name="offset" type="Vector2" />
<description>
Returns a copy of the transform translated by the given [code]offset[/code].
Returns a copy of the transform translated by the given [param offset].
This method is an optimized version of multiplying the given transform [code]X[/code]
with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code].
This can be seen as transforming with respect to the global/parent frame.
@@ -213,7 +213,7 @@
<return type="Transform2D" />
<param index="0" name="offset" type="Vector2" />
<description>
Returns a copy of the transform translated by the given [code]offset[/code].
Returns a copy of the transform translated by the given [param offset].
This method is an optimized version of multiplying the given transform [code]X[/code]
with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code].
This can be seen as transforming with respect to the local frame.