Browse Source

Add docs for is_equal_approx on structures

Aaron Franke 5 years ago
parent
commit
3231fca934

+ 2 - 1
doc/classes/AABB.xml

@@ -182,6 +182,7 @@
 			<argument index="0" name="aabb" type="AABB">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 			</description>
 		</method>
 		<method name="merge">
@@ -190,7 +191,7 @@
 			<argument index="0" name="with" type="AABB">
 			</argument>
 			<description>
-				Returns a larger AABB that contains this AABB and [code]with[/code].
+				Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
 			</description>
 		</method>
 	</methods>

+ 1 - 0
doc/classes/Basis.xml

@@ -102,6 +102,7 @@
 			<argument index="1" name="epsilon" type="float" default="0.00001">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 			</description>
 		</method>
 		<method name="orthonormalized">

+ 1 - 0
doc/classes/Color.xml

@@ -157,6 +157,7 @@
 			<argument index="0" name="color" type="Color">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
 			</description>
 		</method>
 		<method name="lightened">

+ 1 - 0
doc/classes/Plane.xml

@@ -122,6 +122,7 @@
 			<argument index="0" name="plane" type="Plane">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
 			</description>
 		</method>
 		<method name="is_point_over">

+ 1 - 0
doc/classes/Quat.xml

@@ -100,6 +100,7 @@
 			<argument index="0" name="quat" type="Quat">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this quaterion and [code]quat[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
 			</description>
 		</method>
 		<method name="is_normalized">

+ 2 - 1
doc/classes/Rect2.xml

@@ -143,6 +143,7 @@
 			<argument index="0" name="rect" type="Rect2">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 			</description>
 		</method>
 		<method name="merge">
@@ -151,7 +152,7 @@
 			<argument index="0" name="b" type="Rect2">
 			</argument>
 			<description>
-				Returns a larger Rect2 that contains this Rect2 and [code]b[/code].
+				Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code].
 			</description>
 		</method>
 	</methods>

+ 1 - 0
doc/classes/Transform.xml

@@ -95,6 +95,7 @@
 			<argument index="0" name="transform" type="Transform">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 			</description>
 		</method>
 		<method name="looking_at">

+ 1 - 0
doc/classes/Transform2D.xml

@@ -112,6 +112,7 @@
 			<argument index="0" name="transform" type="Transform2D">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 			</description>
 		</method>
 		<method name="orthonormalized">

+ 1 - 0
doc/classes/Vector2.xml

@@ -159,6 +159,7 @@
 			<argument index="0" name="v" type="Vector2">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
 			</description>
 		</method>
 		<method name="is_normalized">

+ 1 - 0
doc/classes/Vector3.xml

@@ -135,6 +135,7 @@
 			<argument index="0" name="v" type="Vector3">
 			</argument>
 			<description>
+				Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
 			</description>
 		</method>
 		<method name="is_normalized">

+ 2 - 2
modules/gdscript/doc_classes/@GDScript.xml

@@ -502,7 +502,7 @@
 			<argument index="1" name="b" type="float">
 			</argument>
 			<description>
-				Returns True/False whether [code]a[/code] and [code]b[/code] are approximately equal to each other.
+				Returns [code]true[/code] if [code]a[/code] and [code]b[/code] are approximately equal to each other.
 			</description>
 		</method>
 		<method name="is_inf">
@@ -538,7 +538,7 @@
 			<argument index="0" name="s" type="float">
 			</argument>
 			<description>
-				Returns True/False whether [code]s[/code] is zero or almost zero.
+				Returns [code]true[/code] if [code]s[/code] is zero or almost zero.
 			</description>
 		</method>
 		<method name="len">