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/EditorFileSystemDirectory.xml
+9 -9
View File
@@ -11,21 +11,21 @@
<methods>
<method name="find_dir_index" qualifiers="const">
<return type="int" />
<argument index="0" name="name" type="String" />
<param index="0" name="name" type="String" />
<description>
Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found.
</description>
</method>
<method name="find_file_index" qualifiers="const">
<return type="int" />
<argument index="0" name="name" type="String" />
<param index="0" name="name" type="String" />
<description>
Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found.
</description>
</method>
<method name="get_file" qualifiers="const">
<return type="String" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the name of the file at index [code]idx[/code].
</description>
@@ -38,35 +38,35 @@
</method>
<method name="get_file_import_is_valid" qualifiers="const">
<return type="bool" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
</description>
</method>
<method name="get_file_path" qualifiers="const">
<return type="String" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the path to the file at index [code]idx[/code].
</description>
</method>
<method name="get_file_script_class_extends" qualifiers="const">
<return type="String" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string.
</description>
</method>
<method name="get_file_script_class_name" qualifiers="const">
<return type="String" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string.
</description>
</method>
<method name="get_file_type" qualifiers="const">
<return type="StringName" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the resource type of the file at index [code]idx[/code]. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code].
</description>
@@ -91,7 +91,7 @@
</method>
<method name="get_subdir">
<return type="EditorFileSystemDirectory" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the subdirectory at index [code]idx[/code].
</description>