summaryrefslogtreecommitdiff
path: root/doc/classes/Vector4.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2022-08-06 21:11:48 +0300
committerYuri Sizov <yuris@humnom.net>2022-08-08 22:34:31 +0300
commitc5d7115038de5f83cb83e08748615a84fc26bee2 (patch)
tree13b9b42aac25f7769428ef91f637e260b768f25d /doc/classes/Vector4.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/Vector4.xml')
-rw-r--r--doc/classes/Vector4.xml74
1 files changed, 37 insertions, 37 deletions
diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml
index ee9d97019e..b5658f074a 100644
--- a/doc/classes/Vector4.xml
+++ b/doc/classes/Vector4.xml
@@ -19,24 +19,24 @@
</constructor>
<constructor name="Vector4">
<return type="Vector4" />
- <argument index="0" name="from" type="Vector4" />
+ <param index="0" name="from" type="Vector4" />
<description>
Constructs a [Vector4] as a copy of the given [Vector4].
</description>
</constructor>
<constructor name="Vector4">
<return type="Vector4" />
- <argument index="0" name="from" type="Vector4i" />
+ <param index="0" name="from" type="Vector4i" />
<description>
Constructs a new [Vector4] from [Vector4i].
</description>
</constructor>
<constructor name="Vector4">
<return type="Vector4" />
- <argument index="0" name="x" type="float" />
- <argument index="1" name="y" type="float" />
- <argument index="2" name="z" type="float" />
- <argument index="3" name="w" type="float" />
+ <param index="0" name="x" type="float" />
+ <param index="1" name="y" type="float" />
+ <param index="2" name="z" type="float" />
+ <param index="3" name="w" type="float" />
<description>
Returns a [Vector4] with the given components.
</description>
@@ -57,39 +57,39 @@
</method>
<method name="clamp" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="min" type="Vector4" />
- <argument index="1" name="max" type="Vector4" />
+ <param index="0" name="min" type="Vector4" />
+ <param index="1" name="max" type="Vector4" />
<description>
Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
</description>
</method>
<method name="cubic_interpolate" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="b" type="Vector4" />
- <argument index="1" name="pre_a" type="Vector4" />
- <argument index="2" name="post_b" type="Vector4" />
- <argument index="3" name="weight" type="float" />
+ <param index="0" name="b" type="Vector4" />
+ <param index="1" name="pre_a" type="Vector4" />
+ <param index="2" name="post_b" type="Vector4" />
+ <param index="3" name="weight" type="float" />
<description>
Performs a cubic interpolation between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation.
</description>
</method>
<method name="direction_to" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="to" type="Vector4" />
+ <param index="0" name="to" type="Vector4" />
<description>
Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code].
</description>
</method>
<method name="distance_to" qualifiers="const">
<return type="float" />
- <argument index="0" name="to" type="Vector4" />
+ <param index="0" name="to" type="Vector4" />
<description>
Returns the distance between this vector and [code]to[/code].
</description>
</method>
<method name="dot" qualifiers="const">
<return type="float" />
- <argument index="0" name="with" type="Vector4" />
+ <param index="0" name="with" type="Vector4" />
<description>
Returns the dot product of this vector and [code]with[/code].
</description>
@@ -108,7 +108,7 @@
</method>
<method name="is_equal_approx" qualifiers="const">
<return type="bool" />
- <argument index="0" name="with" type="Vector4" />
+ <param index="0" name="with" type="Vector4" />
<description>
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
@@ -133,8 +133,8 @@
</method>
<method name="lerp" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="to" type="Vector4" />
- <argument index="1" name="weight" type="float" />
+ <param index="0" name="to" type="Vector4" />
+ <param index="1" name="weight" type="float" />
<description>
Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation.
</description>
@@ -159,14 +159,14 @@
</method>
<method name="posmod" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="mod" type="float" />
+ <param index="0" name="mod" type="float" />
<description>
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code].
</description>
</method>
<method name="posmodv" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="modv" type="Vector4" />
+ <param index="0" name="modv" type="Vector4" />
<description>
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components.
</description>
@@ -185,7 +185,7 @@
</method>
<method name="snapped" qualifiers="const">
<return type="Vector4" />
- <argument index="0" name="step" type="Vector4" />
+ <param index="0" name="step" type="Vector4" />
<description>
Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals.
</description>
@@ -231,7 +231,7 @@
<operators>
<operator name="operator !=">
<return type="bool" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Returns [code]true[/code] if the vectors are not equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
@@ -239,14 +239,14 @@
</operator>
<operator name="operator *">
<return type="Vector4" />
- <argument index="0" name="right" type="Projection" />
+ <param index="0" name="right" type="Projection" />
<description>
Inversely transforms (multiplies) the [Vector4] by the given [Projection] matrix.
</description>
</operator>
<operator name="operator *">
<return type="Vector4" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Multiplies each component of the [Vector4] by the components of the given [Vector4].
[codeblock]
@@ -256,7 +256,7 @@
</operator>
<operator name="operator *">
<return type="Vector4" />
- <argument index="0" name="right" type="float" />
+ <param index="0" name="right" type="float" />
<description>
Multiplies each component of the [Vector4] by the given [float].
[codeblock]
@@ -266,14 +266,14 @@
</operator>
<operator name="operator *">
<return type="Vector4" />
- <argument index="0" name="right" type="int" />
+ <param index="0" name="right" type="int" />
<description>
Multiplies each component of the [Vector4] by the given [int].
</description>
</operator>
<operator name="operator +">
<return type="Vector4" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Adds each component of the [Vector4] by the components of the given [Vector4].
[codeblock]
@@ -283,7 +283,7 @@
</operator>
<operator name="operator -">
<return type="Vector4" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Subtracts each component of the [Vector4] by the components of the given [Vector4].
[codeblock]
@@ -293,7 +293,7 @@
</operator>
<operator name="operator /">
<return type="Vector4" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Divides each component of the [Vector4] by the components of the given [Vector4].
[codeblock]
@@ -303,7 +303,7 @@
</operator>
<operator name="operator /">
<return type="Vector4" />
- <argument index="0" name="right" type="float" />
+ <param index="0" name="right" type="float" />
<description>
Divides each component of the [Vector4] by the given [float].
[codeblock]
@@ -313,28 +313,28 @@
</operator>
<operator name="operator /">
<return type="Vector4" />
- <argument index="0" name="right" type="int" />
+ <param index="0" name="right" type="int" />
<description>
Divides each component of the [Vector4] by the given [int].
</description>
</operator>
<operator name="operator &lt;">
<return type="bool" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Compares two [Vector4] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
</description>
</operator>
<operator name="operator &lt;=">
<return type="bool" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Compares two [Vector4] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Returns [code]true[/code] if the vectors are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
@@ -342,21 +342,21 @@
</operator>
<operator name="operator &gt;">
<return type="bool" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Compares two [Vector4] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
</description>
</operator>
<operator name="operator &gt;=">
<return type="bool" />
- <argument index="0" name="right" type="Vector4" />
+ <param index="0" name="right" type="Vector4" />
<description>
Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code].
</description>
</operator>
<operator name="operator []">
<return type="float" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], [code]v[2][/code] is equivalent to [code]v.z[/code], and [code]v[3][/code] is equivalent to [code]v.w[/code].
</description>