godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +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

24
doc/classes/EditorFileDialog.xml
View File

@@ -9,32 +9,27 @@
</tutorials>
<methods>
<method name="add_filter">
<return type="void">
</return>
<argument index="0" name="filter" type="String">
</argument>
<return type="void" />
<argument index="0" name="filter" type="String" />
<description>
Adds a comma-delimited file extension filter option to the [EditorFileDialog] with an optional semi-colon-delimited label.
For example, [code]"*.tscn, *.scn; Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)".
</description>
</method>
<method name="clear_filters">
<return type="void">
</return>
<return type="void" />
<description>
Removes all filters except for "All Files (*)".
</description>
</method>
<method name="get_vbox">
<return type="VBoxContainer">
</return>
<return type="VBoxContainer" />
<description>
Returns the [code]VBoxContainer[/code] used to display the file system.
</description>
</method>
<method name="invalidate">
<return type="void">
</return>
<return type="void" />
<description>
Notify the [EditorFileDialog] that its view of the data is no longer accurate. Updates the view contents on next view update.
</description>
@@ -71,22 +66,19 @@
</members>
<signals>
<signal name="dir_selected">
<argument index="0" name="dir" type="String">
</argument>
<argument index="0" name="dir" type="String" />
<description>
Emitted when a directory is selected.
</description>
</signal>
<signal name="file_selected">
<argument index="0" name="path" type="String">
</argument>
<argument index="0" name="path" type="String" />
<description>
Emitted when a file is selected.
</description>
</signal>
<signal name="files_selected">
<argument index="0" name="paths" type="PoolStringArray">
</argument>
<argument index="0" name="paths" type="PoolStringArray" />
<description>
Emitted when multiple files are selected.
</description>