Rename the argument tag to param in XML documentation

This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions

View File

@@ -31,7 +31,7 @@
<methods>
<method name="create_from_image" qualifiers="static">
<return type="ImageTexture" />
<argument index="0" name="image" type="Image" />
<param index="0" name="image" type="Image" />
<description>
Creates a new [ImageTexture] and initializes it by allocating and setting the data from an [Image].
</description>
@@ -44,7 +44,7 @@
</method>
<method name="set_image">
<return type="void" />
<argument index="0" name="image" type="Image" />
<param index="0" name="image" type="Image" />
<description>
Replaces the texture's data with a new [Image]. This will re-allocate new memory for the texture.
If you want to update the image, but don't need to change its parameters (format, size), use [method update] instead for better performance.
@@ -52,14 +52,14 @@
</method>
<method name="set_size_override">
<return type="void" />
<argument index="0" name="size" type="Vector2i" />
<param index="0" name="size" type="Vector2i" />
<description>
Resizes the texture to the specified dimensions.
</description>
</method>
<method name="update">
<return type="void" />
<argument index="0" name="image" type="Image" />
<param index="0" name="image" type="Image" />
<description>
Replaces the texture's data with a new [Image].
[b]Note:[/b] The texture has to be created using [method create_from_image] or initialized first with the [method set_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration.