diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2022-08-15 16:17:52 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-15 16:17:52 +0300 |
| commit | dc661cc9ef26d32e51d0208e7a8c8fcefce3b134 (patch) | |
| tree | 229380347706539ffab1e30803741d4b33c3bcd0 /doc/classes/EditorFileSystemDirectory.xml | |
| parent | deec057ff89948ae2e4a45bada4c8a32553f3ca3 (diff) | |
| parent | ea2192b99ea0a56559687a3e1b1a9d9f32518132 (diff) | |
| download | redot-engine-dc661cc9ef26d32e51d0208e7a8c8fcefce3b134.tar.gz | |
Merge pull request #64328 from asmaloney/doc-params-6
[doc] Use "param" instead of "code" to refer to parameters (6)
Diffstat (limited to 'doc/classes/EditorFileSystemDirectory.xml')
| -rw-r--r-- | doc/classes/EditorFileSystemDirectory.xml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 3bc004e522..e9a0e3310c 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -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"> |
