Merge pull request #57519 from Calinou/doc-rect2-has-no-area

Clarify documentation for Rect2/Rect2i's `has_no_area()`
This commit is contained in:
Rémi Verschelde 2022-02-01 19:59:06 +01:00 committed by GitHub
commit dc4483a3a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions

View file

@ -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">

View file

@ -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">