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

111
doc/classes/TileSetScenesCollectionSource.xml
View File

@ -8,144 +8,107 @@
</tutorials>
<methods>
<method name="create_scene_tile">
<return type="int">
</return>
<argument index="0" name="packed_scene" type="PackedScene">
</argument>
<argument index="1" name="id_override" type="int" default="-1">
</argument>
<return type="int" />
<argument index="0" name="packed_scene" type="PackedScene" />
<argument index="1" name="id_override" type="int" default="-1" />
<description>
</description>
</method>
<method name="get_alternative_tile_id" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="atlas_coords" type="Vector2i">
</argument>
<argument index="1" name="index" type="int">
</argument>
<return type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="index" type="int" />
<description>
</description>
</method>
<method name="get_alternative_tiles_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="atlas_coords" type="Vector2i">
</argument>
<return type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
</description>
</method>
<method name="get_next_scene_tile_id" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
</description>
</method>
<method name="get_scene_tile_display_placeholder" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="bool" />
<argument index="0" name="id" type="int" />
<description>
</description>
</method>
<method name="get_scene_tile_id">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<return type="int" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_scene_tile_scene" qualifiers="const">
<return type="PackedScene">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="PackedScene" />
<argument index="0" name="id" type="int" />
<description>
</description>
</method>
<method name="get_scene_tiles_count">
<return type="int">
</return>
<return type="int" />
<description>
</description>
</method>
<method name="get_tile_id" qualifiers="const">
<return type="Vector2i">
</return>
<argument index="0" name="index" type="int">
</argument>
<return type="Vector2i" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_tiles_count" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
</description>
</method>
<method name="has_alternative_tile" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="atlas_coords" type="Vector2i">
</argument>
<argument index="1" name="alternative_tile" type="int">
</argument>
<return type="bool" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<description>
</description>
</method>
<method name="has_scene_tile_id">
<return type="bool">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="bool" />
<argument index="0" name="id" type="int" />
<description>
</description>
</method>
<method name="has_tile" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="atlas_coords" type="Vector2i">
</argument>
<return type="bool" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
</description>
</method>
<method name="remove_scene_tile">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="void" />
<argument index="0" name="id" type="int" />
<description>
</description>
</method>
<method name="set_scene_tile_display_placeholder">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="display_placeholder" type="bool">
</argument>
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="display_placeholder" type="bool" />
<description>
</description>
</method>
<method name="set_scene_tile_id">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="new_id" type="int">
</argument>
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="new_id" type="int" />
<description>
</description>
</method>
<method name="set_scene_tile_scene">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="packed_scene" type="PackedScene">
</argument>
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="packed_scene" type="PackedScene" />
<description>
</description>
</method>