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

15
doc/classes/EditorScript.xml
View File

@ -35,32 +35,27 @@
</tutorials>
<methods>
<method name="_run" qualifiers="virtual">
<return type="void">
</return>
<return type="void" />
<description>
This method is executed by the Editor when [b]File &gt; Run[/b] is used.
</description>
</method>
<method name="add_root_node">
<return type="void">
</return>
<argument index="0" name="node" type="Node">
</argument>
<return type="void" />
<argument index="0" name="node" type="Node" />
<description>
Adds [code]node[/code] as a child of the root node in the editor context.
[b]Warning:[/b] The implementation of this method is currently disabled.
</description>
</method>
<method name="get_editor_interface">
<return type="EditorInterface">
</return>
<return type="EditorInterface" />
<description>
Returns the [EditorInterface] singleton instance.
</description>
</method>
<method name="get_scene">
<return type="Node">
</return>
<return type="Node" />
<description>
Returns the Editor's currently active scene.
</description>