summaryrefslogtreecommitdiffstats
path: root/modules/websocket/doc_classes/WebSocketPeer.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2023-04-26 21:36:04 +0200
committerYuri Sizov <yuris@humnom.net>2023-04-26 21:36:04 +0200
commit391eccca76ace6863e20b6a579ed1550ed33dedb (patch)
tree6ce45b4b00b105331518ba6d29fc8498631091a1 /modules/websocket/doc_classes/WebSocketPeer.xml
parente2e870c6118f6e9463c8907c947102f913f543de (diff)
downloadredot-engine-391eccca76ace6863e20b6a579ed1550ed33dedb.tar.gz
Validate code tags in documentation for potential params
Adds a check to make_rst to look for matches between the text inside of the [code][/code] tag and known param identifiers. Fixes most of what was revealed.
Diffstat (limited to 'modules/websocket/doc_classes/WebSocketPeer.xml')
-rw-r--r--modules/websocket/doc_classes/WebSocketPeer.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml
index 580adfd2d2..61f0be22f6 100644
--- a/modules/websocket/doc_classes/WebSocketPeer.xml
+++ b/modules/websocket/doc_classes/WebSocketPeer.xml
@@ -61,7 +61,7 @@
<param index="1" name="tls_client_options" type="TLSOptions" default="null" />
<description>
Connects to the given URL. TLS certificates will be verified against the hostname when connecting using the [code]wss://[/code] protocol. You can pass the optional [param tls_client_options] parameter to customize the trusted certification authorities, or disable the common name verification. See [method TLSOptions.client] and [method TLSOptions.client_unsafe].
- [b]Note:[/b] To avoid mixed content warnings or errors in Web, you may have to use a [code]url[/code] that starts with [code]wss://[/code] (secure) instead of [code]ws://[/code]. When doing so, make sure to use the fully qualified domain name that matches the one defined in the server's TLS certificate. Do not connect directly via the IP address for [code]wss://[/code] connections, as it won't match with the TLS certificate.
+ [b]Note:[/b] To avoid mixed content warnings or errors in Web, you may have to use a [param url] that starts with [code]wss://[/code] (secure) instead of [code]ws://[/code]. When doing so, make sure to use the fully qualified domain name that matches the one defined in the server's TLS certificate. Do not connect directly via the IP address for [code]wss://[/code] connections, as it won't match with the TLS certificate.
</description>
</method>
<method name="get_close_code" qualifiers="const">