seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions 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.
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

27
doc/classes/ScriptEditorBase.xml
View File

@ -10,17 +10,14 @@
</tutorials>
<methods>
<method name="_add_syntax_highlighter" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="highlighter" type="Object">
</argument>
<return type="void" />
<argument index="0" name="highlighter" type="Object" />
<description>
Adds a [EditorSyntaxHighlighter] to the open script.
</description>
</method>
<method name="get_base_editor" qualifiers="const">
<return type="Control">
</return>
<return type="Control" />
<description>
Returns the underlying [Control] used for editing scripts. This can be either [CodeEdit] (for text scripts) or [GraphEdit] (for visual scripts).
</description>
@ -33,8 +30,7 @@
</description>
</signal>
<signal name="go_to_help">
<argument index="0" name="what" type="String">
</argument>
<argument index="0" name="what" type="String" />
<description>
Emitted when the user requests a specific documentation page.
</description>
@ -45,24 +41,20 @@
</description>
</signal>
<signal name="replace_in_files_requested">
<argument index="0" name="text" type="String">
</argument>
<argument index="0" name="text" type="String" />
<description>
Emitted when the user request to find and replace text in the file system. Not used by visual scripts.
</description>
</signal>
<signal name="request_help">
<argument index="0" name="topic" type="String">
</argument>
<argument index="0" name="topic" type="String" />
<description>
Emitted when the user requests contextual help.
</description>
</signal>
<signal name="request_open_script_at_line">
<argument index="0" name="script" type="Object">
</argument>
<argument index="1" name="line" type="int">
</argument>
<argument index="0" name="script" type="Object" />
<argument index="1" name="line" type="int" />
<description>
Emitted when the user requests a script.
</description>
@ -73,8 +65,7 @@
</description>
</signal>
<signal name="search_in_files_requested">
<argument index="0" name="text" type="String">
</argument>
<argument index="0" name="text" type="String" />
<description>
Emitted when the user request to search text in the file system. Not used by visual scripts.
</description>