diff options
| author | Andy Maloney <asmaloney@gmail.com> | 2022-08-09 22:00:19 -0400 |
|---|---|---|
| committer | Andy Maloney <asmaloney@gmail.com> | 2022-08-09 22:00:19 -0400 |
| commit | 1f72f48361e8a67a9473c99a27565fa6133c4b50 (patch) | |
| tree | 95c08a4d20786f1227a05867847bccd564bf049c /doc/classes/StreamPeerSSL.xml | |
| parent | 317ced8204d80367c445963fc989de320c6f9a68 (diff) | |
| download | redot-engine-1f72f48361e8a67a9473c99a27565fa6133c4b50.tar.gz | |
[doc] Use "param" instead of "code" to refer to parameters #3
Diffstat (limited to 'doc/classes/StreamPeerSSL.xml')
| -rw-r--r-- | doc/classes/StreamPeerSSL.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index dd571226b8..7fe9c54e3e 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -18,7 +18,7 @@ <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"> @@ -28,8 +28,8 @@ <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"> |