seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
doc/classes/PolygonPathFinder.xml
View File

@ -8,72 +8,53 @@
</tutorials>
<methods>
<method name="find_path">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
<argument index="1" name="to" type="Vector2">
</argument>
<return type="PackedVector2Array" />
<argument index="0" name="from" type="Vector2" />
<argument index="1" name="to" type="Vector2" />
<description>
</description>
</method>
<method name="get_bounds" qualifiers="const">
<return type="Rect2">
</return>
<return type="Rect2" />
<description>
</description>
</method>
<method name="get_closest_point" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<return type="Vector2" />
<argument index="0" name="point" type="Vector2" />
<description>
</description>
</method>
<method name="get_intersections" qualifiers="const">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
<argument index="1" name="to" type="Vector2">
</argument>
<return type="PackedVector2Array" />
<argument index="0" name="from" type="Vector2" />
<argument index="1" name="to" type="Vector2" />
<description>
</description>
</method>
<method name="get_point_penalty" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="idx" type="int">
</argument>
<return type="float" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="is_point_inside" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<return type="bool" />
<argument index="0" name="point" type="Vector2" />
<description>
</description>
</method>
<method name="set_point_penalty">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="penalty" type="float">
</argument>
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="penalty" type="float" />
<description>
</description>
</method>
<method name="setup">
<return type="void">
</return>
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="connections" type="PackedInt32Array">
</argument>
<return type="void" />
<argument index="0" name="points" type="PackedVector2Array" />
<argument index="1" name="connections" type="PackedInt32Array" />
<description>
</description>
</method>