Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

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
No known key found for this signature in database
GPG key ID: C3336907360768E1
408 changed files with 14025 additions and 28050 deletions
Download patch file Download diff file Expand all files Collapse all files

21
doc/classes/ImageTexture.xml
View file

@ -32,35 +32,28 @@
</tutorials>
<methods>
<method name="create_from_image">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<return type="void" />
<argument index="0" name="image" type="Image" />
<description>
Initializes the texture by allocating and setting the data from an [Image].
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="Image.Format">
</return>
<return type="int" enum="Image.Format" />
<description>
Returns the format of the texture, one of [enum Image.Format].
</description>
</method>
<method name="set_size_override">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<return type="void" />
<argument index="0" name="size" type="Vector2" />
<description>
Resizes the texture to the specified dimensions.
</description>
</method>
<method name="update">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<return type="void" />
<argument index="0" name="image" type="Image" />
<description>
Replaces the texture's data with a new [Image].
[b]Note:[/b] The texture has to be initialized first with the [method create_from_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration, otherwise it has to be re-created with the [method create_from_image] method.