godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues 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

24
doc/classes/EditorResourcePreview.xml
View File

@@ -12,24 +12,24 @@
<methods>
<method name="add_preview_generator">
<return type="void" />
<argument index="0" name="generator" type="EditorResourcePreviewGenerator" />
<param index="0" name="generator" type="EditorResourcePreviewGenerator" />
<description>
Create an own, custom preview generator.
</description>
</method>
<method name="check_for_invalidation">
<return type="void" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.
</description>
</method>
<method name="queue_edited_resource_preview">
<return type="void" />
<argument index="0" name="resource" type="Resource" />
<argument index="1" name="receiver" type="Object" />
<argument index="2" name="receiver_func" type="StringName" />
<argument index="3" name="userdata" type="Variant" />
<param index="0" name="resource" type="Resource" />
<param index="1" name="receiver" type="Object" />
<param index="2" name="receiver_func" type="StringName" />
<param index="3" name="userdata" type="Variant" />
<description>
Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
[b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
@@ -37,10 +37,10 @@
</method>
<method name="queue_resource_preview">
<return type="void" />
<argument index="0" name="path" type="String" />
<argument index="1" name="receiver" type="Object" />
<argument index="2" name="receiver_func" type="StringName" />
<argument index="3" name="userdata" type="Variant" />
<param index="0" name="path" type="String" />
<param index="1" name="receiver" type="Object" />
<param index="2" name="receiver_func" type="StringName" />
<param index="3" name="userdata" type="Variant" />
<description>
Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
[b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
@@ -48,7 +48,7 @@
</method>
<method name="remove_preview_generator">
<return type="void" />
<argument index="0" name="generator" type="EditorResourcePreviewGenerator" />
<param index="0" name="generator" type="EditorResourcePreviewGenerator" />
<description>
Removes a custom preview generator.
</description>
@@ -56,7 +56,7 @@
</methods>
<signals>
<signal name="preview_invalidated">
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview.
</description>