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

[doc] Use "param" instead of "code" to refer to parameters (6)

Browse Source
This commit is contained in:
Andy Maloney
2022-08-12 12:07:53 -04:00
parent 22bb15cde5
commit ea2192b99e
47 changed files with 303 additions and 303 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/classes/EditorFileSystemDirectory.xml
View File

@ -13,21 +13,21 @@
<return type="int" />
<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.
Returns the index of the directory with name [param name] or [code]-1[/code] if not found.
</description>
</method>
<method name="find_file_index" qualifiers="const">
<return type="int" />
<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.
Returns the index of the file with name [param name] or [code]-1[/code] if not found.
</description>
</method>
<method name="get_file" qualifiers="const">
<return type="String" />
<param index="0" name="idx" type="int" />
<description>
Returns the name of the file at index [code]idx[/code].
Returns the name of the file at index [param idx].
</description>
</method>
<method name="get_file_count" qualifiers="const">
@ -40,35 +40,35 @@
<return type="bool" />
<param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
Returns [code]true[/code] if the file at index [param idx] imported properly.
</description>
</method>
<method name="get_file_path" qualifiers="const">
<return type="String" />
<param index="0" name="idx" type="int" />
<description>
Returns the path to the file at index [code]idx[/code].
Returns the path to the file at index [param idx].
</description>
</method>
<method name="get_file_script_class_extends" qualifiers="const">
<return type="String" />
<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.
Returns the base class of the script class defined in the file at index [param idx]. 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" />
<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.
Returns the name of the script class defined in the file at index [param idx]. 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" />
<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].
Returns the resource type of the file at index [param idx]. 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>
</method>
<method name="get_name">
@ -93,7 +93,7 @@
<return type="EditorFileSystemDirectory" />
<param index="0" name="idx" type="int" />
<description>
Returns the subdirectory at index [code]idx[/code].
Returns the subdirectory at index [param idx].
</description>
</method>
<method name="get_subdir_count" qualifiers="const">