diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2021-07-30 15:28:05 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2021-07-30 15:29:52 +0200 |
commit | 7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch) | |
tree | 0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/MeshLibrary.xml | |
parent | a1c19b9a1e53f78c75c13cb418270db80057b21a (diff) |
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.
Diffstat (limited to 'doc/classes/MeshLibrary.xml')
-rw-r--r-- | doc/classes/MeshLibrary.xml | 117 |
1 files changed, 39 insertions, 78 deletions
diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index b33bcc89e3..9e0292f946 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -12,172 +12,133 @@ </tutorials> <methods> <method name="clear"> - <return type="void"> - </return> + <return type="void" /> <description> Clears the library. </description> </method> <method name="create_item"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> <description> Creates a new item in the library with the given ID. You can get an unused ID from [method get_last_unused_item_id]. </description> </method> <method name="find_item_by_name" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> + <return type="int" /> + <argument index="0" name="name" type="String" /> <description> Returns the first item with the given name. </description> </method> <method name="get_item_list" qualifiers="const"> - <return type="PackedInt32Array"> - </return> + <return type="PackedInt32Array" /> <description> Returns the list of item IDs in use. </description> </method> <method name="get_item_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="Mesh" /> + <argument index="0" name="id" type="int" /> <description> Returns the item's mesh. </description> </method> <method name="get_item_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="String" /> + <argument index="0" name="id" type="int" /> <description> Returns the item's name. </description> </method> <method name="get_item_navmesh" qualifiers="const"> - <return type="NavigationMesh"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="NavigationMesh" /> + <argument index="0" name="id" type="int" /> <description> Returns the item's navigation mesh. </description> </method> <method name="get_item_navmesh_transform" qualifiers="const"> - <return type="Transform3D"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="Transform3D" /> + <argument index="0" name="id" type="int" /> <description> Returns the transform applied to the item's navigation mesh. </description> </method> <method name="get_item_preview" qualifiers="const"> - <return type="Texture2D"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="Texture2D" /> + <argument index="0" name="id" type="int" /> <description> When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture2D] if no preview was manually set in a running project. </description> </method> <method name="get_item_shapes" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="Array" /> + <argument index="0" name="id" type="int" /> <description> Returns an item's collision shapes. The array consists of each [Shape3D] followed by its [Transform3D]. </description> </method> <method name="get_last_unused_item_id" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Gets an unused ID for a new item. </description> </method> <method name="remove_item"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> <description> Removes the item. </description> </method> <method name="set_item_mesh"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="mesh" type="Mesh"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> + <argument index="1" name="mesh" type="Mesh" /> <description> Sets the item's mesh. </description> </method> <method name="set_item_name"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> + <argument index="1" name="name" type="String" /> <description> Sets the item's name. This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name]. </description> </method> <method name="set_item_navmesh"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="navmesh" type="NavigationMesh"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> + <argument index="1" name="navmesh" type="NavigationMesh" /> <description> Sets the item's navigation mesh. </description> </method> <method name="set_item_navmesh_transform"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="navmesh" type="Transform3D"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> + <argument index="1" name="navmesh" type="Transform3D" /> <description> Sets the transform to apply to the item's navigation mesh. </description> </method> <method name="set_item_preview"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="texture" type="Texture2D"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> + <argument index="1" name="texture" type="Texture2D" /> <description> Sets a texture to use as the item's preview icon in the editor. </description> </method> <method name="set_item_shapes"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="shapes" type="Array"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> + <argument index="1" name="shapes" type="Array" /> <description> Sets an item's collision shapes. The array should consist of [Shape3D] objects, each followed by a [Transform3D] that will be applied to it. For shapes that should not have a transform, use [constant Transform3D.IDENTITY]. |