summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-09-27 22:16:32 +0200
committerRémi Verschelde <rverschelde@gmail.com>2019-09-27 22:16:42 +0200
commitd0e45e78a48fc0cc61b118a51020eef202998242 (patch)
treef8a70a304e417bb4e3bf4dc9e3c8433afefb6bf0 /doc/classes
parent5966c6b646bb7e673c2ad66a76d3ef7e9873656b (diff)
doc: Sync classref with current source
And various fixes to bindings, hyperlinks and an uninitialized variable.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Crypto.xml2
-rw-r--r--doc/classes/CryptoKey.xml2
-rw-r--r--doc/classes/Font.xml2
-rw-r--r--doc/classes/Skeleton.xml19
-rw-r--r--doc/classes/TreeItem.xml4
-rw-r--r--doc/classes/X509Certificate.xml2
6 files changed, 26 insertions, 5 deletions
diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml
index 4ec405f96c..bce7895973 100644
--- a/doc/classes/Crypto.xml
+++ b/doc/classes/Crypto.xml
@@ -41,7 +41,7 @@
<argument index="0" name="size" type="int">
</argument>
<description>
- Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.acccept_stream].
+ Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream].
</description>
</method>
<method name="generate_self_signed_certificate">
diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml
index 6db6fea779..8c825c9e1c 100644
--- a/doc/classes/CryptoKey.xml
+++ b/doc/classes/CryptoKey.xml
@@ -5,7 +5,7 @@
</brief_description>
<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] and as private key in [method StreamPeerSSL.accept_stream] along with the appropriate certificate.
+ 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.
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml
index 6ec1545bc7..f7de79913c 100644
--- a/doc/classes/Font.xml
+++ b/doc/classes/Font.xml
@@ -82,7 +82,7 @@
</return>
<argument index="0" name="string" type="String">
</argument>
- <argument index="1" name="p_width" type="float">
+ <argument index="1" name="width" type="float">
</argument>
<description>
</description>
diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml
index 27a78cd7d1..7cd95390e6 100644
--- a/doc/classes/Skeleton.xml
+++ b/doc/classes/Skeleton.xml
@@ -54,6 +54,15 @@
Returns the amount of bones in the skeleton.
</description>
</method>
+ <method name="get_bone_custom_pose" qualifiers="const">
+ <return type="Transform">
+ </return>
+ <argument index="0" name="bone_idx" type="int">
+ </argument>
+ <description>
+ Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose.
+ </description>
+ </method>
<method name="get_bone_global_pose" qualifiers="const">
<return type="Transform">
</return>
@@ -161,6 +170,16 @@
<description>
</description>
</method>
+ <method name="set_bone_custom_pose">
+ <return type="void">
+ </return>
+ <argument index="0" name="bone_idx" type="int">
+ </argument>
+ <argument index="1" name="custom_pose" type="Transform">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="set_bone_disable_rest">
<return type="void">
</return>
diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml
index fe70c2fdac..1ab5c58a30 100644
--- a/doc/classes/TreeItem.xml
+++ b/doc/classes/TreeItem.xml
@@ -89,8 +89,10 @@
</return>
<argument index="0" name="column" type="int">
</argument>
+ <argument index="1" name="button_idx" type="int">
+ </argument>
<description>
- Returns the tooltip for the button in column [code]column[/code].
+ Returns the tooltip string for the button at index [code]button_idx[/code] in column [code]column[/code].
</description>
</method>
<method name="get_cell_mode" qualifiers="const">
diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml
index 8066f65391..50e9e4e0d4 100644
--- a/doc/classes/X509Certificate.xml
+++ b/doc/classes/X509Certificate.xml
@@ -5,7 +5,7 @@
</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 [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 [StreamPeerSSL.connect_to_stream].
+ 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].
</description>
<tutorials>
</tutorials>