diff options
Diffstat (limited to 'doc/classes/StreamPeerSSL.xml')
| -rw-r--r-- | doc/classes/StreamPeerSSL.xml | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 70762cbf6c..7fe9c54e3e 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -13,23 +13,23 @@ <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. + Accepts a peer connection as a server using the given [param private_key] and providing the given [param certificate] to the client. You can pass the optional [param chain] 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. + Connects to a peer using an underlying [StreamPeer] [param stream]. If [param validate_certs] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [param for_hostname]. + [b]Note:[/b] Specifying a custom [param valid_certificate] is not supported in HTML5 exports due to browsers restrictions. </description> </method> <method name="disconnect_from_stream"> |