noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/HTTPRequest.xml
+18 -18
View File
@@ -187,11 +187,11 @@
</method>
<method name="request">
<return type="int" enum="Error" />
<argument index="0" name="url" type="String" />
<argument index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<argument index="2" name="ssl_validate_domain" type="bool" default="true" />
<argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0" />
<argument index="4" name="request_data" type="String" default="&quot;&quot;" />
<param index="0" name="url" type="String" />
<param index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<param index="2" name="ssl_validate_domain" type="bool" default="true" />
<param index="3" name="method" type="int" enum="HTTPClient.Method" default="0" />
<param index="4" name="request_data" type="String" default="&quot;&quot;" />
<description>
Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host.
@@ -201,11 +201,11 @@
</method>
<method name="request_raw">
<return type="int" enum="Error" />
<argument index="0" name="url" type="String" />
<argument index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<argument index="2" name="ssl_validate_domain" type="bool" default="true" />
<argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0" />
<argument index="4" name="request_data_raw" type="PackedByteArray" default="PackedByteArray()" />
<param index="0" name="url" type="String" />
<param index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<param index="2" name="ssl_validate_domain" type="bool" default="true" />
<param index="3" name="method" type="int" enum="HTTPClient.Method" default="0" />
<param index="4" name="request_data_raw" type="PackedByteArray" default="PackedByteArray()" />
<description>
Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host.
@@ -213,8 +213,8 @@
</method>
<method name="set_http_proxy">
<return type="void" />
<argument index="0" name="host" type="String" />
<argument index="1" name="port" type="int" />
<param index="0" name="host" type="String" />
<param index="1" name="port" type="int" />
<description>
Sets the proxy server for HTTP requests.
The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1.
@@ -222,8 +222,8 @@
</method>
<method name="set_https_proxy">
<return type="void" />
<argument index="0" name="host" type="String" />
<argument index="1" name="port" type="int" />
<param index="0" name="host" type="String" />
<param index="1" name="port" type="int" />
<description>
Sets the proxy server for HTTPS requests.
The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1.
@@ -259,10 +259,10 @@
</members>
<signals>
<signal name="request_completed">
<argument index="0" name="result" type="int" />
<argument index="1" name="response_code" type="int" />
<argument index="2" name="headers" type="PackedStringArray" />
<argument index="3" name="body" type="PackedByteArray" />
<param index="0" name="result" type="int" />
<param index="1" name="response_code" type="int" />
<param index="2" name="headers" type="PackedStringArray" />
<param index="3" name="body" type="PackedByteArray" />
<description>
Emitted when a request is completed.
</description>