diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-07-30 16:42:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-30 16:42:52 +0200 |
| commit | 83ccf39adcefaa32325d607562f8f0889c215046 (patch) | |
| tree | 61ea8e8a202e2998e745de04516a9a2f34c9be1b /doc/classes/DTLSServer.xml | |
| parent | a7363f3dfd32ecff77d4d6937be9f232bfc699c7 (diff) | |
| parent | 7adf4cc9b5de6701a41e27690a69b9892d5eed85 (diff) | |
Merge pull request #51067 from akien-mga/doc-return-argument-self-closing-tags
doc: Use self-closing tags for `return` and `argument`
Diffstat (limited to 'doc/classes/DTLSServer.xml')
| -rw-r--r-- | doc/classes/DTLSServer.xml | 18 |
1 files changed, 6 insertions, 12 deletions
diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index 28d68d309f..627a7a65a5 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -147,23 +147,17 @@ </tutorials> <methods> <method name="setup"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="key" type="CryptoKey"> - </argument> - <argument index="1" name="certificate" type="X509Certificate"> - </argument> - <argument index="2" name="chain" type="X509Certificate" default="null"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="key" type="CryptoKey" /> + <argument index="1" name="certificate" type="X509Certificate" /> + <argument index="2" name="chain" type="X509Certificate" default="null" /> <description> Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. </description> </method> <method name="take_connection"> - <return type="PacketPeerDTLS"> - </return> - <argument index="0" name="udp_peer" type="PacketPeerUDP"> - </argument> + <return type="PacketPeerDTLS" /> + <argument index="0" name="udp_peer" type="PacketPeerUDP" /> <description> Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]). [b]Note[/b]: You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. |