f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
31 lines
1.2 KiB
XML
31 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="X509Certificate" inherits="Resource" version="3.4">
|
|
<brief_description>
|
|
An X509 certificate (e.g. for SSL).
|
|
</brief_description>
|
|
<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>
|
|
<methods>
|
|
<method name="load">
|
|
<return type="int" enum="Error" />
|
|
<argument index="0" name="path" type="String" />
|
|
<description>
|
|
Loads a certificate from [code]path[/code] ("*.crt" file).
|
|
</description>
|
|
</method>
|
|
<method name="save">
|
|
<return type="int" enum="Error" />
|
|
<argument index="0" name="path" type="String" />
|
|
<description>
|
|
Saves a certificate to the given [code]path[/code] (should be a "*.crt" file).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|