seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/classes/EditorResourcePreviewGenerator.xml
View File

@ -18,8 +18,8 @@
</method>
<method name="_generate" qualifiers="virtual const">
<return type="Texture2D" />
<argument index="0" name="resource" type="Resource" />
<argument index="1" name="size" type="Vector2i" />
<param index="0" name="resource" type="Resource" />
<param index="1" name="size" type="Vector2i" />
<description>
Generate a preview from a given resource with the specified size. This must always be implemented.
Returning an empty texture is an OK way to fail and let another generator take care.
@ -28,8 +28,8 @@
</method>
<method name="_generate_from_path" qualifiers="virtual const">
<return type="Texture2D" />
<argument index="0" name="path" type="String" />
<argument index="1" name="size" type="Vector2i" />
<param index="0" name="path" type="String" />
<param index="1" name="size" type="Vector2i" />
<description>
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate].
Returning an empty texture is an OK way to fail and let another generator take care.
@ -45,7 +45,7 @@
</method>
<method name="_handles" qualifiers="virtual const">
<return type="bool" />
<argument index="0" name="type" type="String" />
<param index="0" name="type" type="String" />
<description>
Returns [code]true[/code] if your generator supports the resource of type [code]type[/code].
</description>