Add documentation to operators for math types

Co-authored-by: Raul Santos <raulsntos@gmail.com>
This commit is contained in:
Aaron Franke
2021-11-04 10:58:20 -05:00
parent ee939c919b
commit 813466b3c8
31 changed files with 1367 additions and 91 deletions

View File

@ -218,12 +218,15 @@
<return type="bool" />
<argument index="0" name="right" type="AABB" />
<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.
</description>
</operator>
<operator name="operator *">
<return type="AABB" />
<argument index="0" name="right" type="Transform3D" />
<description>
Inversely transforms (multiplies) the [AABB] by the given [Transform3D] transformation matrix.
</description>
</operator>
<operator name="operator ==">
@ -235,6 +238,8 @@
<return type="bool" />
<argument index="0" name="right" type="AABB" />
<description>
Returns [code]true[/code] if the AABBs are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
</description>
</operator>
</operators>