doc: Use self-closing tags for return and argument
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
@ -8,186 +8,136 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="can_move_tile_in_atlas" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)">
|
||||
</argument>
|
||||
<argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
|
||||
<argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_tiles_outside_texture">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_alternative_tile">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="alternative_id_override" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="alternative_id_override" type="int" default="-1" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_tile">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="size" type="Vector2i" default="Vector2i(1, 1)">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="size" type="Vector2i" default="Vector2i(1, 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_atlas_grid_size" qualifiers="const">
|
||||
<return type="Vector2i">
|
||||
</return>
|
||||
<return type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_next_alternative_tile_id" 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_tile_at_coords" qualifiers="const">
|
||||
<return type="Vector2i">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<return type="Vector2i" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_tile_data" qualifiers="const">
|
||||
<return type="Object">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="index" type="int">
|
||||
</argument>
|
||||
<return type="Object" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="index" 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_tile_size_in_atlas" qualifiers="const">
|
||||
<return type="Vector2i">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<return type="Vector2i" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_tile_texture_region" qualifiers="const">
|
||||
<return type="Rect2i">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<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_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="has_tiles_outside_texture">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="move_tile_in_atlas">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)">
|
||||
</argument>
|
||||
<argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
|
||||
<argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_alternative_tile">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="alternative_tile" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="alternative_tile" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_tile">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_alternative_tile_id">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="atlas_coords" type="Vector2i">
|
||||
</argument>
|
||||
<argument index="1" name="alternative_tile" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="new_id" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="atlas_coords" type="Vector2i" />
|
||||
<argument index="1" name="alternative_tile" type="int" />
|
||||
<argument index="2" name="new_id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
Reference in New Issue
Block a user