noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 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.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/ScriptEditor.xml
+15 -30
View File
@@ -10,68 +10,55 @@
</tutorials>
<methods>
<method name="get_current_editor" qualifiers="const">
<return type="ScriptEditorBase">
</return>
<return type="ScriptEditorBase" />
<description>
Returns the [ScriptEditorBase] object that the user is currently editing.
</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_open_script_editors" qualifiers="const">
<return type="Array">
</return>
<return type="Array" />
<description>
Returns an array with all [ScriptEditorBase] objects which are currently open in editor.
</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>
</method>
<method name="register_syntax_highlighter">
<return type="void">
</return>
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<return type="void" />
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />
<description>
Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts.
[b]Note:[/b] Does not apply to scripts that are already opened.
</description>
</method>
<method name="unregister_syntax_highlighter">
<return type="void">
</return>
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter">
</argument>
<return type="void" />
<argument index="0" name="syntax_highlighter" type="EditorSyntaxHighlighter" />
<description>
Unregisters the [EditorSyntaxHighlighter] from the editor.
[b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
@@ -80,15 +67,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>