godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent c5589c76ce
commit 16fd1c421e
350 changed files with 10551 additions and 21102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
doc/classes/EditorFileSystem.xml
View File

@@ -11,70 +11,58 @@
</tutorials>
<methods>
<method name="get_file_type" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="path" type="String">
</argument>
<return type="String" />
<argument index="0" name="path" type="String" />
<description>
Gets the type of the file, given the full path.
</description>
</method>
<method name="get_filesystem">
<return type="EditorFileSystemDirectory">
</return>
<return type="EditorFileSystemDirectory" />
<description>
Gets the root directory object.
</description>
</method>
<method name="get_filesystem_path">
<return type="EditorFileSystemDirectory">
</return>
<argument index="0" name="path" type="String">
</argument>
<return type="EditorFileSystemDirectory" />
<argument index="0" name="path" type="String" />
<description>
Returns a view into the filesystem at [code]path[/code].
</description>
</method>
<method name="get_scanning_progress" qualifiers="const">
<return type="float">
</return>
<return type="float" />
<description>
Returns the scan progress for 0 to 1 if the FS is being scanned.
</description>
</method>
<method name="is_scanning" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] of the filesystem is being scanned.
</description>
</method>
<method name="scan">
<return type="void">
</return>
<return type="void" />
<description>
Scan the filesystem for changes.
</description>
</method>
<method name="scan_sources">
<return type="void">
</return>
<return type="void" />
<description>
Check if the source of any imported resource changed.
</description>
</method>
<method name="update_file">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<return type="void" />
<argument index="0" name="path" type="String" />
<description>
Update a file information. Call this if an external program (not Godot) modified the file.
</description>
</method>
<method name="update_script_classes">
<return type="void">
</return>
<return type="void" />
<description>
Scans the script files and updates the list of custom class names.
</description>
@@ -87,22 +75,19 @@
</description>
</signal>
<signal name="resources_reimported">
<argument index="0" name="resources" type="PoolStringArray">
</argument>
<argument index="0" name="resources" type="PoolStringArray" />
<description>
Emitted if a resource is reimported.
</description>
</signal>
<signal name="resources_reload">
<argument index="0" name="resources" type="PoolStringArray">
</argument>
<argument index="0" name="resources" type="PoolStringArray" />
<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">
</argument>
<argument index="0" name="exist" type="bool" />
<description>
Emitted if the source of any imported file changed.
</description>