diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-14 17:23:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-14 17:23:54 +0100 |
| commit | 1bafd2d2c8824570310e63686cfad42a879452a6 (patch) | |
| tree | e938f91692657b10df67d1528ca7bc2d3a4f470e /doc/classes | |
| parent | dc0f43a1c2218990d36add82be1feb2dacaa5796 (diff) | |
| parent | aa744aee7dac7d421fa0d338e769e3619146512c (diff) | |
Merge pull request #35120 from Faless/docs/html5_restrictions
Update documentation to reflect HTML5 limitations.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Crypto.xml | 1 | ||||
| -rw-r--r-- | doc/classes/CryptoKey.xml | 1 | ||||
| -rw-r--r-- | doc/classes/HashingContext.xml | 1 | ||||
| -rw-r--r-- | doc/classes/StreamPeerSSL.xml | 1 | ||||
| -rw-r--r-- | doc/classes/X509Certificate.xml | 1 |
5 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index bce7895973..bb2c443618 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -22,6 +22,7 @@ key.save("user://generated.key") cert.save("user://generated.crt") [/codeblock] + [b]Note:[/b] Not available in HTML5 exports. </description> <tutorials> </tutorials> diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index 8c825c9e1c..8feb7d4809 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -6,6 +6,7 @@ <description> The CryptoKey class represents a cryptographic key. Keys can be loaded and saved like any other [Resource]. They can be used to generate a self-signed [X509Certificate] via [method Crypto.generate_self_signed_certificate] and as private key in [method StreamPeerSSL.accept_stream] along with the appropriate certificate. + [b]Note:[/b] Not available in HTML5 exports. </description> <tutorials> </tutorials> diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml index 802b186ef3..8a20eb99b8 100644 --- a/doc/classes/HashingContext.xml +++ b/doc/classes/HashingContext.xml @@ -27,6 +27,7 @@ # Print the result as hex string and array. printt(res.hex_encode(), Array(res)) [/codeblock] + [b]Note:[/b] Not available in HTML5 exports. </description> <tutorials> </tutorials> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index b34d8d1b25..eea44ef93d 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -38,6 +38,7 @@ </argument> <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. </description> </method> <method name="disconnect_from_stream"> diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml index 50e9e4e0d4..5f3e91c4e6 100644 --- a/doc/classes/X509Certificate.xml +++ b/doc/classes/X509Certificate.xml @@ -6,6 +6,7 @@ <description> The X509Certificate class represents an X509 certificate. Certificates can be loaded and saved like any other [Resource]. They can be used as the server certificate in [method StreamPeerSSL.accept_stream] (along with the proper [CryptoKey]), and to specify the only certificate that should be accepted when connecting to an SSL server via [method StreamPeerSSL.connect_to_stream]. + [b]Note:[/b] Not available in HTML5 exports. </description> <tutorials> </tutorials> |