godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 19:31:35 +00:00
Code 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 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
Download Patch File Download Diff File Expand all files Collapse all files

33
modules/upnp/doc_classes/UPNPDevice.xml
View File

@@ -10,43 +10,32 @@
</tutorials>
<methods>
<method name="add_port_mapping" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="port" type="int">
</argument>
<argument index="1" name="port_internal" type="int" default="0">
</argument>
<argument index="2" name="desc" type="String" default="&quot;&quot;">
</argument>
<argument index="3" name="proto" type="String" default="&quot;UDP&quot;">
</argument>
<argument index="4" name="duration" type="int" default="0">
</argument>
<return type="int" />
<argument index="0" name="port" type="int" />
<argument index="1" name="port_internal" type="int" default="0" />
<argument index="2" name="desc" type="String" default="&quot;&quot;" />
<argument index="3" name="proto" type="String" default="&quot;UDP&quot;" />
<argument index="4" name="duration" type="int" default="0" />
<description>
Adds a port mapping to forward the given external port on this [UPNPDevice] for the given protocol to the local machine. See [method UPNP.add_port_mapping].
</description>
</method>
<method name="delete_port_mapping" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="port" type="int">
</argument>
<argument index="1" name="proto" type="String" default="&quot;UDP&quot;">
</argument>
<return type="int" />
<argument index="0" name="port" type="int" />
<argument index="1" name="proto" type="String" default="&quot;UDP&quot;" />
<description>
Deletes the port mapping identified by the given port and protocol combination on this device. See [method UPNP.delete_port_mapping].
</description>
</method>
<method name="is_valid_gateway" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding.
</description>
</method>
<method name="query_external_address" qualifiers="const">
<return type="String">
</return>
<return type="String" />
<description>
Returns the external IP address of this [UPNPDevice] or an empty string.
</description>