diff options
| author | Yuri Sizov <yuris@humnom.net> | 2022-08-06 21:11:48 +0300 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2022-08-08 22:34:31 +0300 |
| commit | c5d7115038de5f83cb83e08748615a84fc26bee2 (patch) | |
| tree | 13b9b42aac25f7769428ef91f637e260b768f25d /doc/classes/StreamPeerSSL.xml | |
| parent | 35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff) | |
| download | redot-engine-c5d7115038de5f83cb83e08748615a84fc26bee2.tar.gz | |
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/StreamPeerSSL.xml')
| -rw-r--r-- | doc/classes/StreamPeerSSL.xml | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 70762cbf6c..dd571226b8 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -13,20 +13,20 @@ <methods> <method name="accept_stream"> <return type="int" enum="Error" /> - <argument index="0" name="stream" type="StreamPeer" /> - <argument index="1" name="private_key" type="CryptoKey" /> - <argument index="2" name="certificate" type="X509Certificate" /> - <argument index="3" name="chain" type="X509Certificate" default="null" /> + <param index="0" name="stream" type="StreamPeer" /> + <param index="1" name="private_key" type="CryptoKey" /> + <param index="2" name="certificate" type="X509Certificate" /> + <param index="3" name="chain" type="X509Certificate" default="null" /> <description> Accepts a peer connection as a server using the given [code]private_key[/code] and providing the given [code]certificate[/code] to the client. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. </description> </method> <method name="connect_to_stream"> <return type="int" enum="Error" /> - <argument index="0" name="stream" type="StreamPeer" /> - <argument index="1" name="validate_certs" type="bool" default="false" /> - <argument index="2" name="for_hostname" type="String" default="""" /> - <argument index="3" name="valid_certificate" type="X509Certificate" default="null" /> + <param index="0" name="stream" type="StreamPeer" /> + <param index="1" name="validate_certs" type="bool" default="false" /> + <param index="2" name="for_hostname" type="String" default="""" /> + <param index="3" name="valid_certificate" type="X509Certificate" default="null" /> <description> Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. [b]Note:[/b] Specifying a custom [code]valid_certificate[/code] is not supported in HTML5 exports due to browsers restrictions. |