summaryrefslogtreecommitdiff
path: root/doc/classes/EditorFileSystem.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-08-08 22:50:35 +0200
committerGitHub <noreply@github.com>2022-08-08 22:50:35 +0200
commit682dbe5d00aa7730659771b16704eba83f166a7b (patch)
tree8555e07c3bfb3b2892d530bc93fbf47d14519e35 /doc/classes/EditorFileSystem.xml
parentd9d5990c517b63f41881de05cb4644c36e0c77e0 (diff)
parentc5d7115038de5f83cb83e08748615a84fc26bee2 (diff)
Merge pull request #64008 from YuriSizov/doctool-add-param-reference-syntax
Diffstat (limited to 'doc/classes/EditorFileSystem.xml')
-rw-r--r--doc/classes/EditorFileSystem.xml14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml
index 402efba34a..5a14dd0672 100644
--- a/doc/classes/EditorFileSystem.xml
+++ b/doc/classes/EditorFileSystem.xml
@@ -12,7 +12,7 @@
<methods>
<method name="get_file_type" qualifiers="const">
<return type="String" />
- <argument index="0" name="path" type="String" />
+ <param index="0" name="path" type="String" />
<description>
Returns the resource type of the file, given the full path. 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>
@@ -25,7 +25,7 @@
</method>
<method name="get_filesystem_path">
<return type="EditorFileSystemDirectory" />
- <argument index="0" name="path" type="String" />
+ <param index="0" name="path" type="String" />
<description>
Returns a view into the filesystem at [code]path[/code].
</description>
@@ -44,7 +44,7 @@
</method>
<method name="reimport_files">
<return type="void" />
- <argument index="0" name="files" type="PackedStringArray" />
+ <param index="0" name="files" type="PackedStringArray" />
<description>
Reimports a set of files. Call this if these files or their [code].import[/code] files were directly edited by script or an external program.
If the file type changed or the file was newly created, use [method update_file] or [method scan].
@@ -65,7 +65,7 @@
</method>
<method name="update_file">
<return type="void" />
- <argument index="0" name="path" type="String" />
+ <param index="0" name="path" type="String" />
<description>
Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program.
This will not import the file. To reimport, call [method reimport_files] or [method scan] methods.
@@ -85,19 +85,19 @@
</description>
</signal>
<signal name="resources_reimported">
- <argument index="0" name="resources" type="PackedStringArray" />
+ <param index="0" name="resources" type="PackedStringArray" />
<description>
Emitted if a resource is reimported.
</description>
</signal>
<signal name="resources_reload">
- <argument index="0" name="resources" type="PackedStringArray" />
+ <param index="0" name="resources" type="PackedStringArray" />
<description>
Emitted if at least one resource is reloaded when the filesystem is scanned.
</description>
</signal>
<signal name="sources_changed">
- <argument index="0" name="exist" type="bool" />
+ <param index="0" name="exist" type="bool" />
<description>
Emitted if the source of any imported file changed.
</description>