1
0
mirror of https://github.com/godotengine/godot.git synced 2025-11-15 13:51:40 +00:00

doc: Use self-closing tags for return and argument

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

View File

@@ -10,89 +10,65 @@
</tutorials>
<methods>
<method name="add_input_data_port">
<return type="void">
</return>
<argument index="0" name="type" type="int" enum="Variant.Type">
</argument>
<argument index="1" name="name" type="String">
</argument>
<argument index="2" name="index" type="int">
</argument>
<return type="void" />
<argument index="0" name="type" type="int" enum="Variant.Type" />
<argument index="1" name="name" type="String" />
<argument index="2" name="index" type="int" />
<description>
Adds an input port to the Visual Script node.
</description>
</method>
<method name="add_output_data_port">
<return type="void">
</return>
<argument index="0" name="type" type="int" enum="Variant.Type">
</argument>
<argument index="1" name="name" type="String">
</argument>
<argument index="2" name="index" type="int">
</argument>
<return type="void" />
<argument index="0" name="type" type="int" enum="Variant.Type" />
<argument index="1" name="name" type="String" />
<argument index="2" name="index" type="int" />
<description>
Adds an output port to the Visual Script node.
</description>
</method>
<method name="remove_input_data_port">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
Removes an input port from the Visual Script node.
</description>
</method>
<method name="remove_output_data_port">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
Removes an output port from the Visual Script node.
</description>
</method>
<method name="set_input_data_port_name">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="name" type="String">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="name" type="String" />
<description>
Sets the name of an input port.
</description>
</method>
<method name="set_input_data_port_type">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="type" type="int" enum="Variant.Type">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="type" type="int" enum="Variant.Type" />
<description>
Sets the type of an input port.
</description>
</method>
<method name="set_output_data_port_name">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="name" type="String">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="name" type="String" />
<description>
Sets the name of an output port.
</description>
</method>
<method name="set_output_data_port_type">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="type" type="int" enum="Variant.Type">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="type" type="int" enum="Variant.Type" />
<description>
Sets the type of an output port.
</description>