godotengine/godot-visual-script
1
0
Fork 0
mirror of https://github.com/godotengine/godot-visual-script.git synced 2026-01-07 02:10:47 +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 6846557be1)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent f8471f68b0
commit 02ee17f9a2
8 changed files with 221 additions and 442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc_classes/VisualScriptFunctionState.xml
View File

@@ -10,30 +10,23 @@
</tutorials>
<methods>
<method name="connect_to_signal">
<return type="void">
</return>
<argument index="0" name="obj" type="Object">
</argument>
<argument index="1" name="signals" type="String">
</argument>
<argument index="2" name="args" type="Array">
</argument>
<return type="void" />
<argument index="0" name="obj" type="Object" />
<argument index="1" name="signals" type="String" />
<argument index="2" name="args" type="Array" />
<description>
Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns whether the function state is valid.
</description>
</method>
<method name="resume">
<return type="Variant">
</return>
<argument index="0" name="args" type="Array" default="null">
</argument>
<return type="Variant" />
<argument index="0" name="args" type="Array" default="null" />
<description>
Resumes the function to run from the point it was yielded.
</description>