summaryrefslogtreecommitdiff
path: root/modules/upnp
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2022-08-06 21:11:48 +0300
committerYuri Sizov <yuris@humnom.net>2022-08-08 22:34:31 +0300
commitc5d7115038de5f83cb83e08748615a84fc26bee2 (patch)
tree13b9b42aac25f7769428ef91f637e260b768f25d /modules/upnp
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'modules/upnp')
-rw-r--r--modules/upnp/doc_classes/UPNP.xml30
-rw-r--r--modules/upnp/doc_classes/UPNPDevice.xml14
2 files changed, 22 insertions, 22 deletions
diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml
index 066506922c..847110abd4 100644
--- a/modules/upnp/doc_classes/UPNP.xml
+++ b/modules/upnp/doc_classes/UPNP.xml
@@ -54,18 +54,18 @@
<methods>
<method name="add_device">
<return type="void" />
- <argument index="0" name="device" type="UPNPDevice" />
+ <param index="0" name="device" type="UPNPDevice" />
<description>
Adds the given [UPNPDevice] to the list of discovered devices.
</description>
</method>
<method name="add_port_mapping" qualifiers="const">
<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" />
+ <param index="0" name="port" type="int" />
+ <param index="1" name="port_internal" type="int" default="0" />
+ <param index="2" name="desc" type="String" default="&quot;&quot;" />
+ <param index="3" name="proto" type="String" default="&quot;UDP&quot;" />
+ <param index="4" name="duration" type="int" default="0" />
<description>
Adds a mapping to forward the external [code]port[/code] (between 1 and 65535) on the default gateway (see [method get_gateway]) to the [code]internal_port[/code] on the local machine for the given protocol [code]proto[/code] (either [code]TCP[/code] or [code]UDP[/code], with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with [method get_gateway] and call [method add_port_mapping] on it, if any.
If [code]internal_port[/code] is [code]0[/code] (the default), the same port number is used for both the external and the internal port (the [code]port[/code] value).
@@ -81,17 +81,17 @@
</method>
<method name="delete_port_mapping" qualifiers="const">
<return type="int" />
- <argument index="0" name="port" type="int" />
- <argument index="1" name="proto" type="String" default="&quot;UDP&quot;" />
+ <param index="0" name="port" type="int" />
+ <param index="1" name="proto" type="String" default="&quot;UDP&quot;" />
<description>
Deletes the port mapping for the given port and protocol combination on the default gateway (see [method get_gateway]) if one exists. [code]port[/code] must be a valid port between 1 and 65535, [code]proto[/code] can be either [code]TCP[/code] or [code]UDP[/code]. See [enum UPNPResult] for possible return values.
</description>
</method>
<method name="discover">
<return type="int" />
- <argument index="0" name="timeout" type="int" default="2000" />
- <argument index="1" name="ttl" type="int" default="2" />
- <argument index="2" name="device_filter" type="String" default="&quot;InternetGatewayDevice&quot;" />
+ <param index="0" name="timeout" type="int" default="2000" />
+ <param index="1" name="ttl" type="int" default="2" />
+ <param index="2" name="device_filter" type="String" default="&quot;InternetGatewayDevice&quot;" />
<description>
Discovers local [UPNPDevice]s. Clears the list of previously discovered devices.
Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. [code]timeout[/code] is the time to wait for responses in milliseconds. [code]ttl[/code] is the time-to-live; only touch this if you know what you're doing.
@@ -100,7 +100,7 @@
</method>
<method name="get_device" qualifiers="const">
<return type="UPNPDevice" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Returns the [UPNPDevice] at the given [code]index[/code].
</description>
@@ -125,15 +125,15 @@
</method>
<method name="remove_device">
<return type="void" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Removes the device at [code]index[/code] from the list of discovered devices.
</description>
</method>
<method name="set_device">
<return type="void" />
- <argument index="0" name="index" type="int" />
- <argument index="1" name="device" type="UPNPDevice" />
+ <param index="0" name="index" type="int" />
+ <param index="1" name="device" type="UPNPDevice" />
<description>
Sets the device at [code]index[/code] from the list of discovered devices to [code]device[/code].
</description>
diff --git a/modules/upnp/doc_classes/UPNPDevice.xml b/modules/upnp/doc_classes/UPNPDevice.xml
index 7749ac18ab..b599acaba2 100644
--- a/modules/upnp/doc_classes/UPNPDevice.xml
+++ b/modules/upnp/doc_classes/UPNPDevice.xml
@@ -11,19 +11,19 @@
<methods>
<method name="add_port_mapping" qualifiers="const">
<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" />
+ <param index="0" name="port" type="int" />
+ <param index="1" name="port_internal" type="int" default="0" />
+ <param index="2" name="desc" type="String" default="&quot;&quot;" />
+ <param index="3" name="proto" type="String" default="&quot;UDP&quot;" />
+ <param 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" />
- <argument index="0" name="port" type="int" />
- <argument index="1" name="proto" type="String" default="&quot;UDP&quot;" />
+ <param index="0" name="port" type="int" />
+ <param 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>