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 a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
doc/classes/ScriptEditor.xml
View File

@@ -10,69 +10,51 @@
</tutorials>
<methods>
<method name="can_drop_data_fw" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="data" type="Variant">
</argument>
<argument index="2" name="from" type="Control">
</argument>
<return type="bool" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
<description>
</description>
</method>
<method name="drop_data_fw">
<return type="void">
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="data" type="Variant">
</argument>
<argument index="2" name="from" type="Control">
</argument>
<return type="void" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
<description>
</description>
</method>
<method name="get_current_script">
<return type="Script">
</return>
<return type="Script" />
<description>
Returns a [Script] that is currently active in editor.
</description>
</method>
<method name="get_drag_data_fw">
<return type="Variant">
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="from" type="Control">
</argument>
<return type="Variant" />
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="from" type="Control" />
<description>
</description>
</method>
<method name="get_open_scripts" qualifiers="const">
<return type="Array">
</return>
<return type="Array" />
<description>
Returns an array with all [Script] objects which are currently open in editor.
</description>
</method>
<method name="goto_line">
<return type="void">
</return>
<argument index="0" name="line_number" type="int">
</argument>
<return type="void" />
<argument index="0" name="line_number" type="int" />
<description>
Goes to the specified line in the current script.
</description>
</method>
<method name="open_script_create_dialog">
<return type="void">
</return>
<argument index="0" name="base_name" type="String">
</argument>
<argument index="1" name="base_path" type="String">
</argument>
<return type="void" />
<argument index="0" name="base_name" type="String" />
<argument index="1" name="base_path" type="String" />
<description>
Opens the script create dialog. The script will extend [code]base_name[/code]. The file extension can be omitted from [code]base_path[/code]. It will be added based on the selected scripting language.
</description>
@@ -80,15 +62,13 @@
</methods>
<signals>
<signal name="editor_script_changed">
<argument index="0" name="script" type="Script">
</argument>
<argument index="0" name="script" type="Script" />
<description>
Emitted when user changed active script. Argument is a freshly activated [Script].
</description>
</signal>
<signal name="script_close">
<argument index="0" name="script" type="Script">
</argument>
<argument index="0" name="script" type="Script" />
<description>
Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed.
</description>