diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-02-01 19:59:06 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-01 19:59:06 +0100 |
| commit | dc4483a3a74a4cac83fc0387ea4d09066a0a0e1c (patch) | |
| tree | 90035d8d1db27768ef1c7d02bd4ceb3eca6c856f /doc | |
| parent | ea12094f19b028c1dcf6d402b8cbb3296b2065a8 (diff) | |
| parent | 10e7977be38945da229754301767de039868dec4 (diff) | |
Merge pull request #57519 from Calinou/doc-rect2-has-no-area
Clarify documentation for Rect2/Rect2i's `has_no_area()`
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Rect2.xml | 5 | ||||
| -rw-r--r-- | doc/classes/Rect2i.xml | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 65d1654c21..6285b1d155 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -93,7 +93,7 @@ <method name="get_area" qualifiers="const"> <return type="float" /> <description> - Returns the area of the [Rect2]. + Returns the area of the [Rect2]. See also [method has_no_area]. </description> </method> <method name="get_center" qualifiers="const"> @@ -130,7 +130,8 @@ <method name="has_no_area" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the [Rect2] is flat or empty. + Returns [code]true[/code] if the [Rect2] is flat or empty, [code]false[/code] otherwise. See also [method get_area]. + [b]Note:[/b] If the [Rect2] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code]. </description> </method> <method name="has_point" qualifiers="const"> diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index e070824297..a542bad82b 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -90,7 +90,7 @@ <method name="get_area" qualifiers="const"> <return type="int" /> <description> - Returns the area of the [Rect2i]. + Returns the area of the [Rect2i]. See also [method has_no_area]. </description> </method> <method name="get_center" qualifiers="const"> @@ -128,7 +128,8 @@ <method name="has_no_area" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the [Rect2i] is flat or empty. + Returns [code]true[/code] if the [Rect2i] is flat or empty, [code]false[/code] otherwise. See also [method get_area]. + [b]Note:[/b] If the [Rect2i] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code]. </description> </method> <method name="has_point" qualifiers="const"> |