From 3231fca934c200b67ff823f82368a79b278bec5e Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Sat, 30 Nov 2019 15:08:50 -0500 Subject: [PATCH] Add docs for is_equal_approx on structures --- doc/classes/AABB.xml | 3 ++- doc/classes/Basis.xml | 1 + doc/classes/Color.xml | 1 + doc/classes/Plane.xml | 1 + doc/classes/Quat.xml | 1 + doc/classes/Rect2.xml | 3 ++- doc/classes/Transform.xml | 1 + doc/classes/Transform2D.xml | 1 + doc/classes/Vector2.xml | 1 + doc/classes/Vector3.xml | 1 + modules/gdscript/doc_classes/@GDScript.xml | 4 ++-- 11 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 61e1ea9b8d6..44f1d9a9210 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -182,6 +182,7 @@ + Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. @@ -190,7 +191,7 @@ - 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]. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index df9438e695e..5a7fc0a41b6 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -102,6 +102,7 @@ + Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index deba30712ef..1d4225542ad 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -157,6 +157,7 @@ + Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index bb72f2734e7..f179041327f 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -122,6 +122,7 @@ + Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index f5ee99d30c8..eeb633f480c 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -100,6 +100,7 @@ + Returns [code]true[/code] if this quaterion and [code]quat[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 07fa7777fec..90dd9966913 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -143,6 +143,7 @@ + Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. @@ -151,7 +152,7 @@ - Returns a larger Rect2 that contains this Rect2 and [code]b[/code]. + Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 034a1b2f5b2..4c4022b3b51 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -95,6 +95,7 @@ + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 89ccffc2e9c..6288bb074cb 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -112,6 +112,7 @@ + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 8ae5caf68cb..b23c69de600 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -159,6 +159,7 @@ + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 29c24709e2b..d838e6d2f7a 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -135,6 +135,7 @@ + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index a22d18b970b..949663c5eae 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -502,7 +502,7 @@ - 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. @@ -538,7 +538,7 @@ - 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.