noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 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
doc/classes/ResourceFormatLoader.xml
+13 -13
View File
@@ -13,20 +13,20 @@
<methods>
<method name="_exists" qualifiers="virtual const">
<return type="bool" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
</description>
</method>
<method name="_get_classes_used" qualifiers="virtual const">
<return type="PackedStringArray" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
</description>
</method>
<method name="_get_dependencies" qualifiers="virtual const">
<return type="PackedStringArray" />
<argument index="0" name="path" type="String" />
<argument index="1" name="add_types" type="bool" />
<param index="0" name="path" type="String" />
<param index="1" name="add_types" type="bool" />
<description>
If implemented, gets the dependencies of a given resource. If [code]add_types[/code] is [code]true[/code], paths should be appended [code]::TypeName[/code], where [code]TypeName[/code] is the class name of the dependency.
[b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them.
@@ -40,7 +40,7 @@
</method>
<method name="_get_resource_type" qualifiers="virtual const">
<return type="String" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return [code]""[/code].
[b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them.
@@ -48,13 +48,13 @@
</method>
<method name="_get_resource_uid" qualifiers="virtual const">
<return type="int" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
</description>
</method>
<method name="_handles_type" qualifiers="virtual const">
<return type="bool" />
<argument index="0" name="type" type="StringName" />
<param index="0" name="type" type="StringName" />
<description>
Tells which resource class this loader can load.
[b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them.
@@ -62,10 +62,10 @@
</method>
<method name="_load" qualifiers="virtual const">
<return type="Variant" />
<argument index="0" name="path" type="String" />
<argument index="1" name="original_path" type="String" />
<argument index="2" name="use_sub_threads" type="bool" />
<argument index="3" name="cache_mode" type="int" />
<param index="0" name="path" type="String" />
<param index="1" name="original_path" type="String" />
<param index="2" name="use_sub_threads" type="bool" />
<param index="3" name="cache_mode" type="int" />
<description>
Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, [code]original_path[/code] will target the source file. Returns a [Resource] object on success, or an [enum Error] constant in case of failure.
The [code]cache_mode[/code] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details.
@@ -73,8 +73,8 @@
</method>
<method name="_rename_dependencies" qualifiers="virtual const">
<return type="int" />
<argument index="0" name="path" type="String" />
<argument index="1" name="renames" type="Dictionary" />
<param index="0" name="path" type="String" />
<param index="1" name="renames" type="Dictionary" />
<description>
If implemented, renames dependencies within the given resource and saves it. [code]renames[/code] is a dictionary [code]{ String =&gt; String }[/code] mapping old dependency paths to new paths.
Returns [constant OK] on success, or an [enum Error] constant in case of failure.